Reference documentation and code samples for the Google Cloud Functions V2 Client class ServiceConfig.
Describes the Service being deployed.
Currently Supported : Cloud Run (fully managed). Next tag: 23
Generated from protobuf message google.cloud.functions.v2.ServiceConfig
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ service
string
Output only. Name of the service associated with a Function. The format of this field is projects/{project}/locations/{region}/services/{service}
↳ timeout_seconds
int
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.
↳ available_memory
string
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.
↳ available_cpu
string
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
↳ environment_variables
array| Google\Protobuf\Internal\MapField
Environment variables that shall be available during function execution.
↳ max_instance_count
int
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.
↳ min_instance_count
int
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.
↳ vpc_connector
string
The Serverless VPC Access connector that this cloud function can connect to. The format of this field is projects/*/locations/*/connectors/*
.
↳ vpc_connector_egress_settings
int
The egress settings for the connector, controlling what traffic is diverted through it.
↳ ingress_settings
int
The ingress settings for the function, controlling what traffic can reach it.
↳ uri
string
Output only. URI of the Service deployed.
↳ service_account_email
string
The email of the service's service account. If empty, defaults to {project_number}-compute@developer.gserviceaccount.com
.
↳ all_traffic_on_latest_revision
bool
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.
↳ secret_environment_variables
↳ secret_volumes
↳ revision
string
Output only. The name of service revision.
↳ max_instance_request_concurrency
int
Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
↳ security_level
int
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.
getService
Output only. Name of the service associated with a Function.
The format of this field is projects/{project}/locations/{region}/services/{service}
string
setService
Output only. Name of the service associated with a Function.
The format of this field is projects/{project}/locations/{region}/services/{service}
var
string
$this
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.
int
setTimeoutSeconds
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.
var
int
$this
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
setAvailableMemory
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.
var
string
$this
getAvailableCpu
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
setAvailableCpu
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
var
string
$this
getEnvironmentVariables
Environment variables that shall be available during function execution.
setEnvironmentVariables
Environment variables that shall be available during function execution.
$this
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.
int
setMaxInstanceCount
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.
var
int
$this
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.
int
setMinInstanceCount
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.
var
int
$this
getVpcConnector
The Serverless VPC Access connector that this cloud function can connect
to. The format of this field is projects/*/locations/*/connectors/*
.
string
setVpcConnector
The Serverless VPC Access connector that this cloud function can connect
to. The format of this field is projects/*/locations/*/connectors/*
.
var
string
$this
getVpcConnectorEgressSettings
The egress settings for the connector, controlling what traffic is diverted through it.
int
setVpcConnectorEgressSettings
The egress settings for the connector, controlling what traffic is diverted through it.
var
int
$this
getIngressSettings
The ingress settings for the function, controlling what traffic can reach it.
int
setIngressSettings
The ingress settings for the function, controlling what traffic can reach it.
var
int
$this
getUri
Output only. URI of the Service deployed.
string
setUri
Output only. URI of the Service deployed.
var
string
$this
getServiceAccountEmail
The email of the service's service account. If empty, defaults to {project_number}-compute@developer.gserviceaccount.com
.
string
setServiceAccountEmail
The email of the service's service account. If empty, defaults to {project_number}-compute@developer.gserviceaccount.com
.
var
string
$this
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
setAllTrafficOnLatestRevision
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.
var
bool
$this
getSecretEnvironmentVariables
Secret environment variables configuration.
setSecretEnvironmentVariables
Secret environment variables configuration.
$this
getSecretVolumes
Secret volumes configuration.
setSecretVolumes
Secret volumes configuration.
$this
getRevision
Output only. The name of service revision.
string
setRevision
Output only. The name of service revision.
var
string
$this
getMaxInstanceRequestConcurrency
Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
int
setMaxInstanceRequestConcurrency
Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
var
int
$this
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.
int
setSecurityLevel
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.
var
int
$this
