Class ServiceConfig (2.47.0)

publicfinalclass ServiceConfigextendsGeneratedMessageV3implementsServiceConfigOrBuilder

Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).

Protobuf type google.cloud.functions.v2alpha.ServiceConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ServiceConfig

Implements

ServiceConfigOrBuilder

Inherited Members

publicstaticfinalintALL_TRAFFIC_ON_LATEST_REVISION_FIELD_NUMBER

publicstaticfinalintAVAILABLE_CPU_FIELD_NUMBER

publicstaticfinalintAVAILABLE_MEMORY_FIELD_NUMBER

publicstaticfinalintENVIRONMENT_VARIABLES_FIELD_NUMBER

publicstaticfinalintINGRESS_SETTINGS_FIELD_NUMBER

publicstaticfinalintMAX_INSTANCE_COUNT_FIELD_NUMBER

publicstaticfinalintMAX_INSTANCE_REQUEST_CONCURRENCY_FIELD_NUMBER

publicstaticfinalintMIN_INSTANCE_COUNT_FIELD_NUMBER

publicstaticfinalintREVISION_FIELD_NUMBER

publicstaticfinalintSECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBER

publicstaticfinalintSECRET_VOLUMES_FIELD_NUMBER

publicstaticfinalintSECURITY_LEVEL_FIELD_NUMBER

publicstaticfinalintSERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

publicstaticfinalintSERVICE_FIELD_NUMBER

publicstaticfinalintTIMEOUT_SECONDS_FIELD_NUMBER

publicstaticfinalintURI_FIELD_NUMBER

publicstaticfinalintVPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBER

publicstaticfinalintVPC_CONNECTOR_FIELD_NUMBER

publicstaticServiceConfiggetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticServiceConfig.BuildernewBuilder()

publicstaticServiceConfig.BuildernewBuilder(ServiceConfigprototype)

publicstaticServiceConfigparseDelimitedFrom(InputStreaminput)

publicstaticServiceConfigparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticServiceConfigparseFrom(byte[]data)

publicstaticServiceConfigparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticServiceConfigparseFrom(ByteStringdata)

publicstaticServiceConfigparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticServiceConfigparseFrom(CodedInputStreaminput)

publicstaticServiceConfigparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticServiceConfigparseFrom(InputStreaminput)

publicstaticServiceConfigparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticServiceConfigparseFrom(ByteBufferdata)

publicstaticServiceConfigparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<ServiceConfig>parser()

publicbooleancontainsEnvironmentVariables(Stringkey)

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 4;

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicbooleangetAllTrafficOnLatestRevision()

Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic.

bool all_traffic_on_latest_revision = 16;

publicStringgetAvailableCpu()

[Preview] The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU

string available_cpu = 22;

publicByteStringgetAvailableCpuBytes()

[Preview] The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU

string available_cpu = 22;

publicStringgetAvailableMemory()

The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.

string available_memory = 13;

publicByteStringgetAvailableMemoryBytes()

The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.

string available_memory = 13;

publicServiceConfiggetDefaultInstanceForType()

publicMap<String,String>getEnvironmentVariables()

Use #getEnvironmentVariablesMap() instead.

publicintgetEnvironmentVariablesCount()

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 4;

publicMap<String,String>getEnvironmentVariablesMap()

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 4;

publicStringgetEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 4;

publicStringgetEnvironmentVariablesOrThrow(Stringkey)

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 4;

publicServiceConfig.IngressSettingsgetIngressSettings()

The ingress settings for the function, controlling what traffic can reach it.

.google.cloud.functions.v2alpha.ServiceConfig.IngressSettings ingress_settings = 8;

publicintgetIngressSettingsValue()

The ingress settings for the function, controlling what traffic can reach it.

.google.cloud.functions.v2alpha.ServiceConfig.IngressSettings ingress_settings = 8;

publicintgetMaxInstanceCount()

The limit on the maximum number of function instances that may coexist at a given time.

In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate.

See the Max Instances Guide for more details.

int32 max_instance_count = 5;

publicintgetMaxInstanceRequestConcurrency()

[Preview] Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.

int32 max_instance_request_concurrency = 20;

publicintgetMinInstanceCount()

