Class protos.google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource (1.8.0)

Represents a FileResource.

Package

@google-cloud/os-config!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.osconfig.v1alpha.OSPolicy.Resource.IFileResource);

Constructs a new FileResource.

Parameter
NameDescription
properties IFileResource

Properties to set

Properties

content

public content?: (string|null);

FileResource content.

Property Value
TypeDescription
(string|null)

file

public file?: (google.cloud.osconfig.v1alpha.OSPolicy.Resource.IFile|null);

FileResource file.

Property Value
TypeDescription
(google.cloud.osconfig.v1alpha.OSPolicy.Resource.IFile|null)

path

public path: string;

FileResource path.

Property Value
TypeDescription
string

permissions

public permissions: string;

FileResource permissions.

Property Value
TypeDescription
string

source

public source?: ("file"|"content");

FileResource source.

Property Value
TypeDescription
("file"|"content")

state

public state: (google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource.DesiredState|keyof typeof google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource.DesiredState);

FileResource state.

Property Value
TypeDescription
(google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource.DesiredState|keyof typeof google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource.DesiredState)

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1alpha.OSPolicy.Resource.IFileResource): google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource;

Creates a new FileResource instance using the specified properties.

Parameter
NameDescription
properties IFileResource

Properties to set

Returns
TypeDescription
google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource

FileResource instance

decode(reader, length)

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

Decodes a FileResource 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.v1alpha.OSPolicy.Resource.FileResource

FileResource

decodeDelimited(reader)

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

Decodes a FileResource 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.v1alpha.OSPolicy.Resource.FileResource

FileResource

encode(message, writer)

public static encode(message: google.cloud.osconfig.v1alpha.OSPolicy.Resource.IFileResource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified FileResource message. Does not implicitly messages.

Parameters
NameDescription
message IFileResource

FileResource 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.v1alpha.OSPolicy.Resource.IFileResource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IFileResource

FileResource 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.v1alpha.OSPolicy.Resource.FileResource;

Creates a FileResource 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.v1alpha.OSPolicy.Resource.FileResource

FileResource

toJSON()

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

Converts this FileResource to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource

FileResource

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