com.aliyun.ros.cdk.fc.ServiceProps Maven / Gradle / Ivy
package com.aliyun.ros.cdk.fc;
/**
* Properties for defining a Service.
*
* See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-fc-service
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-12-13T06:45:13.502Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.fc.$Module.class, fqn = "@alicloud/ros-cdk-fc.ServiceProps")
@software.amazon.jsii.Jsii.Proxy(ServiceProps.Jsii$Proxy.class)
public interface ServiceProps extends software.amazon.jsii.JsiiSerializable {
/**
* Property serviceName: Service name.
*/
@org.jetbrains.annotations.NotNull java.lang.Object getServiceName();
/**
* Property deletionForce: Whether force delete the service without waiting for network interfaces to be cleaned up if VpcConfig is specified.
*
* Default value is false.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getDeletionForce() {
return null;
}
/**
* Property description: Service description.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getDescription() {
return null;
}
/**
* Property internetAccess: Set it to true to enable Internet access.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getInternetAccess() {
return null;
}
/**
* Property logConfig: Log configuration.
*
* Function Compute pushes function execution logs to the configured log store.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getLogConfig() {
return null;
}
/**
* Property nasConfig: NAS configuration.
*
* Function Compute uses a specified NAS configured on the service.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getNasConfig() {
return null;
}
/**
* Property ossMountConfig: The OSS mount configurations.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getOssMountConfig() {
return null;
}
/**
* Property role: The role grants Function Compute the permission to access user’s cloud resources, such as pushing logs to user’s log store.
*
* The temporary STS token generated from this role can be retrieved from function context and used to access cloud resources.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getRole() {
return null;
}
/**
* Property tags: Tags to attach to service.
*
* Max support 20 tags to add during create service. Each tag with two properties Key and Value, and Key is required.
*/
default @org.jetbrains.annotations.Nullable java.util.List getTags() {
return null;
}
/**
* Property tracingConfig: The Tracing Analysis configuration.
*
* After Function Compute integrates with Tracing Analysis, you can record the stay time of a request in Function Compute, view the cold start time for a function, and record the execution time of a function.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getTracingConfig() {
return null;
}
/**
* Property vpcBindings: Function Invocation only by Specified VPCs.
*
* By default, you can invoke the function by using the Internet endpoint and internal endpoint after a function is created. If you want the function to be invoked only by using specified VPCs, but not the Internet endpoint or internal endpoint, you must bind the specified VPCs to the service.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getVpcBindings() {
return null;
}
/**
* Property vpcConfig: VPC configuration.
*
* Function Compute uses the config to setup ENI in the specific VPC.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getVpcConfig() {
return null;
}
/**
* @return a {@link Builder} of {@link ServiceProps}
*/
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link ServiceProps}
*/
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Object serviceName;
java.lang.Object deletionForce;
java.lang.Object description;
java.lang.Object internetAccess;
java.lang.Object logConfig;
java.lang.Object nasConfig;
java.lang.Object ossMountConfig;
java.lang.Object role;
java.util.List tags;
java.lang.Object tracingConfig;
java.lang.Object vpcBindings;
java.lang.Object vpcConfig;
/**
* Sets the value of {@link ServiceProps#getServiceName}
* @param serviceName Property serviceName: Service name. This parameter is required.
* @return {@code this}
*/
public Builder serviceName(java.lang.String serviceName) {
this.serviceName = serviceName;
return this;
}
/**
* Sets the value of {@link ServiceProps#getServiceName}
* @param serviceName Property serviceName: Service name. This parameter is required.
* @return {@code this}
*/
public Builder serviceName(com.aliyun.ros.cdk.core.IResolvable serviceName) {
this.serviceName = serviceName;
return this;
}
/**
* Sets the value of {@link ServiceProps#getDeletionForce}
* @param deletionForce Property deletionForce: Whether force delete the service without waiting for network interfaces to be cleaned up if VpcConfig is specified.
* Default value is false.
* @return {@code this}
*/
public Builder deletionForce(java.lang.Boolean deletionForce) {
this.deletionForce = deletionForce;
return this;
}
/**
* Sets the value of {@link ServiceProps#getDeletionForce}
* @param deletionForce Property deletionForce: Whether force delete the service without waiting for network interfaces to be cleaned up if VpcConfig is specified.
* Default value is false.
* @return {@code this}
*/
public Builder deletionForce(com.aliyun.ros.cdk.core.IResolvable deletionForce) {
this.deletionForce = deletionForce;
return this;
}
/**
* Sets the value of {@link ServiceProps#getDescription}
* @param description Property description: Service description.
* @return {@code this}
*/
public Builder description(java.lang.String description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link ServiceProps#getDescription}
* @param description Property description: Service description.
* @return {@code this}
*/
public Builder description(com.aliyun.ros.cdk.core.IResolvable description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link ServiceProps#getInternetAccess}
* @param internetAccess Property internetAccess: Set it to true to enable Internet access.
* @return {@code this}
*/
public Builder internetAccess(java.lang.Boolean internetAccess) {
this.internetAccess = internetAccess;
return this;
}
/**
* Sets the value of {@link ServiceProps#getInternetAccess}
* @param internetAccess Property internetAccess: Set it to true to enable Internet access.
* @return {@code this}
*/
public Builder internetAccess(com.aliyun.ros.cdk.core.IResolvable internetAccess) {
this.internetAccess = internetAccess;
return this;
}
/**
* Sets the value of {@link ServiceProps#getLogConfig}
* @param logConfig Property logConfig: Log configuration.
* Function Compute pushes function execution logs to the configured log store.
* @return {@code this}
*/
public Builder logConfig(com.aliyun.ros.cdk.core.IResolvable logConfig) {
this.logConfig = logConfig;
return this;
}
/**
* Sets the value of {@link ServiceProps#getLogConfig}
* @param logConfig Property logConfig: Log configuration.
* Function Compute pushes function execution logs to the configured log store.
* @return {@code this}
*/
public Builder logConfig(com.aliyun.ros.cdk.fc.RosService.LogConfigProperty logConfig) {
this.logConfig = logConfig;
return this;
}
/**
* Sets the value of {@link ServiceProps#getNasConfig}
* @param nasConfig Property nasConfig: NAS configuration.
* Function Compute uses a specified NAS configured on the service.
* @return {@code this}
*/
public Builder nasConfig(com.aliyun.ros.cdk.core.IResolvable nasConfig) {
this.nasConfig = nasConfig;
return this;
}
/**
* Sets the value of {@link ServiceProps#getNasConfig}
* @param nasConfig Property nasConfig: NAS configuration.
* Function Compute uses a specified NAS configured on the service.
* @return {@code this}
*/
public Builder nasConfig(com.aliyun.ros.cdk.fc.RosService.NasConfigProperty nasConfig) {
this.nasConfig = nasConfig;
return this;
}
/**
* Sets the value of {@link ServiceProps#getOssMountConfig}
* @param ossMountConfig Property ossMountConfig: The OSS mount configurations.
* @return {@code this}
*/
public Builder ossMountConfig(com.aliyun.ros.cdk.core.IResolvable ossMountConfig) {
this.ossMountConfig = ossMountConfig;
return this;
}
/**
* Sets the value of {@link ServiceProps#getOssMountConfig}
* @param ossMountConfig Property ossMountConfig: The OSS mount configurations.
* @return {@code this}
*/
public Builder ossMountConfig(com.aliyun.ros.cdk.fc.RosService.OssMountConfigProperty ossMountConfig) {
this.ossMountConfig = ossMountConfig;
return this;
}
/**
* Sets the value of {@link ServiceProps#getRole}
* @param role Property role: The role grants Function Compute the permission to access user’s cloud resources, such as pushing logs to user’s log store.
* The temporary STS token generated from this role can be retrieved from function context and used to access cloud resources.
* @return {@code this}
*/
public Builder role(java.lang.String role) {
this.role = role;
return this;
}
/**
* Sets the value of {@link ServiceProps#getRole}
* @param role Property role: The role grants Function Compute the permission to access user’s cloud resources, such as pushing logs to user’s log store.
* The temporary STS token generated from this role can be retrieved from function context and used to access cloud resources.
* @return {@code this}
*/
public Builder role(com.aliyun.ros.cdk.core.IResolvable role) {
this.role = role;
return this;
}
/**
* Sets the value of {@link ServiceProps#getTags}
* @param tags Property tags: Tags to attach to service.
* Max support 20 tags to add during create service. Each tag with two properties Key and Value, and Key is required.
* @return {@code this}
*/
@SuppressWarnings("unchecked")
public Builder tags(java.util.List tags) {
this.tags = (java.util.List)tags;
return this;
}
/**
* Sets the value of {@link ServiceProps#getTracingConfig}
* @param tracingConfig Property tracingConfig: The Tracing Analysis configuration.
* After Function Compute integrates with Tracing Analysis, you can record the stay time of a request in Function Compute, view the cold start time for a function, and record the execution time of a function.
* @return {@code this}
*/
public Builder tracingConfig(com.aliyun.ros.cdk.core.IResolvable tracingConfig) {
this.tracingConfig = tracingConfig;
return this;
}
/**
* Sets the value of {@link ServiceProps#getTracingConfig}
* @param tracingConfig Property tracingConfig: The Tracing Analysis configuration.
* After Function Compute integrates with Tracing Analysis, you can record the stay time of a request in Function Compute, view the cold start time for a function, and record the execution time of a function.
* @return {@code this}
*/
public Builder tracingConfig(com.aliyun.ros.cdk.fc.RosService.TracingConfigProperty tracingConfig) {
this.tracingConfig = tracingConfig;
return this;
}
/**
* Sets the value of {@link ServiceProps#getVpcBindings}
* @param vpcBindings Property vpcBindings: Function Invocation only by Specified VPCs.
* By default, you can invoke the function by using the Internet endpoint and internal endpoint after a function is created. If you want the function to be invoked only by using specified VPCs, but not the Internet endpoint or internal endpoint, you must bind the specified VPCs to the service.
* @return {@code this}
*/
public Builder vpcBindings(com.aliyun.ros.cdk.core.IResolvable vpcBindings) {
this.vpcBindings = vpcBindings;
return this;
}
/**
* Sets the value of {@link ServiceProps#getVpcBindings}
* @param vpcBindings Property vpcBindings: Function Invocation only by Specified VPCs.
* By default, you can invoke the function by using the Internet endpoint and internal endpoint after a function is created. If you want the function to be invoked only by using specified VPCs, but not the Internet endpoint or internal endpoint, you must bind the specified VPCs to the service.
* @return {@code this}
*/
public Builder vpcBindings(java.util.List vpcBindings) {
this.vpcBindings = vpcBindings;
return this;
}
/**
* Sets the value of {@link ServiceProps#getVpcConfig}
* @param vpcConfig Property vpcConfig: VPC configuration.
* Function Compute uses the config to setup ENI in the specific VPC.
* @return {@code this}
*/
public Builder vpcConfig(com.aliyun.ros.cdk.core.IResolvable vpcConfig) {
this.vpcConfig = vpcConfig;
return this;
}
/**
* Sets the value of {@link ServiceProps#getVpcConfig}
* @param vpcConfig Property vpcConfig: VPC configuration.
* Function Compute uses the config to setup ENI in the specific VPC.
* @return {@code this}
*/
public Builder vpcConfig(com.aliyun.ros.cdk.fc.RosService.VpcConfigProperty vpcConfig) {
this.vpcConfig = vpcConfig;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link ServiceProps}
* @throws NullPointerException if any required attribute was not provided
*/
@Override
public ServiceProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link ServiceProps}
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ServiceProps {
private final java.lang.Object serviceName;
private final java.lang.Object deletionForce;
private final java.lang.Object description;
private final java.lang.Object internetAccess;
private final java.lang.Object logConfig;
private final java.lang.Object nasConfig;
private final java.lang.Object ossMountConfig;
private final java.lang.Object role;
private final java.util.List tags;
private final java.lang.Object tracingConfig;
private final java.lang.Object vpcBindings;
private final java.lang.Object vpcConfig;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.serviceName = software.amazon.jsii.Kernel.get(this, "serviceName", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.deletionForce = software.amazon.jsii.Kernel.get(this, "deletionForce", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.description = software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.internetAccess = software.amazon.jsii.Kernel.get(this, "internetAccess", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.logConfig = software.amazon.jsii.Kernel.get(this, "logConfig", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.nasConfig = software.amazon.jsii.Kernel.get(this, "nasConfig", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.ossMountConfig = software.amazon.jsii.Kernel.get(this, "ossMountConfig", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.role = software.amazon.jsii.Kernel.get(this, "role", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.tags = software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.fc.RosService.TagsProperty.class)));
this.tracingConfig = software.amazon.jsii.Kernel.get(this, "tracingConfig", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.vpcBindings = software.amazon.jsii.Kernel.get(this, "vpcBindings", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.vpcConfig = software.amazon.jsii.Kernel.get(this, "vpcConfig", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.serviceName = java.util.Objects.requireNonNull(builder.serviceName, "serviceName is required");
this.deletionForce = builder.deletionForce;
this.description = builder.description;
this.internetAccess = builder.internetAccess;
this.logConfig = builder.logConfig;
this.nasConfig = builder.nasConfig;
this.ossMountConfig = builder.ossMountConfig;
this.role = builder.role;
this.tags = (java.util.List)builder.tags;
this.tracingConfig = builder.tracingConfig;
this.vpcBindings = builder.vpcBindings;
this.vpcConfig = builder.vpcConfig;
}
@Override
public final java.lang.Object getServiceName() {
return this.serviceName;
}
@Override
public final java.lang.Object getDeletionForce() {
return this.deletionForce;
}
@Override
public final java.lang.Object getDescription() {
return this.description;
}
@Override
public final java.lang.Object getInternetAccess() {
return this.internetAccess;
}
@Override
public final java.lang.Object getLogConfig() {
return this.logConfig;
}
@Override
public final java.lang.Object getNasConfig() {
return this.nasConfig;
}
@Override
public final java.lang.Object getOssMountConfig() {
return this.ossMountConfig;
}
@Override
public final java.lang.Object getRole() {
return this.role;
}
@Override
public final java.util.List getTags() {
return this.tags;
}
@Override
public final java.lang.Object getTracingConfig() {
return this.tracingConfig;
}
@Override
public final java.lang.Object getVpcBindings() {
return this.vpcBindings;
}
@Override
public final java.lang.Object getVpcConfig() {
return this.vpcConfig;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("serviceName", om.valueToTree(this.getServiceName()));
if (this.getDeletionForce() != null) {
data.set("deletionForce", om.valueToTree(this.getDeletionForce()));
}
if (this.getDescription() != null) {
data.set("description", om.valueToTree(this.getDescription()));
}
if (this.getInternetAccess() != null) {
data.set("internetAccess", om.valueToTree(this.getInternetAccess()));
}
if (this.getLogConfig() != null) {
data.set("logConfig", om.valueToTree(this.getLogConfig()));
}
if (this.getNasConfig() != null) {
data.set("nasConfig", om.valueToTree(this.getNasConfig()));
}
if (this.getOssMountConfig() != null) {
data.set("ossMountConfig", om.valueToTree(this.getOssMountConfig()));
}
if (this.getRole() != null) {
data.set("role", om.valueToTree(this.getRole()));
}
if (this.getTags() != null) {
data.set("tags", om.valueToTree(this.getTags()));
}
if (this.getTracingConfig() != null) {
data.set("tracingConfig", om.valueToTree(this.getTracingConfig()));
}
if (this.getVpcBindings() != null) {
data.set("vpcBindings", om.valueToTree(this.getVpcBindings()));
}
if (this.getVpcConfig() != null) {
data.set("vpcConfig", om.valueToTree(this.getVpcConfig()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@alicloud/ros-cdk-fc.ServiceProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
ServiceProps.Jsii$Proxy that = (ServiceProps.Jsii$Proxy) o;
if (!serviceName.equals(that.serviceName)) return false;
if (this.deletionForce != null ? !this.deletionForce.equals(that.deletionForce) : that.deletionForce != null) return false;
if (this.description != null ? !this.description.equals(that.description) : that.description != null) return false;
if (this.internetAccess != null ? !this.internetAccess.equals(that.internetAccess) : that.internetAccess != null) return false;
if (this.logConfig != null ? !this.logConfig.equals(that.logConfig) : that.logConfig != null) return false;
if (this.nasConfig != null ? !this.nasConfig.equals(that.nasConfig) : that.nasConfig != null) return false;
if (this.ossMountConfig != null ? !this.ossMountConfig.equals(that.ossMountConfig) : that.ossMountConfig != null) return false;
if (this.role != null ? !this.role.equals(that.role) : that.role != null) return false;
if (this.tags != null ? !this.tags.equals(that.tags) : that.tags != null) return false;
if (this.tracingConfig != null ? !this.tracingConfig.equals(that.tracingConfig) : that.tracingConfig != null) return false;
if (this.vpcBindings != null ? !this.vpcBindings.equals(that.vpcBindings) : that.vpcBindings != null) return false;
return this.vpcConfig != null ? this.vpcConfig.equals(that.vpcConfig) : that.vpcConfig == null;
}
@Override
public final int hashCode() {
int result = this.serviceName.hashCode();
result = 31 * result + (this.deletionForce != null ? this.deletionForce.hashCode() : 0);
result = 31 * result + (this.description != null ? this.description.hashCode() : 0);
result = 31 * result + (this.internetAccess != null ? this.internetAccess.hashCode() : 0);
result = 31 * result + (this.logConfig != null ? this.logConfig.hashCode() : 0);
result = 31 * result + (this.nasConfig != null ? this.nasConfig.hashCode() : 0);
result = 31 * result + (this.ossMountConfig != null ? this.ossMountConfig.hashCode() : 0);
result = 31 * result + (this.role != null ? this.role.hashCode() : 0);
result = 31 * result + (this.tags != null ? this.tags.hashCode() : 0);
result = 31 * result + (this.tracingConfig != null ? this.tracingConfig.hashCode() : 0);
result = 31 * result + (this.vpcBindings != null ? this.vpcBindings.hashCode() : 0);
result = 31 * result + (this.vpcConfig != null ? this.vpcConfig.hashCode() : 0);
return result;
}
}
}