Represents a Resource.
Package
@google-cloud/configConstructors
(constructor)(properties)
constructor(properties?: google.cloud.config.v1.IResource);
Constructs a new Resource.
Parameter | |
---|---|
Name | Description |
properties |
IResource
Properties to set |
Properties
caiAssets
public caiAssets: { [k: string]: google.cloud.config.v1.IResourceCAIInfo };
Resource caiAssets.
intent
public intent: (google.cloud.config.v1.Resource.Intent|keyof typeof google.cloud.config.v1.Resource.Intent);
Resource intent.
name
public name: string;
Resource name.
state
public state: (google.cloud.config.v1.Resource.State|keyof typeof google.cloud.config.v1.Resource.State);
Resource state.
terraformInfo
public terraformInfo?: (google.cloud.config.v1.IResourceTerraformInfo|null);
Resource terraformInfo.
Methods
create(properties)
public static create(properties?: google.cloud.config.v1.IResource): google.cloud.config.v1.Resource;
Creates a new Resource instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IResource
Properties to set |
Returns | |
---|---|
Type | Description |
Resource | Resource instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.config.v1.Resource;
Decodes a Resource 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 |
Resource | Resource |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.config.v1.Resource;
Decodes a Resource message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Resource | Resource |
encode(message, writer)
public static encode(message: google.cloud.config.v1.IResource, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Resource message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IResource
Resource 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.config.v1.IResource, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Resource message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IResource
Resource 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.config.v1.Resource;
Creates a Resource 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 |
Resource | Resource |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Resource
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 Resource to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.config.v1.Resource, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Resource message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Resource
Resource |
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 Resource message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|