public final class ServiceConfig extends GeneratedMessageV3 implements ServiceConfigOrBuilder
Describes the Service being deployed.
Currently Supported : Cloud Run (fully managed).
Protobuf type google.cloud.functions.v2.ServiceConfig
Static Fields
ALL_TRAFFIC_ON_LATEST_REVISION_FIELD_NUMBER
public static final int ALL_TRAFFIC_ON_LATEST_REVISION_FIELD_NUMBER
Field Value
AVAILABLE_MEMORY_FIELD_NUMBER
public static final int AVAILABLE_MEMORY_FIELD_NUMBER
Field Value
ENVIRONMENT_VARIABLES_FIELD_NUMBER
public static final int ENVIRONMENT_VARIABLES_FIELD_NUMBER
Field Value
INGRESS_SETTINGS_FIELD_NUMBER
public static final int INGRESS_SETTINGS_FIELD_NUMBER
Field Value
MAX_INSTANCE_COUNT_FIELD_NUMBER
public static final int MAX_INSTANCE_COUNT_FIELD_NUMBER
Field Value
MIN_INSTANCE_COUNT_FIELD_NUMBER
public static final int MIN_INSTANCE_COUNT_FIELD_NUMBER
Field Value
REVISION_FIELD_NUMBER
public static final int REVISION_FIELD_NUMBER
Field Value
SECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBER
public static final int SECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBER
Field Value
SECRET_VOLUMES_FIELD_NUMBER
public static final int SECRET_VOLUMES_FIELD_NUMBER
Field Value
SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
SERVICE_FIELD_NUMBER
public static final int SERVICE_FIELD_NUMBER
Field Value
TIMEOUT_SECONDS_FIELD_NUMBER
public static final int TIMEOUT_SECONDS_FIELD_NUMBER
Field Value
URI_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
Field Value
VPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBER
public static final int VPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBER
Field Value
VPC_CONNECTOR_FIELD_NUMBER
public static final int VPC_CONNECTOR_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ServiceConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ServiceConfig.Builder newBuilder()
Returns
newBuilder(ServiceConfig prototype)
public static ServiceConfig.Builder newBuilder(ServiceConfig prototype)
Parameter
Returns
public static ServiceConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ServiceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ServiceConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ServiceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ServiceConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ServiceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ServiceConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ServiceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ServiceConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ServiceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ServiceConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ServiceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ServiceConfig> parser()
Returns
Methods
containsEnvironmentVariables(String key)
public boolean containsEnvironmentVariables(String key)
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| Type | Description |
| boolean | The allTrafficOnLatestRevision.
|
getAvailableMemory()
public String getAvailableMemory()
Returns
| Type | Description |
| String | The availableMemory.
|
getAvailableMemoryBytes()
public ByteString getAvailableMemoryBytes()
Returns
| Type | Description |
| ByteString | The bytes for availableMemory.
|
getDefaultInstanceForType()
public ServiceConfig getDefaultInstanceForType()
Returns
getEnvironmentVariables()
public Map<String,String> getEnvironmentVariables()
Returns
getEnvironmentVariablesCount()
public int getEnvironmentVariablesCount()
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
getEnvironmentVariablesMap()
public Map<String,String> getEnvironmentVariablesMap()
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
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;
getEnvironmentVariablesOrThrow(String key)
public String getEnvironmentVariablesOrThrow(String key)
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 4;
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;
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;
| 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;
| 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;
| Type | Description |
| int | The minInstanceCount.
|
getParserForType()
public Parser<ServiceConfig> getParserForType()
Returns
Overrides
getRevision()
public String getRevision()
Output only. The name of service revision.
string revision = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
getSecretEnvironmentVariables(int index)
public SecretEnvVar getSecretEnvironmentVariables(int index)
Secret environment variables configuration.
repeated .google.cloud.functions.v2.SecretEnvVar secret_environment_variables = 17;
getSecretEnvironmentVariablesCount()
public int getSecretEnvironmentVariablesCount()
Secret environment variables configuration.
repeated .google.cloud.functions.v2.SecretEnvVar secret_environment_variables = 17;
getSecretEnvironmentVariablesList()
public List<SecretEnvVar> getSecretEnvironmentVariablesList()
Secret environment variables configuration.
repeated .google.cloud.functions.v2.SecretEnvVar secret_environment_variables = 17;
getSecretEnvironmentVariablesOrBuilder(int index)
public SecretEnvVarOrBuilder getSecretEnvironmentVariablesOrBuilder(int index)
Secret environment variables configuration.
repeated .google.cloud.functions.v2.SecretEnvVar secret_environment_variables = 17;
getSecretEnvironmentVariablesOrBuilderList()
public List<? extends SecretEnvVarOrBuilder> getSecretEnvironmentVariablesOrBuilderList()
Secret environment variables configuration.
repeated .google.cloud.functions.v2.SecretEnvVar secret_environment_variables = 17;
| 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;
getSecretVolumesCount()
public int getSecretVolumesCount()
Secret volumes configuration.
repeated .google.cloud.functions.v2.SecretVolume secret_volumes = 19;
getSecretVolumesList()
public List<SecretVolume> getSecretVolumesList()
Secret volumes configuration.
repeated .google.cloud.functions.v2.SecretVolume secret_volumes = 19;
getSecretVolumesOrBuilder(int index)
public SecretVolumeOrBuilder getSecretVolumesOrBuilder(int index)
Secret volumes configuration.
repeated .google.cloud.functions.v2.SecretVolume secret_volumes = 19;
getSecretVolumesOrBuilderList()
public List<? extends SecretVolumeOrBuilder> getSecretVolumesOrBuilderList()
Secret volumes configuration.
repeated .google.cloud.functions.v2.SecretVolume secret_volumes = 19;
| Type | Description |
| List<? extends com.google.cloud.functions.v2.SecretVolumeOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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) = { ... }
| Type | Description |
| String | The service.
|
getServiceAccountEmail()
public 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;
| Type | Description |
| String | The serviceAccountEmail.
|
getServiceAccountEmailBytes()
public 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;
| 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) = { ... }
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;
| Type | Description |
| int | The timeoutSeconds.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUri()
Output only. URI of the Service deployed.
string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUriBytes()
public ByteString getUriBytes()
Output only. URI of the Service deployed.
string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
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) = { ... }
| 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) = { ... }
| 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;
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;
| Type | Description |
| int | The enum numeric value on the wire for vpcConnectorEgressSettings.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ServiceConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ServiceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ServiceConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
