Class protos.google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep (2.2.2)

Represents a OSPolicyResourceConfigStep.

Package

@google-cloud/os-config

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.osconfig.v1alpha.IOSPolicyResourceConfigStep);

Constructs a new OSPolicyResourceConfigStep.

Parameter
NameDescription
properties IOSPolicyResourceConfigStep

Properties to set

Properties

errorMessage

public errorMessage: string;

OSPolicyResourceConfigStep errorMessage.

outcome

public outcome: (google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep.Outcome|keyof typeof google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep.Outcome);

OSPolicyResourceConfigStep outcome.

type

public type: (google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep.Type|keyof typeof google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep.Type);

OSPolicyResourceConfigStep type.

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1alpha.IOSPolicyResourceConfigStep): google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep;

Creates a new OSPolicyResourceConfigStep instance using the specified properties.

Parameter
NameDescription
properties IOSPolicyResourceConfigStep

Properties to set

Returns
TypeDescription
google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep

OSPolicyResourceConfigStep instance

decode(reader, length)

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

Decodes a OSPolicyResourceConfigStep 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.OSPolicyResourceConfigStep

OSPolicyResourceConfigStep

decodeDelimited(reader)

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

Decodes a OSPolicyResourceConfigStep 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.OSPolicyResourceConfigStep

OSPolicyResourceConfigStep

encode(message, writer)

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

Encodes the specified OSPolicyResourceConfigStep message. Does not implicitly messages.

Parameters
NameDescription
message IOSPolicyResourceConfigStep

OSPolicyResourceConfigStep 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.IOSPolicyResourceConfigStep, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IOSPolicyResourceConfigStep

OSPolicyResourceConfigStep 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.OSPolicyResourceConfigStep;

Creates a OSPolicyResourceConfigStep 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.OSPolicyResourceConfigStep

OSPolicyResourceConfigStep

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for OSPolicyResourceConfigStep

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.osconfig.v1alpha.OSPolicyResourceConfigStep

OSPolicyResourceConfigStep

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