Class ServiceConfig.Builder (2.5.4)

Version 2.5.4

• 2.55.0 (latest)
• 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

public static final class ServiceConfig.Builder extends GeneratedMessageV3.Builder<ServiceConfig.Builder> implements ServiceConfigOrBuilder

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

Protobuf type google.cloud.functions.v2.ServiceConfig

Inheritance

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

Implements

ServiceConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllSecretEnvironmentVariables(Iterable<? extends SecretEnvVar> values)

public ServiceConfig.Builder addAllSecretEnvironmentVariables(Iterable<? extends SecretEnvVar> values)

Secret environment variables configuration.

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

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.functions.v2.SecretEnvVar>

Returns

Type	Description
ServiceConfig.Builder

addAllSecretVolumes(Iterable<? extends SecretVolume> values)

public ServiceConfig.Builder addAllSecretVolumes(Iterable<? extends SecretVolume> values)

Secret volumes configuration.

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

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.functions.v2.SecretVolume>

Returns

Type	Description
ServiceConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ServiceConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ServiceConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSecretEnvironmentVariables(SecretEnvVar value)

public ServiceConfig.Builder addSecretEnvironmentVariables(SecretEnvVar value)

Secret environment variables configuration.

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

Parameter

Name	Description
value	SecretEnvVar

Returns

Type	Description
ServiceConfig.Builder

addSecretEnvironmentVariables(SecretEnvVar.Builder builderForValue)

public ServiceConfig.Builder addSecretEnvironmentVariables(SecretEnvVar.Builder builderForValue)

Secret environment variables configuration.

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

Parameter

Name	Description
builderForValue	SecretEnvVar.Builder

Returns

Type	Description
ServiceConfig.Builder

addSecretEnvironmentVariables(int index, SecretEnvVar value)

public ServiceConfig.Builder addSecretEnvironmentVariables(int index, SecretEnvVar value)

Secret environment variables configuration.

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

Parameters

Name	Description
index	int
value	SecretEnvVar

Returns

Type	Description
ServiceConfig.Builder

addSecretEnvironmentVariables(int index, SecretEnvVar.Builder builderForValue)

public ServiceConfig.Builder addSecretEnvironmentVariables(int index, SecretEnvVar.Builder builderForValue)

Secret environment variables configuration.

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

Parameters

Name	Description
index	int
builderForValue	SecretEnvVar.Builder

Returns

Type	Description
ServiceConfig.Builder

addSecretEnvironmentVariablesBuilder()

public SecretEnvVar.Builder addSecretEnvironmentVariablesBuilder()

Secret environment variables configuration.

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

Returns

Type	Description
SecretEnvVar.Builder

addSecretEnvironmentVariablesBuilder(int index)

public SecretEnvVar.Builder addSecretEnvironmentVariablesBuilder(int index)

Secret environment variables configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
SecretEnvVar.Builder

addSecretVolumes(SecretVolume value)

public ServiceConfig.Builder addSecretVolumes(SecretVolume value)

Secret volumes configuration.

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

Parameter

Name	Description
value	SecretVolume

Returns

Type	Description
ServiceConfig.Builder

addSecretVolumes(SecretVolume.Builder builderForValue)

public ServiceConfig.Builder addSecretVolumes(SecretVolume.Builder builderForValue)

Secret volumes configuration.

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

Parameter

Name	Description
builderForValue	SecretVolume.Builder

Returns

Type	Description
ServiceConfig.Builder

addSecretVolumes(int index, SecretVolume value)

public ServiceConfig.Builder addSecretVolumes(int index, SecretVolume value)

Secret volumes configuration.

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

Parameters

Name	Description
index	int
value	SecretVolume

Returns

Type	Description
ServiceConfig.Builder

addSecretVolumes(int index, SecretVolume.Builder builderForValue)

public ServiceConfig.Builder addSecretVolumes(int index, SecretVolume.Builder builderForValue)

Secret volumes configuration.

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

Parameters

Name	Description
index	int
builderForValue	SecretVolume.Builder

