Represents a BuildConfig.
Package
@google-cloud/functionsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.functions.v2.IBuildConfig);Constructs a new BuildConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBuildConfig
Properties to set |
Properties
automaticUpdatePolicy
public automaticUpdatePolicy?: (google.cloud.functions.v2.IAutomaticUpdatePolicy|null);BuildConfig automaticUpdatePolicy.
build
public build: string;BuildConfig build.
dockerRegistry
public dockerRegistry: (google.cloud.functions.v2.BuildConfig.DockerRegistry|keyof typeof google.cloud.functions.v2.BuildConfig.DockerRegistry);BuildConfig dockerRegistry.
dockerRepository
public dockerRepository: string;BuildConfig dockerRepository.
entryPoint
public entryPoint: string;BuildConfig entryPoint.
environmentVariables
public environmentVariables: { [k: string]: string };BuildConfig environmentVariables.
onDeployUpdatePolicy
public onDeployUpdatePolicy?: (google.cloud.functions.v2.IOnDeployUpdatePolicy|null);BuildConfig onDeployUpdatePolicy.
runtime
public runtime: string;BuildConfig runtime.
runtimeUpdatePolicy
public runtimeUpdatePolicy?: ("automaticUpdatePolicy"|"onDeployUpdatePolicy");BuildConfig runtimeUpdatePolicy.
serviceAccount
public serviceAccount: string;BuildConfig serviceAccount.
source
public source?: (google.cloud.functions.v2.ISource|null);BuildConfig source.
sourceProvenance
public sourceProvenance?: (google.cloud.functions.v2.ISourceProvenance|null);BuildConfig sourceProvenance.
workerPool
public workerPool: string;BuildConfig workerPool.
Methods
create(properties)
public static create(properties?: google.cloud.functions.v2.IBuildConfig): google.cloud.functions.v2.BuildConfig;Creates a new BuildConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBuildConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BuildConfig |
BuildConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.functions.v2.BuildConfig;Decodes a BuildConfig message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
BuildConfig |
BuildConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.functions.v2.BuildConfig;Decodes a BuildConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BuildConfig |
BuildConfig |
encode(message, writer)
public static encode(message: google.cloud.functions.v2.IBuildConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BuildConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBuildConfig
BuildConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.functions.v2.IBuildConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BuildConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBuildConfig
BuildConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.functions.v2.BuildConfig;Creates a BuildConfig message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
BuildConfig |
BuildConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BuildConfig
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this BuildConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.functions.v2.BuildConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BuildConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BuildConfig
BuildConfig |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a BuildConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|