Class protos.google.cloud.osconfig.v1.OSPolicy.Resource (2.1.2)

Represents a Resource.

Package

@google-cloud/os-config

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.osconfig.v1.OSPolicy.IResource);

Constructs a new Resource.

Parameter
NameDescription
properties IResource

Properties to set

Properties

exec

public exec?: (google.cloud.osconfig.v1.OSPolicy.Resource.IExecResource|null);

Resource exec.

file

public file?: (google.cloud.osconfig.v1.OSPolicy.Resource.IFileResource|null);

Resource file.

id

public id: string;

Resource id.

pkg

public pkg?: (google.cloud.osconfig.v1.OSPolicy.Resource.IPackageResource|null);

Resource pkg.

repository

public repository?: (google.cloud.osconfig.v1.OSPolicy.Resource.IRepositoryResource|null);

Resource repository.

resourceType

public resourceType?: ("pkg"|"repository"|"exec"|"file");

Resource resourceType.

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1.OSPolicy.IResource): google.cloud.osconfig.v1.OSPolicy.Resource;

Creates a new Resource instance using the specified properties.

Parameter
NameDescription
properties IResource

Properties to set

Returns
TypeDescription
google.cloud.osconfig.v1.OSPolicy.Resource

Resource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.osconfig.v1.OSPolicy.Resource;

Decodes a Resource message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.osconfig.v1.OSPolicy.Resource

Resource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.osconfig.v1.OSPolicy.Resource;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.osconfig.v1.OSPolicy.Resource

Resource

encode(message, writer)

public static encode(message: google.cloud.osconfig.v1.OSPolicy.IResource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Resource message. Does not implicitly messages.

Parameters
NameDescription
message IResource

Resource message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.osconfig.v1.OSPolicy.IResource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IResource

Resource message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.osconfig.v1.OSPolicy.Resource;

Creates a Resource message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.osconfig.v1.OSPolicy.Resource

Resource

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Resource

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Resource to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.osconfig.v1.OSPolicy.Resource

Resource

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Resource message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not