Returns

Type	Description
ServiceConfig.Builder

addSecretVolumesBuilder()

public SecretVolume.Builder addSecretVolumesBuilder()

Secret volumes configuration.

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

Returns

Type	Description
SecretVolume.Builder

addSecretVolumesBuilder(int index)

public SecretVolume.Builder addSecretVolumesBuilder(int index)

Secret volumes configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
SecretVolume.Builder

build()

public ServiceConfig build()

Returns

Type	Description
ServiceConfig

buildPartial()

public ServiceConfig buildPartial()

Returns

Type	Description
ServiceConfig

clear()

public ServiceConfig.Builder clear()

Returns

Type	Description
ServiceConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAllTrafficOnLatestRevision()

public ServiceConfig.Builder clearAllTrafficOnLatestRevision()

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
ServiceConfig.Builder	This builder for chaining.

clearAvailableMemory()

public ServiceConfig.Builder clearAvailableMemory()

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
ServiceConfig.Builder	This builder for chaining.

clearEnvironmentVariables()

public ServiceConfig.Builder clearEnvironmentVariables()

Returns

Type	Description
ServiceConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public ServiceConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ServiceConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIngressSettings()

public ServiceConfig.Builder clearIngressSettings()

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

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

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

clearMaxInstanceCount()

public ServiceConfig.Builder clearMaxInstanceCount()

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
ServiceConfig.Builder	This builder for chaining.

clearMinInstanceCount()

public ServiceConfig.Builder clearMinInstanceCount()

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
ServiceConfig.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ServiceConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ServiceConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRevision()

public ServiceConfig.Builder clearRevision()

Output only. The name of service revision.

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

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

clearSecretEnvironmentVariables()

public ServiceConfig.Builder clearSecretEnvironmentVariables()

Secret environment variables configuration.

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

Returns

Type	Description
ServiceConfig.Builder

clearSecretVolumes()

public ServiceConfig.Builder clearSecretVolumes()

Secret volumes configuration.

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

Returns

Type	Description
ServiceConfig.Builder

clearService()

public ServiceConfig.Builder clearService()

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
ServiceConfig.Builder	This builder for chaining.

clearServiceAccountEmail()

public ServiceConfig.Builder clearServiceAccountEmail()

The email of the service's service account. If empty, defaults to {project_number}[e-mail].

string service_account_email = 10;

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

clearTimeoutSeconds()

public ServiceConfig.Builder clearTimeoutSeconds()

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
ServiceConfig.Builder	This builder for chaining.

clearUri()

public ServiceConfig.Builder clearUri()

Output only. URI of the Service deployed.

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

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

clearVpcConnector()

public ServiceConfig.Builder clearVpcConnector()

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
ServiceConfig.Builder	This builder for chaining.

clearVpcConnectorEgressSettings()

public ServiceConfig.Builder clearVpcConnectorEgressSettings()

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

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

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

clone()

public ServiceConfig.Builder clone()

Returns

Type	Description
ServiceConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsEnvironmentVariables(String key)

public boolean containsEnvironmentVariables(String key)

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()

public 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

Type	Description
boolean	The allTrafficOnLatestRevision.

getAvailableMemory()

public 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

Type	Description
String	The availableMemory.

getAvailableMemoryBytes()

public 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

Type	Description
ByteString	The bytes for availableMemory.

getDefaultInstanceForType()

public ServiceConfig getDefaultInstanceForType()

Returns

Type	Description
ServiceConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEnvironmentVariables()

public Map<String,String> getEnvironmentVariables()

Use #getEnvironmentVariablesMap() instead.

Returns

Type	Description
Map<String,String>

getEnvironmentVariablesCount()

public int getEnvironmentVariablesCount()

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 4;

Returns

Type	Description
int

getEnvironmentVariablesMap()

public Map<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)

public String getEnvironmentVariablesOrDefault(String key, String defaultValue)

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)

public String getEnvironmentVariablesOrThrow(String key)

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()

public ServiceConfig.IngressSettings getIngressSettings()

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

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

