Class protos.google.iam.v3.OperationMetadata (2.2.0)

Represents an OperationMetadata.

Package

@google-cloud/iam

Constructors

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 iam 
 . 
 v3 
 . 
 IOperationMetadata 
 ); 
 

Constructs a new OperationMetadata.

Parameter
Name
Description
properties
IOperationMetadata

Properties to set

Properties

  public 
  
 apiVersion 
 : 
  
 string 
 ; 
 

OperationMetadata apiVersion.

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

OperationMetadata createTime.

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

OperationMetadata endTime.

  public 
  
 requestedCancellation 
 : 
  
 boolean 
 ; 
 

OperationMetadata requestedCancellation.

  public 
  
 statusMessage 
 : 
  
 string 
 ; 
 

OperationMetadata statusMessage.

  public 
  
 target 
 : 
  
 string 
 ; 
 

OperationMetadata target.

  public 
  
 verb 
 : 
  
 string 
 ; 
 

OperationMetadata verb.

Methods

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 iam 
 . 
 v3 
 . 
 IOperationMetadata 
 ) 
 : 
  
 google 
 . 
 iam 
 . 
 v3 
 . 
 OperationMetadata 
 ; 
 

Creates a new OperationMetadata instance using the specified properties.

Parameter
Name
Description
properties
IOperationMetadata

Properties to set

Returns
Type
Description

OperationMetadata instance

  public 
  
 static 
  
 decode 
 ( 
 reader 
 : 
  
 ( 
 $protobuf 
 . 
 Reader 
 | 
 Uint8Array 
 ), 
  
 length 
 ?: 
  
 number 
 ) 
 : 
  
 google 
 . 
 iam 
 . 
 v3 
 . 
 OperationMetadata 
 ; 
 

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

OperationMetadata

  public 
  
 static 
  
 decodeDelimited 
 ( 
 reader 
 : 
  
 ( 
 $protobuf 
 . 
 Reader 
 | 
 Uint8Array 
 )) 
 : 
  
 google 
 . 
 iam 
 . 
 v3 
 . 
 OperationMetadata 
 ; 
 

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

Parameter
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type
Description

OperationMetadata

  public 
  
 static 
  
 encode 
 ( 
 message 
 : 
  
 google 
 . 
 iam 
 . 
 v3 
 . 
 IOperationMetadata 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

Encodes the specified OperationMetadata message. Does not implicitly messages.

Parameters
Name
Description
message
IOperationMetadata

OperationMetadata message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

  public 
  
 static 
  
 encodeDelimited 
 ( 
 message 
 : 
  
 google 
 . 
 iam 
 . 
 v3 
 . 
 IOperationMetadata 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

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

Parameters
Name
Description
message
IOperationMetadata

OperationMetadata message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

  public 
  
 static 
  
 fromObject 
 ( 
 object 
 : 
  
 { 
  
 [ 
 k 
 : 
  
 string 
 ] 
 : 
  
 any 
  
 }) 
 : 
  
 google 
 . 
 iam 
 . 
 v3 
 . 
 OperationMetadata 
 ; 
 

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

OperationMetadata

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

Gets the default type url for OperationMetadata

Parameter
Name
Description
typeUrlPrefix
string

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

Returns
Type
Description
string

The default type url

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

Converts this OperationMetadata to JSON.

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

JSON object

  public 
  
 static 
  
 toObject 
 ( 
 message 
 : 
  
 google 
 . 
 iam 
 . 
 v3 
 . 
 OperationMetadata 
 , 
  
 options 
 ?: 
  
 $protobuf 
 . 
 IConversionOptions 
 ) 
 : 
  
 { 
  
 [ 
 k 
 : 
  
 string 
 ] 
 : 
  
 any 
  
 }; 
 

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

Parameters
Name
Description
message
OperationMetadata

OperationMetadata

options
$protobuf.IConversionOptions

Conversion options

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

Plain object

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

Verifies an OperationMetadata 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: