Class protos.google.cloud.kms.inventory.v1.ProtectedResource (2.6.0)

Represents a ProtectedResource.

Package

@google-cloud/kms-inventory

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.kms.inventory.v1.IProtectedResource);

Constructs a new ProtectedResource.

Parameter
Name Description
properties IProtectedResource

Properties to set

Properties

cloudProduct

public cloudProduct: string;

ProtectedResource cloudProduct.

createTime

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

ProtectedResource createTime.

cryptoKeyVersion

public cryptoKeyVersion: string;

ProtectedResource cryptoKeyVersion.

cryptoKeyVersions

public cryptoKeyVersions: string[];

ProtectedResource cryptoKeyVersions.

labels

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

ProtectedResource labels.

location

public location: string;

ProtectedResource location.

name

public name: string;

ProtectedResource name.

project

public project: string;

ProtectedResource project.

projectId

public projectId: string;

ProtectedResource projectId.

resourceType

public resourceType: string;

ProtectedResource resourceType.

Methods

create(properties)

public static create(properties?: google.cloud.kms.inventory.v1.IProtectedResource): google.cloud.kms.inventory.v1.ProtectedResource;

Creates a new ProtectedResource instance using the specified properties.

Parameter
Name Description
properties IProtectedResource

Properties to set

Returns
Type Description
ProtectedResource

ProtectedResource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.kms.inventory.v1.ProtectedResource;

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

ProtectedResource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.kms.inventory.v1.ProtectedResource;

Decodes a ProtectedResource message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ProtectedResource

ProtectedResource

encode(message, writer)

public static encode(message: google.cloud.kms.inventory.v1.IProtectedResource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ProtectedResource message. Does not implicitly messages.

Parameters
Name Description
message IProtectedResource

ProtectedResource 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.kms.inventory.v1.IProtectedResource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IProtectedResource

ProtectedResource 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.kms.inventory.v1.ProtectedResource;

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

ProtectedResource

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ProtectedResource

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

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.kms.inventory.v1.ProtectedResource, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message ProtectedResource

ProtectedResource

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 ProtectedResource 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