Returns

Type	Description
ServiceConfig.IngressSettings	The ingressSettings.

getIngressSettingsValue()

public int getIngressSettingsValue()

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

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

Returns

Type	Description
int	The enum numeric value on the wire for ingressSettings.

getMaxInstanceCount()

public 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 Guide for more details.

int32 max_instance_count = 5;

Returns

Type	Description
int	The maxInstanceCount.

getMinInstanceCount()

public 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

Type	Description
int	The minInstanceCount.

getMutableEnvironmentVariables()

public Map<String,String> getMutableEnvironmentVariables()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,String>

getRevision()

public String getRevision()

Output only. The name of service revision.

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

Returns

Type	Description
String	The revision.

getRevisionBytes()

public ByteString getRevisionBytes()

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)

public SecretEnvVar getSecretEnvironmentVariables(int index)

Secret environment variables configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
SecretEnvVar

getSecretEnvironmentVariablesBuilder(int index)

public SecretEnvVar.Builder getSecretEnvironmentVariablesBuilder(int index)

Secret environment variables configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
SecretEnvVar.Builder

getSecretEnvironmentVariablesBuilderList()

public List<SecretEnvVar.Builder> getSecretEnvironmentVariablesBuilderList()

Secret environment variables configuration.

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

Returns

Type	Description
List<Builder>

getSecretEnvironmentVariablesCount()

public int getSecretEnvironmentVariablesCount()

Secret environment variables configuration.

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

Returns

Type	Description
int

getSecretEnvironmentVariablesList()

public List<SecretEnvVar> getSecretEnvironmentVariablesList()

Secret environment variables configuration.

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

Returns

Type	Description
List<SecretEnvVar>

getSecretEnvironmentVariablesOrBuilder(int index)

public SecretEnvVarOrBuilder getSecretEnvironmentVariablesOrBuilder(int index)

Secret environment variables configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
SecretEnvVarOrBuilder

getSecretEnvironmentVariablesOrBuilderList()

public List<? extends SecretEnvVarOrBuilder> getSecretEnvironmentVariablesOrBuilderList()

Secret environment variables configuration.

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

Returns

Type	Description
List<? extends com.google.cloud.functions.v2.SecretEnvVarOrBuilder>

getSecretVolumes(int index)

public SecretVolume getSecretVolumes(int index)

Secret volumes configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
SecretVolume

getSecretVolumesBuilder(int index)

public SecretVolume.Builder getSecretVolumesBuilder(int index)

Secret volumes configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
SecretVolume.Builder

getSecretVolumesBuilderList()

public List<SecretVolume.Builder> getSecretVolumesBuilderList()

Secret volumes configuration.

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

Returns

Type	Description
List<Builder>

getSecretVolumesCount()

public int getSecretVolumesCount()

Secret volumes configuration.

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

Returns

Type	Description
int

getSecretVolumesList()

public List<SecretVolume> getSecretVolumesList()

Secret volumes configuration.

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

Returns

Type	Description
List<SecretVolume>

getSecretVolumesOrBuilder(int index)

public SecretVolumeOrBuilder getSecretVolumesOrBuilder(int index)

Secret volumes configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
SecretVolumeOrBuilder

getSecretVolumesOrBuilderList()

public List<? extends SecretVolumeOrBuilder> getSecretVolumesOrBuilderList()

Secret volumes configuration.

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

Returns

Type	Description
List<? extends com.google.cloud.functions.v2.SecretVolumeOrBuilder>

getService()

public 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

Type	Description
String	The service.

getServiceAccountEmail()

public String getServiceAccountEmail()

The email of the service's service account. If empty, defaults to {project_number}[e-mail].

string service_account_email = 10;

Returns

Type	Description
String	The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

The email of the service's service account. If empty, defaults to {project_number}[e-mail].

string service_account_email = 10;

Returns

Type	Description
ByteString	The bytes for serviceAccountEmail.

getServiceBytes()

public 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

Type	Description
ByteString	The bytes for service.

