Show / Hide Table of Contents

Class ServiceConfig

Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).

Inheritance
object
ServiceConfig
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudFunctions.v2beta.Data
Assembly: Google.Apis.CloudFunctions.v2beta.dll
Syntax
public class ServiceConfig : IDirectResponseSchema

Properties

AllTrafficOnLatestRevision

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.

Declaration
[JsonProperty("allTrafficOnLatestRevision")]
public virtual bool? AllTrafficOnLatestRevision { get; set; }
Property Value
Type Description
bool?

AvailableCpu

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

Declaration
[JsonProperty("availableCpu")]
public virtual string AvailableCpu { get; set; }
Property Value
Type Description
string

AvailableMemory

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.

Declaration
[JsonProperty("availableMemory")]
public virtual string AvailableMemory { get; set; }
Property Value
Type Description
string

BinaryAuthorizationPolicy

Optional. The binary authorization policy to be checked when deploying the Cloud Run service.

Declaration
[JsonProperty("binaryAuthorizationPolicy")]
public virtual string BinaryAuthorizationPolicy { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnvironmentVariables

Environment variables that shall be available during function execution.

Declaration
[JsonProperty("environmentVariables")]
public virtual IDictionary<string, string> EnvironmentVariables { get; set; }
Property Value
Type Description
IDictionary<string, string>

IngressSettings

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

Declaration
[JsonProperty("ingressSettings")]
public virtual string IngressSettings { get; set; }
Property Value
Type Description
string

MaxInstanceCount

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.

Declaration
[JsonProperty("maxInstanceCount")]
public virtual int? MaxInstanceCount { get; set; }
Property Value
Type Description
int?

MaxInstanceRequestConcurrency

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

Declaration
[JsonProperty("maxInstanceRequestConcurrency")]
public virtual int? MaxInstanceRequestConcurrency { get; set; }
Property Value
Type Description
int?

MinInstanceCount

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.

Declaration
[JsonProperty("minInstanceCount")]
public virtual int? MinInstanceCount { get; set; }
Property Value
Type Description
int?

Revision

Output only. The name of service revision.

Declaration
[JsonProperty("revision")]
public virtual string Revision { get; set; }
Property Value
Type Description
string

SecretEnvironmentVariables

Secret environment variables configuration.

Declaration
[JsonProperty("secretEnvironmentVariables")]
public virtual IList<SecretEnvVar> SecretEnvironmentVariables { get; set; }
Property Value
Type Description
IList<SecretEnvVar>

SecretVolumes

Secret volumes configuration.

Declaration
[JsonProperty("secretVolumes")]
public virtual IList<SecretVolume> SecretVolumes { get; set; }
Property Value
Type Description
IList<SecretVolume>

SecurityLevel

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.

Declaration
[JsonProperty("securityLevel")]
public virtual string SecurityLevel { get; set; }
Property Value
Type Description
string

Service

Output only. Name of the service associated with a Function. The format of this field is projects/{project}/locations/{region}/services/{service}

Declaration
[JsonProperty("service")]
public virtual string Service { get; set; }
Property Value
Type Description
string

ServiceAccountEmail

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

Declaration
[JsonProperty("serviceAccountEmail")]
public virtual string ServiceAccountEmail { get; set; }
Property Value
Type Description
string

TimeoutSeconds

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.

Declaration
[JsonProperty("timeoutSeconds")]
public virtual int? TimeoutSeconds { get; set; }
Property Value
Type Description
int?

Uri

Output only. URI of the Service deployed.

Declaration
[JsonProperty("uri")]
public virtual string Uri { get; set; }
Property Value
Type Description
string

VpcConnector

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

Declaration
[JsonProperty("vpcConnector")]
public virtual string VpcConnector { get; set; }
Property Value
Type Description
string

VpcConnectorEgressSettings

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

Declaration
[JsonProperty("vpcConnectorEgressSettings")]
public virtual string VpcConnectorEgressSettings { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX