Represents a TaskTemplate.
Package
@google-cloud/runConstructors
(constructor)(properties)
constructor(properties?: google.cloud.run.v2.ITaskTemplate);Constructs a new TaskTemplate.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITaskTemplate
Properties to set |
Properties
containers
public containers: google.cloud.run.v2.IContainer[];TaskTemplate containers.
encryptionKey
public encryptionKey: string;TaskTemplate encryptionKey.
executionEnvironment
public executionEnvironment: (google.cloud.run.v2.ExecutionEnvironment|keyof typeof google.cloud.run.v2.ExecutionEnvironment);TaskTemplate executionEnvironment.
maxRetries
public maxRetries?: (number|null);TaskTemplate maxRetries.
retries
public retries?: "maxRetries";TaskTemplate retries.
serviceAccount
public serviceAccount: string;TaskTemplate serviceAccount.
timeout
public timeout?: (google.protobuf.IDuration|null);TaskTemplate timeout.
volumes
public volumes: google.cloud.run.v2.IVolume[];TaskTemplate volumes.
vpcAccess
public vpcAccess?: (google.cloud.run.v2.IVpcAccess|null);TaskTemplate vpcAccess.
Methods
create(properties)
public static create(properties?: google.cloud.run.v2.ITaskTemplate): google.cloud.run.v2.TaskTemplate;Creates a new TaskTemplate instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITaskTemplate
Properties to set |
| Returns | |
|---|---|
| Type | Description |
TaskTemplate | TaskTemplate instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.run.v2.TaskTemplate;Decodes a TaskTemplate 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 |
TaskTemplate | TaskTemplate |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.run.v2.TaskTemplate;Decodes a TaskTemplate message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
TaskTemplate | TaskTemplate |
encode(message, writer)
public static encode(message: google.cloud.run.v2.ITaskTemplate, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TaskTemplate message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITaskTemplate
TaskTemplate 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.run.v2.ITaskTemplate, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TaskTemplate message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITaskTemplate
TaskTemplate 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.run.v2.TaskTemplate;Creates a TaskTemplate 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 |
TaskTemplate | TaskTemplate |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for TaskTemplate
| 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 TaskTemplate to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.run.v2.TaskTemplate, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a TaskTemplate message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
TaskTemplate
TaskTemplate |
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 TaskTemplate message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|