getTimeoutSeconds()

public 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

Type	Description
int	The timeoutSeconds.

getUri()

public String getUri()

Output only. URI of the Service deployed.

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

Returns

Type	Description
String	The uri.

getUriBytes()

public ByteString getUriBytes()

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()

public 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

Type	Description
String	The vpcConnector.

getVpcConnectorBytes()

public 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

Type	Description
ByteString	The bytes for vpcConnector.

getVpcConnectorEgressSettings()

public ServiceConfig.VpcConnectorEgressSettings getVpcConnectorEgressSettings()

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

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

Returns

Type	Description
ServiceConfig.VpcConnectorEgressSettings	The vpcConnectorEgressSettings.

getVpcConnectorEgressSettingsValue()

public int getVpcConnectorEgressSettingsValue()

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

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

Returns

Type	Description
int	The enum numeric value on the wire for vpcConnectorEgressSettings.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ServiceConfig other)

public ServiceConfig.Builder mergeFrom(ServiceConfig other)

Parameter

Name	Description
other	ServiceConfig

Returns

Type	Description
ServiceConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ServiceConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ServiceConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ServiceConfig.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ServiceConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ServiceConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ServiceConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllEnvironmentVariables(Map<String,String> values)

public ServiceConfig.Builder putAllEnvironmentVariables(Map<String,String> values)

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 4;

Parameter

Name	Description
values	Map<String,String>

Returns

Type	Description
ServiceConfig.Builder

putEnvironmentVariables(String key, String value)

public ServiceConfig.Builder putEnvironmentVariables(String key, String value)

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 4;

Parameters

Name	Description
key	String
value	String

Returns

Type	Description
ServiceConfig.Builder

removeEnvironmentVariables(String key)

public ServiceConfig.Builder removeEnvironmentVariables(String key)

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 4;

Parameter

Name	Description
key	String

Returns

Type	Description
ServiceConfig.Builder

removeSecretEnvironmentVariables(int index)

public ServiceConfig.Builder removeSecretEnvironmentVariables(int index)

Secret environment variables configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
ServiceConfig.Builder

removeSecretVolumes(int index)

public ServiceConfig.Builder removeSecretVolumes(int index)

Secret volumes configuration.

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

Parameter

Name	Description
index	int

Returns

Type	Description
ServiceConfig.Builder

setAllTrafficOnLatestRevision(boolean value)

public ServiceConfig.Builder setAllTrafficOnLatestRevision(boolean value)

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;

Parameter

Name	Description
value	boolean The allTrafficOnLatestRevision to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setAvailableMemory(String value)

public ServiceConfig.Builder setAvailableMemory(String value)

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;

Parameter

Name	Description
value	String The availableMemory to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setAvailableMemoryBytes(ByteString value)

public ServiceConfig.Builder setAvailableMemoryBytes(ByteString value)

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;

Parameter

Name	Description
value	ByteString The bytes for availableMemory to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ServiceConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ServiceConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIngressSettings(ServiceConfig.IngressSettings value)

public ServiceConfig.Builder setIngressSettings(ServiceConfig.IngressSettings value)

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

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

Parameter

Name	Description
value	ServiceConfig.IngressSettings The ingressSettings to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setIngressSettingsValue(int value)

public ServiceConfig.Builder setIngressSettingsValue(int value)

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

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

Parameter

Name	Description
value	int The enum numeric value on the wire for ingressSettings to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setMaxInstanceCount(int value)

public ServiceConfig.Builder setMaxInstanceCount(int value)

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;

Parameter

Name	Description
value	int The maxInstanceCount to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setMinInstanceCount(int value)

public ServiceConfig.Builder setMinInstanceCount(int value)

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;

Parameter

Name	Description
value	int The minInstanceCount to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ServiceConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ServiceConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRevision(String value)

public ServiceConfig.Builder setRevision(String value)

Output only. The name of service revision.

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

Parameter

Name	Description
value	String The revision to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setRevisionBytes(ByteString value)