The limit on the minimum number of function instances that may coexist at a given time.

Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.

int32 min_instance_count = 12;

publicParser<ServiceConfig>getParserForType()

GeneratedMessageV3.getParserForType()

publicStringgetRevision()

Output only. The name of service revision.

string revision = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicByteStringgetRevisionBytes()

Output only. The name of service revision.

string revision = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicSecretEnvVargetSecretEnvironmentVariables(intindex)

Secret environment variables configuration.

repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;

publicintgetSecretEnvironmentVariablesCount()

Secret environment variables configuration.

repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;

publicList<SecretEnvVar>getSecretEnvironmentVariablesList()

Secret environment variables configuration.

repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;

publicSecretEnvVarOrBuildergetSecretEnvironmentVariablesOrBuilder(intindex)

Secret environment variables configuration.

repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;

publicList<?extendsSecretEnvVarOrBuilder>getSecretEnvironmentVariablesOrBuilderList()

Secret environment variables configuration.

repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;

publicSecretVolumegetSecretVolumes(intindex)

Secret volumes configuration.

repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;

publicintgetSecretVolumesCount()

Secret volumes configuration.

repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;

publicList<SecretVolume>getSecretVolumesList()

Secret volumes configuration.

repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;

publicSecretVolumeOrBuildergetSecretVolumesOrBuilder(intindex)

Secret volumes configuration.

repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;

publicList<?extendsSecretVolumeOrBuilder>getSecretVolumesOrBuilderList()

Secret volumes configuration.

repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;

publicServiceConfig.SecurityLevelgetSecurityLevel()

Security level configure whether the function only accepts https. This configuration is only applicable to 1st Gen functions with Http trigger. By default https is optional for 1st Gen functions; 2nd Gen functions are https ONLY.

.google.cloud.functions.v2alpha.ServiceConfig.SecurityLevel security_level = 21;

publicintgetSecurityLevelValue()

Security level configure whether the function only accepts https. This configuration is only applicable to 1st Gen functions with Http trigger. By default https is optional for 1st Gen functions; 2nd Gen functions are https ONLY.

.google.cloud.functions.v2alpha.ServiceConfig.SecurityLevel security_level = 21;

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicStringgetService()

Output only. Name of the service associated with a Function. The format of this field is projects/{project}/locations/{region}/services/{service}

string service = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

publicStringgetServiceAccountEmail()

The email of the service's service account. If empty, defaults to {project_number}-compute@developer.gserviceaccount.com.

string service_account_email = 10;

publicByteStringgetServiceAccountEmailBytes()

The email of the service's service account. If empty, defaults to {project_number}-compute@developer.gserviceaccount.com.

string service_account_email = 10;

publicByteStringgetServiceBytes()

Output only. Name of the service associated with a Function. The format of this field is projects/{project}/locations/{region}/services/{service}

string service = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

publicintgetTimeoutSeconds()

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

int32 timeout_seconds = 2;

publicStringgetUri()

Output only. URI of the Service deployed.

string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicByteStringgetUriBytes()

Output only. URI of the Service deployed.

string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicStringgetVpcConnector()

The Serverless VPC Access connector that this cloud function can connect to. The format of this field is projects/*/locations/*/connectors/*.

string vpc_connector = 6 [(.google.api.resource_reference) = { ... }

publicByteStringgetVpcConnectorBytes()

The Serverless VPC Access connector that this cloud function can connect to. The format of this field is projects/*/locations/*/connectors/*.

string vpc_connector = 6 [(.google.api.resource_reference) = { ... }

publicServiceConfig.VpcConnectorEgressSettingsgetVpcConnectorEgressSettings()

The egress settings for the connector, controlling what traffic is diverted through it.

.google.cloud.functions.v2alpha.ServiceConfig.VpcConnectorEgressSettings vpc_connector_egress_settings = 7;

publicintgetVpcConnectorEgressSettingsValue()

The egress settings for the connector, controlling what traffic is diverted through it.

.google.cloud.functions.v2alpha.ServiceConfig.VpcConnectorEgressSettings vpc_connector_egress_settings = 7;

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicServiceConfig.BuildernewBuilderForType()

protectedServiceConfig.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicServiceConfig.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)