Class ServiceConfig (2.13.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
publicfinalclass ServiceConfigextendsGeneratedMessageV3implementsServiceConfigOrBuilderDescribes the Service being deployed. Currently Supported : Cloud Run (fully managed).
Protobuf type google.cloud.functions.v2alpha.ServiceConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ServiceConfigImplements
ServiceConfigOrBuilderInherited Members
Static Fields
ALL_TRAFFIC_ON_LATEST_REVISION_FIELD_NUMBER
publicstaticfinalintALL_TRAFFIC_ON_LATEST_REVISION_FIELD_NUMBERAVAILABLE_MEMORY_FIELD_NUMBER
publicstaticfinalintAVAILABLE_MEMORY_FIELD_NUMBERENVIRONMENT_VARIABLES_FIELD_NUMBER
publicstaticfinalintENVIRONMENT_VARIABLES_FIELD_NUMBERINGRESS_SETTINGS_FIELD_NUMBER
publicstaticfinalintINGRESS_SETTINGS_FIELD_NUMBERMAX_INSTANCE_COUNT_FIELD_NUMBER
publicstaticfinalintMAX_INSTANCE_COUNT_FIELD_NUMBERMIN_INSTANCE_COUNT_FIELD_NUMBER
publicstaticfinalintMIN_INSTANCE_COUNT_FIELD_NUMBERREVISION_FIELD_NUMBER
publicstaticfinalintREVISION_FIELD_NUMBERSECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBER
publicstaticfinalintSECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBERSECRET_VOLUMES_FIELD_NUMBER
publicstaticfinalintSECRET_VOLUMES_FIELD_NUMBERSERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
publicstaticfinalintSERVICE_ACCOUNT_EMAIL_FIELD_NUMBERSERVICE_FIELD_NUMBER
publicstaticfinalintSERVICE_FIELD_NUMBERTIMEOUT_SECONDS_FIELD_NUMBER
publicstaticfinalintTIMEOUT_SECONDS_FIELD_NUMBERURI_FIELD_NUMBER
publicstaticfinalintURI_FIELD_NUMBERVPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBER
publicstaticfinalintVPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBERVPC_CONNECTOR_FIELD_NUMBER
publicstaticfinalintVPC_CONNECTOR_FIELD_NUMBERStatic Methods
getDefaultInstance()
publicstaticServiceConfiggetDefaultInstance()getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()newBuilder()
publicstaticServiceConfig.BuildernewBuilder()newBuilder(ServiceConfig prototype)
publicstaticServiceConfig.BuildernewBuilder(ServiceConfigprototype)parseDelimitedFrom(InputStream input)
publicstaticServiceConfigparseDelimitedFrom(InputStreaminput)parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticServiceConfigparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(byte[] data)
publicstaticServiceConfigparseFrom(byte[]data)data
byte[]parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticServiceConfigparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)data
byte[]parseFrom(ByteString data)
publicstaticServiceConfigparseFrom(ByteStringdata)parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticServiceConfigparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)parseFrom(CodedInputStream input)
publicstaticServiceConfigparseFrom(CodedInputStreaminput)parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticServiceConfigparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(InputStream input)
publicstaticServiceConfigparseFrom(InputStreaminput)parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticServiceConfigparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(ByteBuffer data)
publicstaticServiceConfigparseFrom(ByteBufferdata)parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticServiceConfigparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)parser()
publicstaticParser<ServiceConfig>parser()Methods
containsEnvironmentVariables(String key)
publicbooleancontainsEnvironmentVariables(Stringkey)Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
equals(Object obj)
publicbooleanequals(Objectobj)getAllTrafficOnLatestRevision()
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;
boolean
The allTrafficOnLatestRevision.
getAvailableMemory()
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;
String
The availableMemory.
getAvailableMemoryBytes()
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;
ByteString
The bytes for availableMemory.
getDefaultInstanceForType()
publicServiceConfiggetDefaultInstanceForType()getEnvironmentVariables()
publicMap<String,String>getEnvironmentVariables()Use #getEnvironmentVariablesMap() instead.
getEnvironmentVariablesCount()
publicintgetEnvironmentVariablesCount()Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
getEnvironmentVariablesMap()
publicMap<String,String>getEnvironmentVariablesMap()Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
getEnvironmentVariablesOrDefault(String key, String defaultValue)
publicStringgetEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
getEnvironmentVariablesOrThrow(String key)
publicStringgetEnvironmentVariablesOrThrow(Stringkey)Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
getIngressSettings()
publicServiceConfig.IngressSettingsgetIngressSettings()The ingress settings for the function, controlling what traffic can reach it.
.google.cloud.functions.v2alpha.ServiceConfig.IngressSettings ingress_settings = 8;
ServiceConfig.IngressSettings
The ingressSettings.
getIngressSettingsValue()
publicintgetIngressSettingsValue()The ingress settings for the function, controlling what traffic can reach it.
.google.cloud.functions.v2alpha.ServiceConfig.IngressSettings ingress_settings = 8;
int
The enum numeric value on the wire for ingressSettings.
getMaxInstanceCount()
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;
int
The maxInstanceCount.
getMinInstanceCount()
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;
int
The minInstanceCount.
getParserForType()
publicParser<ServiceConfig>getParserForType()getRevision()
publicStringgetRevision()Output only. The name of service revision.
string revision = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
String
The revision.
getRevisionBytes()
publicByteStringgetRevisionBytes()Output only. The name of service revision.
string revision = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
ByteString
The bytes for revision.
getSecretEnvironmentVariables(int index)
publicSecretEnvVargetSecretEnvironmentVariables(intindex)Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
getSecretEnvironmentVariablesCount()
publicintgetSecretEnvironmentVariablesCount()Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
getSecretEnvironmentVariablesList()
publicList<SecretEnvVar>getSecretEnvironmentVariablesList()Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
getSecretEnvironmentVariablesOrBuilder(int index)
publicSecretEnvVarOrBuildergetSecretEnvironmentVariablesOrBuilder(intindex)Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
getSecretEnvironmentVariablesOrBuilderList()
publicList<?extendsSecretEnvVarOrBuilder>getSecretEnvironmentVariablesOrBuilderList()Secret environment variables configuration.
repeated .google.cloud.functions.v2alpha.SecretEnvVar secret_environment_variables = 17;
List<? extends com.google.cloud.functions.v2alpha.SecretEnvVarOrBuilder>
getSecretVolumes(int index)
publicSecretVolumegetSecretVolumes(intindex)Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
getSecretVolumesCount()
publicintgetSecretVolumesCount()Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
getSecretVolumesList()
publicList<SecretVolume>getSecretVolumesList()Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
getSecretVolumesOrBuilder(int index)
publicSecretVolumeOrBuildergetSecretVolumesOrBuilder(intindex)Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
getSecretVolumesOrBuilderList()
publicList<?extendsSecretVolumeOrBuilder>getSecretVolumesOrBuilderList()Secret volumes configuration.
repeated .google.cloud.functions.v2alpha.SecretVolume secret_volumes = 19;
List<? extends com.google.cloud.functions.v2alpha.SecretVolumeOrBuilder>
getSerializedSize()
publicintgetSerializedSize()getService()
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) = { ... }
String
The service.
getServiceAccountEmail()
publicStringgetServiceAccountEmail() The email of the service's service account. If empty, defaults to
{project_number}-compute@developer.gserviceaccount.com.
string service_account_email = 10;
String
The serviceAccountEmail.
getServiceAccountEmailBytes()
publicByteStringgetServiceAccountEmailBytes() The email of the service's service account. If empty, defaults to
{project_number}-compute@developer.gserviceaccount.com.
string service_account_email = 10;
ByteString
The bytes for serviceAccountEmail.
getServiceBytes()
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) = { ... }
ByteString
The bytes for service.
getTimeoutSeconds()
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;
int
The timeoutSeconds.
getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()getUri()
publicStringgetUri()Output only. URI of the Service deployed.
string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
String
The uri.
getUriBytes()
publicByteStringgetUriBytes()Output only. URI of the Service deployed.
string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
ByteString
The bytes for uri.
getVpcConnector()
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) = { ... }
String
The vpcConnector.
getVpcConnectorBytes()
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) = { ... }
ByteString
The bytes for vpcConnector.
getVpcConnectorEgressSettings()
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;
ServiceConfig.VpcConnectorEgressSettings
The vpcConnectorEgressSettings.
getVpcConnectorEgressSettingsValue()
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;
int
The enum numeric value on the wire for vpcConnectorEgressSettings.
hashCode()
publicinthashCode()internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)isInitialized()
publicfinalbooleanisInitialized()newBuilderForType()
publicServiceConfig.BuildernewBuilderForType()newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedServiceConfig.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)toBuilder()
publicServiceConfig.BuildertoBuilder()writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)