public ServiceConfig.Builder setRevisionBytes(ByteString value)

Output only. The name of service revision.

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

Parameter

Name	Description
value	ByteString The bytes for revision to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setSecretEnvironmentVariables(int index, SecretEnvVar value)

public ServiceConfig.Builder setSecretEnvironmentVariables(int index, SecretEnvVar value)

Secret environment variables configuration.

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

Parameters

Name	Description
index	int
value	SecretEnvVar

Returns

Type	Description
ServiceConfig.Builder

setSecretEnvironmentVariables(int index, SecretEnvVar.Builder builderForValue)

public ServiceConfig.Builder setSecretEnvironmentVariables(int index, SecretEnvVar.Builder builderForValue)

Secret environment variables configuration.

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

Parameters

Name	Description
index	int
builderForValue	SecretEnvVar.Builder

Returns

Type	Description
ServiceConfig.Builder

setSecretVolumes(int index, SecretVolume value)

public ServiceConfig.Builder setSecretVolumes(int index, SecretVolume value)

Secret volumes configuration.

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

Parameters

Name	Description
index	int
value	SecretVolume

Returns

Type	Description
ServiceConfig.Builder

setSecretVolumes(int index, SecretVolume.Builder builderForValue)

public ServiceConfig.Builder setSecretVolumes(int index, SecretVolume.Builder builderForValue)

Secret volumes configuration.

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

Parameters

Name	Description
index	int
builderForValue	SecretVolume.Builder

Returns

Type	Description
ServiceConfig.Builder

setService(String value)

public ServiceConfig.Builder setService(String value)

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) = { ... }

Parameter

Name	Description
value	String The service to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setServiceAccountEmail(String value)

public ServiceConfig.Builder setServiceAccountEmail(String value)

The email of the service's service account. If empty, defaults to {project_number}[e-mail].

string service_account_email = 10;

Parameter

Name	Description
value	String The serviceAccountEmail to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public ServiceConfig.Builder setServiceAccountEmailBytes(ByteString value)

The email of the service's service account. If empty, defaults to {project_number}[e-mail].

string service_account_email = 10;

Parameter

Name	Description
value	ByteString The bytes for serviceAccountEmail to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setServiceBytes(ByteString value)

public ServiceConfig.Builder setServiceBytes(ByteString value)

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) = { ... }

Parameter

Name	Description
value	ByteString The bytes for service to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setTimeoutSeconds(int value)

public ServiceConfig.Builder setTimeoutSeconds(int value)

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;

Parameter

Name	Description
value	int The timeoutSeconds to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ServiceConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ServiceConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUri(String value)

public ServiceConfig.Builder setUri(String value)

Output only. URI of the Service deployed.

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

Parameter

Name	Description
value	String The uri to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setUriBytes(ByteString value)

public ServiceConfig.Builder setUriBytes(ByteString value)

Output only. URI of the Service deployed.

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

Parameter

Name	Description
value	ByteString The bytes for uri to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setVpcConnector(String value)

public ServiceConfig.Builder setVpcConnector(String value)

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) = { ... }

Parameter

Name	Description
value	String The vpcConnector to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setVpcConnectorBytes(ByteString value)

public ServiceConfig.Builder setVpcConnectorBytes(ByteString value)

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) = { ... }

Parameter

Name	Description
value	ByteString The bytes for vpcConnector to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setVpcConnectorEgressSettings(ServiceConfig.VpcConnectorEgressSettings value)

public ServiceConfig.Builder setVpcConnectorEgressSettings(ServiceConfig.VpcConnectorEgressSettings value)

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

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

Parameter

Name	Description
value	ServiceConfig.VpcConnectorEgressSettings The vpcConnectorEgressSettings to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.

setVpcConnectorEgressSettingsValue(int value)

public ServiceConfig.Builder setVpcConnectorEgressSettingsValue(int value)

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

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

Parameter

Name	Description
value	int The enum numeric value on the wire for vpcConnectorEgressSettings to set.

Returns

Type	Description
ServiceConfig.Builder	This builder for chaining.