Class protos.google.cloud.run.v2.Task (0.5.0)

Represents a Task.

Package

@google-cloud/run

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ITask 
 ); 
 

Constructs a new Task.

Parameter
Name
Description
properties
ITask

Properties to set

Properties

annotations

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

Task annotations.

completionTime

  public 
  
 completionTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Task completionTime.

conditions

  public 
  
 conditions 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ICondition 
 []; 
 

Task conditions.

containers

  public 
  
 containers 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IContainer 
 []; 
 

Task containers.

createTime

  public 
  
 createTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Task createTime.

deleteTime

  public 
  
 deleteTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Task deleteTime.

encryptionKey

  public 
  
 encryptionKey 
 : 
  
 string 
 ; 
 

Task encryptionKey.

etag

  public 
  
 etag 
 : 
  
 string 
 ; 
 

Task etag.

execution

  public 
  
 execution 
 : 
  
 string 
 ; 
 

Task execution.

executionEnvironment

  public 
  
 executionEnvironment 
 : 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ExecutionEnvironment 
 | 
 keyof 
  
 typeof 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ExecutionEnvironment 
 ); 
 

Task executionEnvironment.

expireTime

  public 
  
 expireTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Task expireTime.

generation

  public 
  
 generation 
 : 
  
 ( 
 number 
 | 
 Long 
 | 
 string 
 ); 
 

Task generation.

index

  public 
  
 index 
 : 
  
 number 
 ; 
 

Task index.

job

  public 
  
 job 
 : 
  
 string 
 ; 
 

Task job.

labels

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

Task labels.

lastAttemptResult

  public 
  
 lastAttemptResult 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ITaskAttemptResult 
 | 
 null 
 ); 
 

Task lastAttemptResult.

logUri

  public 
  
 logUri 
 : 
  
 string 
 ; 
 

Task logUri.

maxRetries

  public 
  
 maxRetries 
 : 
  
 number 
 ; 
 

Task maxRetries.

name

  public 
  
 name 
 : 
  
 string 
 ; 
 

Task name.

observedGeneration

  public 
  
 observedGeneration 
 : 
  
 ( 
 number 
 | 
 Long 
 | 
 string 
 ); 
 

Task observedGeneration.

reconciling

  public 
  
 reconciling 
 : 
  
 boolean 
 ; 
 

Task reconciling.

retried

  public 
  
 retried 
 : 
  
 number 
 ; 
 

Task retried.

satisfiesPzs

  public 
  
 satisfiesPzs 
 : 
  
 boolean 
 ; 
 

Task satisfiesPzs.

serviceAccount

  public 
  
 serviceAccount 
 : 
  
 string 
 ; 
 

Task serviceAccount.

startTime

  public 
  
 startTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Task startTime.

timeout

  public 
  
 timeout 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 IDuration 
 | 
 null 
 ); 
 

Task timeout.

uid

  public 
  
 uid 
 : 
  
 string 
 ; 
 

Task uid.

updateTime

  public 
  
 updateTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Task updateTime.

volumes

  public 
  
 volumes 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IVolume 
 []; 
 

Task volumes.

vpcAccess

  public 
  
 vpcAccess 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IVpcAccess 
 | 
 null 
 ); 
 

Task vpcAccess.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ITask 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Task 
 ; 
 

Creates a new Task instance using the specified properties.

Parameter
Name
Description
properties
ITask

Properties to set

Returns
Type
Description
google.cloud.run.v2.Task

Task instance

decode(reader, length)

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

Decodes a Task message from the specified reader or buffer.

Parameters
Name
Description
reader
($protobuf. Reader | Uint8Array )

Reader or buffer to decode from

length
number

Message length if known beforehand

Returns
Type
Description
google.cloud.run.v2.Task

Task

decodeDelimited(reader)

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

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

Parameter
Name
Description
reader
($protobuf. Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type
Description
google.cloud.run.v2.Task

Task

encode(message, writer)

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

Encodes the specified Task message. Does not implicitly messages.

Parameters
Name
Description
message
ITask

Task 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 
 . 
 ITask 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

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

Parameters
Name
Description
message
ITask

Task 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 
 . 
 Task 
 ; 
 

Creates a Task 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
google.cloud.run.v2.Task

Task

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Task

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 Task to JSON.

Returns
Type
Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name
Description
message
google.cloud.run.v2.Task

Task

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 Task message.

Parameter
Name
Description
message
{ [k: string]: any }

Plain object to verify

Returns
Type
Description
(string|null)

null if valid, otherwise the reason why it is not

Design a Mobile Site
View Site in Mobile | Classic
Share by: