Step

google.cloud.osconfig.v1beta.SoftwareRecipe. Step

Represents a Step.

Constructor

new Step(propertiesopt)

Constructs a new Step.

Parameters:
Name Type Attributes Description
properties google.cloud.osconfig.v1beta.SoftwareRecipe.IStep <optional>

Properties to set

Implements:
  • IStep

Classes

CopyFile
ExecFile
ExtractArchive
InstallDpkg
InstallMsi
InstallRpm
RunScript

Members

archiveExtraction

Step archiveExtraction.

dpkgInstallation

Step dpkgInstallation.

fileCopy

Step fileCopy.

fileExec

Step fileExec.

msiInstallation

Step msiInstallation.

rpmInstallation

Step rpmInstallation.

scriptRun

Step scriptRun.

step

Step step.

Methods

toJSON() → {Object.<string, *>}

Converts this Step to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.osconfig.v1beta.SoftwareRecipe.Step}

Creates a new Step instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.osconfig.v1beta.SoftwareRecipe.IStep <optional>

Properties to set

Returns:
Type Description
google.cloud.osconfig.v1beta.SoftwareRecipe.Step

Step instance

(static) decode(reader, lengthopt) → {google.cloud.osconfig.v1beta.SoftwareRecipe.Step}

Decodes a Step message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.osconfig.v1beta.SoftwareRecipe.Step

Step

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.osconfig.v1beta.SoftwareRecipe.Step}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.osconfig.v1beta.SoftwareRecipe.Step

Step

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Step message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.osconfig.v1beta.SoftwareRecipe.IStep

Step message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.osconfig.v1beta.SoftwareRecipe.IStep

Step message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.osconfig.v1beta.SoftwareRecipe.Step}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.osconfig.v1beta.SoftwareRecipe.Step

Step

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Step

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.osconfig.v1beta.SoftwareRecipe.Step

Step

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Step message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not