Class protos.google.cloud.functions.v2.ServiceConfig (3.3.0)

Represents a ServiceConfig.

Package

@google-cloud/functions

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.functions.v2.IServiceConfig);

Constructs a new ServiceConfig.

Parameter
NameDescription
properties IServiceConfig

Properties to set

Properties

allTrafficOnLatestRevision

public allTrafficOnLatestRevision: boolean;

ServiceConfig allTrafficOnLatestRevision.

availableCpu

public availableCpu: string;

ServiceConfig availableCpu.

availableMemory

public availableMemory: string;

ServiceConfig availableMemory.

environmentVariables

public environmentVariables: { [k: string]: string };

ServiceConfig environmentVariables.

ingressSettings

public ingressSettings: (google.cloud.functions.v2.ServiceConfig.IngressSettings|keyof typeof google.cloud.functions.v2.ServiceConfig.IngressSettings);

ServiceConfig ingressSettings.

maxInstanceCount

public maxInstanceCount: number;

ServiceConfig maxInstanceCount.

maxInstanceRequestConcurrency

public maxInstanceRequestConcurrency: number;

ServiceConfig maxInstanceRequestConcurrency.

minInstanceCount

public minInstanceCount: number;

ServiceConfig minInstanceCount.

revision

public revision: string;

ServiceConfig revision.

secretEnvironmentVariables

public secretEnvironmentVariables: google.cloud.functions.v2.ISecretEnvVar[];

ServiceConfig secretEnvironmentVariables.

secretVolumes

public secretVolumes: google.cloud.functions.v2.ISecretVolume[];

ServiceConfig secretVolumes.

securityLevel

public securityLevel: (google.cloud.functions.v2.ServiceConfig.SecurityLevel|keyof typeof google.cloud.functions.v2.ServiceConfig.SecurityLevel);

ServiceConfig securityLevel.

service

public service: string;

ServiceConfig service.

serviceAccountEmail

public serviceAccountEmail: string;

ServiceConfig serviceAccountEmail.

timeoutSeconds

public timeoutSeconds: number;

ServiceConfig timeoutSeconds.

uri

public uri: string;

ServiceConfig uri.

vpcConnector

public vpcConnector: string;

ServiceConfig vpcConnector.

vpcConnectorEgressSettings

public vpcConnectorEgressSettings: (google.cloud.functions.v2.ServiceConfig.VpcConnectorEgressSettings|keyof typeof google.cloud.functions.v2.ServiceConfig.VpcConnectorEgressSettings);

ServiceConfig vpcConnectorEgressSettings.

Methods

create(properties)

public static create(properties?: google.cloud.functions.v2.IServiceConfig): google.cloud.functions.v2.ServiceConfig;

Creates a new ServiceConfig instance using the specified properties.

Parameter
NameDescription
properties IServiceConfig

Properties to set

Returns
TypeDescription
ServiceConfig

ServiceConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.functions.v2.ServiceConfig;

Decodes a ServiceConfig message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
ServiceConfig

ServiceConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.functions.v2.ServiceConfig;

Decodes a ServiceConfig message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ServiceConfig

ServiceConfig

encode(message, writer)

public static encode(message: google.cloud.functions.v2.IServiceConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ServiceConfig message. Does not implicitly messages.

Parameters
NameDescription
message IServiceConfig

ServiceConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.functions.v2.IServiceConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ServiceConfig message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IServiceConfig

ServiceConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.functions.v2.ServiceConfig;

Creates a ServiceConfig message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
ServiceConfig

ServiceConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ServiceConfig

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this ServiceConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.functions.v2.ServiceConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ServiceConfig message. Also converts values to other types if specified.

Parameters
NameDescription
message ServiceConfig

ServiceConfig

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a ServiceConfig message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not