Class google.api.ResourceDescriptor (2.1.1)

Represents a ResourceDescriptor.

Package

@google-cloud/scheduler!

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 api 
 . 
 IResourceDescriptor 
 );

Constructs a new ResourceDescriptor.

Parameter

Name	Description
properties	`IResourceDescriptor` Properties to set

Properties

history

  public 
  
 history 
 : 
  
 ( 
 google 
 . 
 api 
 . 
 ResourceDescriptor 
 . 
 History 
 | 
 keyof 
  
 typeof 
  
 google 
 . 
 api 
 . 
 ResourceDescriptor 
 . 
 History 
 );

ResourceDescriptor history.

Property Value

Type	Description
( google.api.ResourceDescriptor.History \|keyof typeof google.api.ResourceDescriptor.History )

nameField

  public 
  
 nameField 
 : 
  
 string 
 ;

ResourceDescriptor nameField.

Property Value

Type	Description
string

pattern

  public 
  
 pattern 
 : 
  
 string 
 [];

ResourceDescriptor pattern.

Property Value

Type	Description
string[]

plural

  public 
  
 plural 
 : 
  
 string 
 ;

ResourceDescriptor plural.

Property Value

Type	Description
string

singular

  public 
  
 singular 
 : 
  
 string 
 ;

ResourceDescriptor singular.

Property Value

Type	Description
string

type

  public 
  
 type 
 : 
  
 string 
 ;

ResourceDescriptor type.

Property Value

Type	Description
string

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 api 
 . 
 IResourceDescriptor 
 ) 
 : 
  
 google 
 . 
 api 
 . 
 ResourceDescriptor 
 ;

Creates a new ResourceDescriptor instance using the specified properties.

Parameter

Name	Description
properties	`IResourceDescriptor` Properties to set

Returns

Type	Description
ResourceDescriptor	ResourceDescriptor instance

decode(reader, length)

  public 
  
 static 
  
 decode 
 ( 
 reader 
 : 
  
 ( 
 $protobuf 
 . 
 Reader 
 | 
 Uint8Array 
 ), 
  
 length 
 ?: 
  
 number 
 ) 
 : 
  
 google 
 . 
 api 
 . 
 ResourceDescriptor 
 ;

Decodes a ResourceDescriptor 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
ResourceDescriptor	ResourceDescriptor

decodeDelimited(reader)

  public 
  
 static 
  
 decodeDelimited 
 ( 
 reader 
 : 
  
 ( 
 $protobuf 
 . 
 Reader 
 | 
 Uint8Array 
 )) 
 : 
  
 google 
 . 
 api 
 . 
 ResourceDescriptor 
 ;

Decodes a ResourceDescriptor 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
ResourceDescriptor	ResourceDescriptor

encode(message, writer)

  public 
  
 static 
  
 encode 
 ( 
 message 
 : 
  
 google 
 . 
 api 
 . 
 IResourceDescriptor 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ;

Encodes the specified ResourceDescriptor message. Does not implicitly messages.

Parameters

Name	Description
message	`IResourceDescriptor` ResourceDescriptor 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 
 . 
 api 
 . 
 IResourceDescriptor 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ;

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

Parameters

Name	Description
message	`IResourceDescriptor` ResourceDescriptor 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 
 . 
 api 
 . 
 ResourceDescriptor 
 ;

Creates a ResourceDescriptor 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
ResourceDescriptor	ResourceDescriptor

toJSON()

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

Converts this ResourceDescriptor to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`ResourceDescriptor` ResourceDescriptor
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 ResourceDescriptor 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

Class google.api.ResourceDescriptor (2.1.1) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(properties)

Properties

history

nameField

pattern

plural

singular

type

Methods

create(properties)

decode(reader, length)

decodeDelimited(reader)

encode(message, writer)

encodeDelimited(message, writer)

fromObject(object)

toJSON()

toObject(message, options)

verify(message)

Class google.api.ResourceDescriptor (2.1.1)