com.google.cloud.functions.v2beta

Interface ServiceConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ServiceConfig, ServiceConfig.Builder

public interface ServiceConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsEnvironmentVariables(String key) Environment variables that shall be available during function execution.
boolean	getAllTrafficOnLatestRevision() Whether 100% of traffic is routed to the latest revision.
String	getAvailableCpu() [Preview] The number of CPUs used in a single container instance.
com.google.protobuf.ByteString	getAvailableCpuBytes() [Preview] The number of CPUs used in a single container instance.
String	getAvailableMemory() The amount of memory available for a function.
com.google.protobuf.ByteString	getAvailableMemoryBytes() The amount of memory available for a function.
Map<String,String>	getEnvironmentVariables() Deprecated.
int	getEnvironmentVariablesCount() Environment variables that shall be available during function execution.
Map<String,String>	getEnvironmentVariablesMap() Environment variables that shall be available during function execution.
String	getEnvironmentVariablesOrDefault(String key, String defaultValue) Environment variables that shall be available during function execution.
String	getEnvironmentVariablesOrThrow(String key) Environment variables that shall be available during function execution.
ServiceConfig.IngressSettings	getIngressSettings() The ingress settings for the function, controlling what traffic can reach it.
int	getIngressSettingsValue() The ingress settings for the function, controlling what traffic can reach it.
int	getMaxInstanceCount() The limit on the maximum number of function instances that may coexist at a given time.
int	getMaxInstanceRequestConcurrency() [Preview] Sets the maximum number of concurrent requests that each instance can receive.
int	getMinInstanceCount() The limit on the minimum number of function instances that may coexist at a given time.
String	getRevision() Output only.
com.google.protobuf.ByteString	getRevisionBytes() Output only.
SecretEnvVar	getSecretEnvironmentVariables(int index) Secret environment variables configuration.
int	getSecretEnvironmentVariablesCount() Secret environment variables configuration.
List<SecretEnvVar>	getSecretEnvironmentVariablesList() Secret environment variables configuration.
SecretEnvVarOrBuilder	getSecretEnvironmentVariablesOrBuilder(int index) Secret environment variables configuration.
List<? extends SecretEnvVarOrBuilder>	getSecretEnvironmentVariablesOrBuilderList() Secret environment variables configuration.
SecretVolume	getSecretVolumes(int index) Secret volumes configuration.
int	getSecretVolumesCount() Secret volumes configuration.
List<SecretVolume>	getSecretVolumesList() Secret volumes configuration.
SecretVolumeOrBuilder	getSecretVolumesOrBuilder(int index) Secret volumes configuration.
List<? extends SecretVolumeOrBuilder>	getSecretVolumesOrBuilderList() Secret volumes configuration.
ServiceConfig.SecurityLevel	getSecurityLevel() Security level configure whether the function only accepts https.
int	getSecurityLevelValue() Security level configure whether the function only accepts https.
String	getService() Output only.
String	getServiceAccountEmail() The email of the service's service account.
com.google.protobuf.ByteString	getServiceAccountEmailBytes() The email of the service's service account.
com.google.protobuf.ByteString	getServiceBytes() Output only.
int	getTimeoutSeconds() The function execution timeout.
String	getUri() Output only.
com.google.protobuf.ByteString	getUriBytes() Output only.
String	getVpcConnector() The Serverless VPC Access connector that this cloud function can connect to.
com.google.protobuf.ByteString	getVpcConnectorBytes() The Serverless VPC Access connector that this cloud function can connect to.
ServiceConfig.VpcConnectorEgressSettings	getVpcConnectorEgressSettings() The egress settings for the connector, controlling what traffic is diverted through it.
int	getVpcConnectorEgressSettingsValue() The egress settings for the connector, controlling what traffic is diverted through it.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getService

String getService()

 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:

The service.

getServiceBytes

com.google.protobuf.ByteString getServiceBytes()

 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:

The bytes for service.

getTimeoutSeconds

int getTimeoutSeconds()

 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:

The timeoutSeconds.

getAvailableMemory

String getAvailableMemory()

 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:

The availableMemory.

getAvailableMemoryBytes

com.google.protobuf.ByteString getAvailableMemoryBytes()

 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:

The bytes for availableMemory.

getAvailableCpu

String getAvailableCpu()

 [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;

Returns:

The availableCpu.

getAvailableCpuBytes

com.google.protobuf.ByteString getAvailableCpuBytes()

 [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;

Returns:

The bytes for availableCpu.

getEnvironmentVariablesCount

int getEnvironmentVariablesCount()

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 4;

containsEnvironmentVariables

boolean containsEnvironmentVariables(String key)

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 4;

getEnvironmentVariables

@Deprecated
Map<String,String> getEnvironmentVariables()

Deprecated.

Use getEnvironmentVariablesMap() instead.

getEnvironmentVariablesMap

Map<String,String> getEnvironmentVariablesMap()

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 4;

getEnvironmentVariablesOrDefault

String getEnvironmentVariablesOrDefault(String key,
                                        String defaultValue)

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 4;

getEnvironmentVariablesOrThrow

String getEnvironmentVariablesOrThrow(String key)

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 4;

getMaxInstanceCount

int getMaxInstanceCount()

 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](https://cloud.google.com/functions/docs/max-instances) Guide for
 more details.
 

int32 max_instance_count = 5;

Returns:

The maxInstanceCount.

getMinInstanceCount

int getMinInstanceCount()

 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:

The minInstanceCount.

getVpcConnector

String getVpcConnector()

 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:

The vpcConnector.

getVpcConnectorBytes

com.google.protobuf.ByteString getVpcConnectorBytes()

 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:

The bytes for vpcConnector.

getVpcConnectorEgressSettingsValue

int getVpcConnectorEgressSettingsValue()

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

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

Returns:

The enum numeric value on the wire for vpcConnectorEgressSettings.

getVpcConnectorEgressSettings

ServiceConfig.VpcConnectorEgressSettings getVpcConnectorEgressSettings()

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

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

Returns:

The vpcConnectorEgressSettings.

getIngressSettingsValue

int getIngressSettingsValue()

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

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

Returns:

The enum numeric value on the wire for ingressSettings.

getIngressSettings

ServiceConfig.IngressSettings getIngressSettings()

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

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

Returns:

The ingressSettings.

getUri

String getUri()

 Output only. URI of the Service deployed.
 

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

Returns:

The uri.

getUriBytes

com.google.protobuf.ByteString getUriBytes()

 Output only. URI of the Service deployed.
 

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

Returns:

The bytes for uri.

getServiceAccountEmail

String getServiceAccountEmail()

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

string service_account_email = 10;

Returns:

The serviceAccountEmail.

getServiceAccountEmailBytes

com.google.protobuf.ByteString getServiceAccountEmailBytes()

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

string service_account_email = 10;

Returns:

The bytes for serviceAccountEmail.

getAllTrafficOnLatestRevision

boolean getAllTrafficOnLatestRevision()

 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:

The allTrafficOnLatestRevision.

getSecretEnvironmentVariablesList

List<SecretEnvVar> getSecretEnvironmentVariablesList()

 Secret environment variables configuration.
 

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

getSecretEnvironmentVariables

SecretEnvVar getSecretEnvironmentVariables(int index)

 Secret environment variables configuration.
 

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

getSecretEnvironmentVariablesCount

int getSecretEnvironmentVariablesCount()

 Secret environment variables configuration.
 

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

getSecretEnvironmentVariablesOrBuilderList

List<? extends SecretEnvVarOrBuilder> getSecretEnvironmentVariablesOrBuilderList()

 Secret environment variables configuration.
 

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

getSecretEnvironmentVariablesOrBuilder

SecretEnvVarOrBuilder getSecretEnvironmentVariablesOrBuilder(int index)

 Secret environment variables configuration.
 

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

getSecretVolumesList

List<SecretVolume> getSecretVolumesList()

 Secret volumes configuration.
 

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

getSecretVolumes

SecretVolume getSecretVolumes(int index)

 Secret volumes configuration.
 

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

getSecretVolumesCount

int getSecretVolumesCount()

 Secret volumes configuration.
 

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

getSecretVolumesOrBuilderList

List<? extends SecretVolumeOrBuilder> getSecretVolumesOrBuilderList()

 Secret volumes configuration.
 

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

getSecretVolumesOrBuilder

SecretVolumeOrBuilder getSecretVolumesOrBuilder(int index)

 Secret volumes configuration.
 

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

getRevision

String getRevision()

 Output only. The name of service revision.
 

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

Returns:

The revision.

getRevisionBytes

com.google.protobuf.ByteString getRevisionBytes()

 Output only. The name of service revision.
 

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

Returns:

The bytes for revision.

getMaxInstanceRequestConcurrency

int getMaxInstanceRequestConcurrency()

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

int32 max_instance_request_concurrency = 20;

Returns:

The maxInstanceRequestConcurrency.

getSecurityLevelValue

int getSecurityLevelValue()

 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.v2beta.ServiceConfig.SecurityLevel security_level = 21;

Returns:

The enum numeric value on the wire for securityLevel.

getSecurityLevel

ServiceConfig.SecurityLevel getSecurityLevel()

 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.v2beta.ServiceConfig.SecurityLevel security_level = 21;

Returns:

The securityLevel.