Class protos.google.api.ResourceDescriptor (2.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
Represents a ResourceDescriptor.
Package
@google-cloud/gke-backupConstructors
(constructor)(properties)
constructor(properties?:google.api.IResourceDescriptor);Constructs a new ResourceDescriptor.
| Parameter | |
|---|---|
| Name | Description |
properties |
IResourceDescriptor
Properties to set |
Properties
history
publichistory:(google.api.ResourceDescriptor.History|keyoftypeofgoogle.api.ResourceDescriptor.History);ResourceDescriptor history.
nameField
publicnameField:string;ResourceDescriptor nameField.
pattern
publicpattern:string[];ResourceDescriptor pattern.
plural
publicplural:string;ResourceDescriptor plural.
singular
publicsingular:string;ResourceDescriptor singular.
style
publicstyle:google.api.ResourceDescriptor.Style[];ResourceDescriptor style.
type
publictype:string;ResourceDescriptor type.
Methods
create(properties)
publicstaticcreate(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)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.api.ResourceDescriptor;Decodes a ResourceDescriptor 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 |
ResourceDescriptor |
ResourceDescriptor |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.api.ResourceDescriptor;Decodes a ResourceDescriptor message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ResourceDescriptor |
ResourceDescriptor |
encode(message, writer)
publicstaticencode(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)
publicstaticencodeDelimited(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)
publicstaticfromObject(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 |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for ResourceDescriptor
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this ResourceDescriptor to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
publicstatictoObject(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)
publicstaticverify(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) |
|