public sealed class ServiceConfig : IMessage<ServiceConfig>, IEquatable<ServiceConfig>, IDeepCloneable<ServiceConfig>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Functions v2 API class ServiceConfig.
Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).
Implements
IMessageServiceConfig, IEquatableServiceConfig, IDeepCloneableServiceConfig, IBufferMessage, IMessageNamespace
Google.Cloud.Functions.V2Assembly
Google.Cloud.Functions.V2.dll
Constructors
ServiceConfig()
public ServiceConfig()ServiceConfig(ServiceConfig)
public ServiceConfig(ServiceConfig other)| Parameter | |
|---|---|
| Name | Description |
other | ServiceConfig |
Properties
AllTrafficOnLatestRevision
public bool AllTrafficOnLatestRevision { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
AvailableCpu
public string AvailableCpu { get; set; }[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
| Property Value | |
|---|---|
| Type | Description |
string | |
AvailableMemory
public string AvailableMemory { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
EnvironmentVariables
public MapField<string, string> EnvironmentVariables { get; }Environment variables that shall be available during function execution.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
IngressSettings
public ServiceConfig.Types.IngressSettings IngressSettings { get; set; }The ingress settings for the function, controlling what traffic can reach it.
| Property Value | |
|---|---|
| Type | Description |
ServiceConfigTypesIngressSettings | |
MaxInstanceCount
public int MaxInstanceCount { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int | |
MaxInstanceRequestConcurrency
public int MaxInstanceRequestConcurrency { get; set; }[Preview] Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
| Property Value | |
|---|---|
| Type | Description |
int | |
MinInstanceCount
public int MinInstanceCount { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int | |
Revision
public string Revision { get; set; }Output only. The name of service revision.
| Property Value | |
|---|---|
| Type | Description |
string | |
SecretEnvironmentVariables
public RepeatedField<SecretEnvVar> SecretEnvironmentVariables { get; }Secret environment variables configuration.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldSecretEnvVar | |
SecretVolumes
public RepeatedField<SecretVolume> SecretVolumes { get; }Secret volumes configuration.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldSecretVolume | |
SecurityLevel
public ServiceConfig.Types.SecurityLevel SecurityLevel { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
ServiceConfigTypesSecurityLevel | |
Service
public string Service { get; set; }Output only. Name of the service associated with a Function.
The format of this field is
projects/{project}/locations/{region}/services/{service}
| Property Value | |
|---|---|
| Type | Description |
string | |
ServiceAccountEmail
public string ServiceAccountEmail { get; set; }The email of the service's service account. If empty, defaults to
{project_number}-compute@developer.gserviceaccount.com.
| Property Value | |
|---|---|
| Type | Description |
string | |
ServiceAsServiceName
public ServiceName ServiceAsServiceName { get; set; }ServiceName-typed view over the Service resource name property.
| Property Value | |
|---|---|
| Type | Description |
ServiceName | |
TimeoutSeconds
public int TimeoutSeconds { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int | |
Uri
public string Uri { get; set; }Output only. URI of the Service deployed.
| Property Value | |
|---|---|
| Type | Description |
string | |
VpcConnector
public string VpcConnector { get; set; }The Serverless VPC Access connector that this cloud function can connect
to. The format of this field is projects/*/locations/*/connectors/*.
| Property Value | |
|---|---|
| Type | Description |
string | |
VpcConnectorAsConnectorName
public ConnectorName VpcConnectorAsConnectorName { get; set; }ConnectorName-typed view over the VpcConnector resource name property.
| Property Value | |
|---|---|
| Type | Description |
ConnectorName | |
VpcConnectorEgressSettings
public ServiceConfig.Types.VpcConnectorEgressSettings VpcConnectorEgressSettings { get; set; }The egress settings for the connector, controlling what traffic is diverted through it.
| Property Value | |
|---|---|
| Type | Description |
ServiceConfigTypesVpcConnectorEgressSettings | |