Google Cloud Functions V2 Client - Class ServiceConfig (1.5.0)

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

Generated from protobuf message google.cloud.functions.v2.ServiceConfig

Namespace

Google \ Cloud \ Functions \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
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

[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

↳ 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 array<Google\Cloud\Functions\V2\SecretEnvVar>

Secret environment variables configuration.

↳ secret_volumes array<Google\Cloud\Functions\V2\SecretVolume>

Secret volumes configuration.

↳ revision string

Output only. The name of service revision.

↳ max_instance_request_concurrency int

[Preview] 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}

Returns
TypeDescription
string

setService

Output only. Name of the service associated with a Function.

The format of this field is projects/{project}/locations/{region}/services/{service}

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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

Returns
TypeDescription
string

setAvailableCpu

[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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEnvironmentVariables

Environment variables that shall be available during function execution.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setEnvironmentVariables

Environment variables that shall be available during function execution.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getVpcConnector

The Serverless VPC Access connector that this cloud function can connect to. The format of this field is projects/*/locations/*/connectors/*.

Returns
TypeDescription
string

setVpcConnector

The Serverless VPC Access connector that this cloud function can connect to. The format of this field is projects/*/locations/*/connectors/*.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVpcConnectorEgressSettings

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

Returns
TypeDescription
int

setVpcConnectorEgressSettings

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getIngressSettings

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

Returns
TypeDescription
int

setIngressSettings

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getUri

Output only. URI of the Service deployed.

Returns
TypeDescription
string

setUri

Output only. URI of the Service deployed.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getServiceAccountEmail

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

Returns
TypeDescription
string

setServiceAccountEmail

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getSecretEnvironmentVariables

Secret environment variables configuration.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSecretEnvironmentVariables

Secret environment variables configuration.

Parameter
NameDescription
var array<Google\Cloud\Functions\V2\SecretEnvVar>
Returns
TypeDescription
$this

getSecretVolumes

Secret volumes configuration.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSecretVolumes

Secret volumes configuration.

Parameter
NameDescription
var array<Google\Cloud\Functions\V2\SecretVolume>
Returns
TypeDescription
$this

getRevision

Output only. The name of service revision.

Returns
TypeDescription
string

setRevision

Output only. The name of service revision.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMaxInstanceRequestConcurrency

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

Returns
TypeDescription
int

setMaxInstanceRequestConcurrency

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

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this