Class protos.google.cloud.run.v2.Instance (3.2.0)

Represents an Instance.

Package

@google-cloud/run

Constructors

(constructor)(properties)

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

Constructs a new Instance.

Parameter
Name
Description
properties
IInstance

Properties to set

Properties

annotations

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

Instance annotations.

binaryAuthorization

  public 
  
 binaryAuthorization 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IBinaryAuthorization 
 | 
 null 
 ); 
 

Instance binaryAuthorization.

client

  public 
  
 client 
 : 
  
 string 
 ; 
 

Instance client.

clientVersion

  public 
  
 clientVersion 
 : 
  
 string 
 ; 
 

Instance clientVersion.

conditions

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

Instance conditions.

containers

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

Instance containers.

containerStatuses

  public 
  
 containerStatuses 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IContainerStatus 
 []; 
 

Instance containerStatuses.

createTime

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

Instance createTime.

creator

  public 
  
 creator 
 : 
  
 string 
 ; 
 

Instance creator.

deleteTime

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

Instance deleteTime.

description

  public 
  
 description 
 : 
  
 string 
 ; 
 

Instance description.

encryptionKey

  public 
  
 encryptionKey 
 : 
  
 string 
 ; 
 

Instance encryptionKey.

encryptionKeyRevocationAction

  public 
  
 encryptionKeyRevocationAction 
 : 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 EncryptionKeyRevocationAction 
 | 
 keyof 
  
 typeof 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 EncryptionKeyRevocationAction 
 ); 
 

Instance encryptionKeyRevocationAction.

encryptionKeyShutdownDuration

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

Instance encryptionKeyShutdownDuration.

etag

  public 
  
 etag 
 : 
  
 string 
 ; 
 

Instance etag.

expireTime

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

Instance expireTime.

generation

  public 
  
 generation 
 : 
  
 ( 
 number 
 | 
 Long 
 | 
 string 
 ); 
 

Instance generation.

gpuZonalRedundancyDisabled

  public 
  
 gpuZonalRedundancyDisabled 
 ?: 
  
 ( 
 boolean 
 | 
 null 
 ); 
 

Instance gpuZonalRedundancyDisabled.

iapEnabled

  public 
  
 iapEnabled 
 : 
  
 boolean 
 ; 
 

Instance iapEnabled.

ingress

  public 
  
 ingress 
 : 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IngressTraffic 
 | 
 keyof 
  
 typeof 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IngressTraffic 
 ); 
 

Instance ingress.

invokerIamDisabled

  public 
  
 invokerIamDisabled 
 : 
  
 boolean 
 ; 
 

Instance invokerIamDisabled.

labels

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

Instance labels.

lastModifier

  public 
  
 lastModifier 
 : 
  
 string 
 ; 
 

Instance lastModifier.

launchStage

  public 
  
 launchStage 
 : 
  
 ( 
 google 
 . 
 api 
 . 
 LaunchStage 
 | 
 keyof 
  
 typeof 
  
 google 
 . 
 api 
 . 
 LaunchStage 
 ); 
 

Instance launchStage.

logUri

  public 
  
 logUri 
 : 
  
 string 
 ; 
 

Instance logUri.

name

  public 
  
 name 
 : 
  
 string 
 ; 
 

Instance name.

nodeSelector

  public 
  
 nodeSelector 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 INodeSelector 
 | 
 null 
 ); 
 

Instance nodeSelector.

observedGeneration

  public 
  
 observedGeneration 
 : 
  
 ( 
 number 
 | 
 Long 
 | 
 string 
 ); 
 

Instance observedGeneration.

reconciling

  public 
  
 reconciling 
 : 
  
 boolean 
 ; 
 

Instance reconciling.

satisfiesPzs

  public 
  
 satisfiesPzs 
 : 
  
 boolean 
 ; 
 

Instance satisfiesPzs.

serviceAccount

  public 
  
 serviceAccount 
 : 
  
 string 
 ; 
 

Instance serviceAccount.

terminalCondition

  public 
  
 terminalCondition 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ICondition 
 | 
 null 
 ); 
 

Instance terminalCondition.

uid

  public 
  
 uid 
 : 
  
 string 
 ; 
 

Instance uid.

updateTime

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

Instance updateTime.

urls

  public 
  
 urls 
 : 
  
 string 
 []; 
 

Instance urls.

volumes

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

Instance volumes.

vpcAccess

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

Instance vpcAccess.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IInstance 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Instance 
 ; 
 

Creates a new Instance instance using the specified properties.

Parameter
Name
Description
properties
IInstance

Properties to set

Returns
Type
Description

Instance instance

decode(reader, length)

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

Decodes an Instance 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

Instance

decodeDelimited(reader)

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

Decodes an Instance message from the specified reader or buffer, length delimited.

Parameter
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type
Description

Instance

encode(message, writer)

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

Encodes the specified Instance message. Does not implicitly messages.

Parameters
Name
Description
message
IInstance

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

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

Parameters
Name
Description
message
IInstance

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

Creates an Instance 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

Instance

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Instance

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name
Description
message
Instance

Instance

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 an Instance 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

Create a Mobile Website
View Site in Mobile | Classic
Share by: