Class PatchJobs.ExecStepConfig (2.25.0)

public static final class PatchJobs.ExecStepConfig extends GeneratedMessageV3 implements PatchJobs.ExecStepConfigOrBuilder

Common configurations for an ExecStep.

Protobuf type google.cloud.osconfig.v1.ExecStepConfig

Static Fields

ALLOWED_SUCCESS_CODES_FIELD_NUMBER

public static final int ALLOWED_SUCCESS_CODES_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_OBJECT_FIELD_NUMBER

public static final int GCS_OBJECT_FIELD_NUMBER
Field Value
TypeDescription
int

INTERPRETER_FIELD_NUMBER

public static final int INTERPRETER_FIELD_NUMBER
Field Value
TypeDescription
int

LOCAL_PATH_FIELD_NUMBER

public static final int LOCAL_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PatchJobs.ExecStepConfig getDefaultInstance()
Returns
TypeDescription
PatchJobs.ExecStepConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PatchJobs.ExecStepConfig.Builder newBuilder()
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

newBuilder(PatchJobs.ExecStepConfig prototype)

public static PatchJobs.ExecStepConfig.Builder newBuilder(PatchJobs.ExecStepConfig prototype)
Parameter
NameDescription
prototypePatchJobs.ExecStepConfig
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

parseDelimitedFrom(InputStream input)

public static PatchJobs.ExecStepConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PatchJobs.ExecStepConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PatchJobs.ExecStepConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PatchJobs.ExecStepConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PatchJobs.ExecStepConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PatchJobs.ExecStepConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.ExecStepConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PatchJobs.ExecStepConfig> parser()
Returns
TypeDescription
Parser<ExecStepConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAllowedSuccessCodes(int index)

public int getAllowedSuccessCodes(int index)

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

repeated int32 allowed_success_codes = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
int

The allowedSuccessCodes at the given index.

getAllowedSuccessCodesCount()

public int getAllowedSuccessCodesCount()

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

repeated int32 allowed_success_codes = 3;

Returns
TypeDescription
int

The count of allowedSuccessCodes.

getAllowedSuccessCodesList()

public List<Integer> getAllowedSuccessCodesList()

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

repeated int32 allowed_success_codes = 3;

Returns
TypeDescription
List<Integer>

A list containing the allowedSuccessCodes.

getDefaultInstanceForType()

public PatchJobs.ExecStepConfig getDefaultInstanceForType()
Returns
TypeDescription
PatchJobs.ExecStepConfig

getExecutableCase()

public PatchJobs.ExecStepConfig.ExecutableCase getExecutableCase()
Returns
TypeDescription
PatchJobs.ExecStepConfig.ExecutableCase

getGcsObject()

public PatchJobs.GcsObject getGcsObject()

A Cloud Storage object containing the executable.

.google.cloud.osconfig.v1.GcsObject gcs_object = 2;

Returns
TypeDescription
PatchJobs.GcsObject

The gcsObject.

getGcsObjectOrBuilder()

public PatchJobs.GcsObjectOrBuilder getGcsObjectOrBuilder()

A Cloud Storage object containing the executable.

.google.cloud.osconfig.v1.GcsObject gcs_object = 2;

Returns
TypeDescription
PatchJobs.GcsObjectOrBuilder

getInterpreter()

public PatchJobs.ExecStepConfig.Interpreter getInterpreter()

The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines.

.google.cloud.osconfig.v1.ExecStepConfig.Interpreter interpreter = 4;

Returns
TypeDescription
PatchJobs.ExecStepConfig.Interpreter

The interpreter.

getInterpreterValue()

public int getInterpreterValue()

The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines.

.google.cloud.osconfig.v1.ExecStepConfig.Interpreter interpreter = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for interpreter.

getLocalPath()

public String getLocalPath()

An absolute path to the executable on the VM.

string local_path = 1;

Returns
TypeDescription
String

The localPath.

getLocalPathBytes()

public ByteString getLocalPathBytes()

An absolute path to the executable on the VM.

string local_path = 1;

Returns
TypeDescription
ByteString

The bytes for localPath.

getParserForType()

public Parser<PatchJobs.ExecStepConfig> getParserForType()
Returns
TypeDescription
Parser<ExecStepConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasGcsObject()

public boolean hasGcsObject()

A Cloud Storage object containing the executable.

.google.cloud.osconfig.v1.GcsObject gcs_object = 2;

Returns
TypeDescription
boolean

Whether the gcsObject field is set.

hasLocalPath()

public boolean hasLocalPath()

An absolute path to the executable on the VM.

string local_path = 1;

Returns
TypeDescription
boolean

Whether the localPath field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PatchJobs.ExecStepConfig.Builder newBuilderForType()
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchJobs.ExecStepConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PatchJobs.ExecStepConfig.Builder toBuilder()
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException