Interface ServiceConfigOrBuilder (2.50.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.72.0
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.4.3
- 2.3.6
publicinterface ServiceConfigOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsEnvironmentVariables(String key)
publicabstractbooleancontainsEnvironmentVariables(Stringkey)Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAllTrafficOnLatestRevision()
publicabstractbooleangetAllTrafficOnLatestRevision()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;
| Returns | |
|---|---|
| Type | Description |
boolean |
The allTrafficOnLatestRevision. |
getAvailableCpu()
publicabstractStringgetAvailableCpu()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;
| Returns | |
|---|---|
| Type | Description |
String |
The availableCpu. |
getAvailableCpuBytes()
publicabstractByteStringgetAvailableCpuBytes()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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for availableCpu. |
getAvailableMemory()
publicabstractStringgetAvailableMemory()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;
| Returns | |
|---|---|
| Type | Description |
String |
The availableMemory. |
getAvailableMemoryBytes()
publicabstractByteStringgetAvailableMemoryBytes()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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for availableMemory. |
getBinaryAuthorizationPolicy()
publicabstractStringgetBinaryAuthorizationPolicy()Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
string binary_authorization_policy = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The binaryAuthorizationPolicy. |
getBinaryAuthorizationPolicyBytes()
publicabstractByteStringgetBinaryAuthorizationPolicyBytes()Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
string binary_authorization_policy = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for binaryAuthorizationPolicy. |
getEnvironmentVariables() (deprecated)
publicabstractMap<String,String>getEnvironmentVariables()Use #getEnvironmentVariablesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getEnvironmentVariablesCount()
publicabstractintgetEnvironmentVariablesCount()Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getEnvironmentVariablesMap()
publicabstractMap<String,String>getEnvironmentVariablesMap()Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getEnvironmentVariablesOrDefault(String key, String defaultValue)
publicabstractStringgetEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getEnvironmentVariablesOrThrow(String key)
publicabstractStringgetEnvironmentVariablesOrThrow(Stringkey)Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getIngressSettings()
publicabstractServiceConfig.IngressSettingsgetIngressSettings()The ingress settings for the function, controlling what traffic can reach it.
.google.cloud.functions.v2alpha.ServiceConfig.IngressSettings ingress_settings = 8;
| Returns | |
|---|---|
| Type | Description |
ServiceConfig.IngressSettings |
The ingressSettings. |
getIngressSettingsValue()
publicabstractintgetIngressSettingsValue()The ingress settings for the function, controlling what traffic can reach it.
.google.cloud.functions.v2alpha.ServiceConfig.IngressSettings ingress_settings = 8;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for ingressSettings. |
getMaxInstanceCount()
publicabstractintgetMaxInstanceCount()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;
| Returns | |
|---|---|
| Type | Description |
int |
The maxInstanceCount. |
getMaxInstanceRequestConcurrency()
publicabstractintgetMaxInstanceRequestConcurrency()Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
int32 max_instance_request_concurrency = 20;
| Returns | |
|---|---|
| Type | Description |
int |
The maxInstanceRequestConcurrency. |
getMinInstanceCount()
publicabstractintgetMinInstanceCount()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;
| Returns | |
|---|---|
| Type | Description |
int |
The minInstanceCount. |
getRevision()
publicabstractStringgetRevision()Output only. The name of service revision.
string revision = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The revision. |
getRevisionBytes()
publicabstractByteStringgetRevisionBytes()Output only. The name of service revision.
string revision = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for revision. |
getSecretEnvironmentVariables(int index)
publicabstractSecretEnvVargetSecretEnvironmentVariables(intindex)Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SecretEnvVar |
|
getSecretEnvironmentVariablesCount()
publicabstractintgetSecretEnvironmentVariablesCount()Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
| Returns | |
|---|---|
| Type | Description |
int |
|
getSecretEnvironmentVariablesList()
publicabstractList<SecretEnvVar>getSecretEnvironmentVariablesList()Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
| Returns | |
|---|---|
| Type | Description |
List<SecretEnvVar> |
|
getSecretEnvironmentVariablesOrBuilder(int index)
publicabstractSecretEnvVarOrBuildergetSecretEnvironmentVariablesOrBuilder(intindex)Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SecretEnvVarOrBuilder |
|
getSecretEnvironmentVariablesOrBuilderList()
publicabstractList<?extendsSecretEnvVarOrBuilder>getSecretEnvironmentVariablesOrBuilderList()Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.functions.v2alpha.SecretEnvVarOrBuilder> |
|
getSecretVolumes(int index)
publicabstractSecretVolumegetSecretVolumes(intindex)Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SecretVolume |
|
getSecretVolumesCount()
publicabstractintgetSecretVolumesCount()Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
| Returns | |
|---|---|
| Type | Description |
int |
|
getSecretVolumesList()
publicabstractList<SecretVolume>getSecretVolumesList()Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
| Returns | |
|---|---|
| Type | Description |
List<SecretVolume> |
|
getSecretVolumesOrBuilder(int index)
publicabstractSecretVolumeOrBuildergetSecretVolumesOrBuilder(intindex)Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SecretVolumeOrBuilder |
|
getSecretVolumesOrBuilderList()
publicabstractList<?extendsSecretVolumeOrBuilder>getSecretVolumesOrBuilderList()Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.functions.v2alpha.SecretVolumeOrBuilder> |
|
getSecurityLevel()
publicabstractServiceConfig.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;
| Returns | |
|---|---|
| Type | Description |
ServiceConfig.SecurityLevel |
The securityLevel. |
getSecurityLevelValue()
publicabstractintgetSecurityLevelValue()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;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for securityLevel. |
getService()
publicabstractStringgetService() 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The service. |
getServiceAccountEmail()
publicabstractStringgetServiceAccountEmail() The email of the service's service account. If empty, defaults to
{project_number}-compute@developer.gserviceaccount.com.
string service_account_email = 10;
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccountEmail. |
getServiceAccountEmailBytes()
publicabstractByteStringgetServiceAccountEmailBytes() The email of the service's service account. If empty, defaults to
{project_number}-compute@developer.gserviceaccount.com.
string service_account_email = 10;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccountEmail. |
getServiceBytes()
publicabstractByteStringgetServiceBytes() 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for service. |
getTimeoutSeconds()
publicabstractintgetTimeoutSeconds()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;
| Returns | |
|---|---|
| Type | Description |
int |
The timeoutSeconds. |
getUri()
publicabstractStringgetUri()Output only. URI of the Service deployed.
string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The uri. |
getUriBytes()
publicabstractByteStringgetUriBytes()Output only. URI of the Service deployed.
string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for uri. |
getVpcConnector()
publicabstractStringgetVpcConnector() 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The vpcConnector. |
getVpcConnectorBytes()
publicabstractByteStringgetVpcConnectorBytes() 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for vpcConnector. |
getVpcConnectorEgressSettings()
publicabstractServiceConfig.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;
| Returns | |
|---|---|
| Type | Description |
ServiceConfig.VpcConnectorEgressSettings |
The vpcConnectorEgressSettings. |
getVpcConnectorEgressSettingsValue()
publicabstractintgetVpcConnectorEgressSettingsValue()The egress settings for the connector, controlling what traffic is diverted through it.
.google.cloud.functions.v2alpha.ServiceConfig.VpcConnectorEgressSettings vpc_connector_egress_settings = 7;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for vpcConnectorEgressSettings. |