Class PatchJobs.ExecStepConfig.Builder (2.31.0)

public static final class PatchJobs.ExecStepConfig.Builder extends GeneratedMessageV3.Builder<PatchJobs.ExecStepConfig.Builder> implements PatchJobs.ExecStepConfigOrBuilder

Common configurations for an ExecStep.

Protobuf type google.cloud.osconfig.v1.ExecStepConfig

Static Methods

getDescriptor()

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

Methods

addAllAllowedSuccessCodes(Iterable<? extends Integer> values)

public PatchJobs.ExecStepConfig.Builder addAllAllowedSuccessCodes(Iterable<? extends Integer> values)

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
valuesIterable<? extends java.lang.Integer>

The allowedSuccessCodes to add.

Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

This builder for chaining.

addAllowedSuccessCodes(int value)

public PatchJobs.ExecStepConfig.Builder addAllowedSuccessCodes(int value)

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
valueint

The allowedSuccessCodes to add.

Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PatchJobs.ExecStepConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides

build()

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

buildPartial()

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

clear()

public PatchJobs.ExecStepConfig.Builder clear()
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides

clearAllowedSuccessCodes()

public PatchJobs.ExecStepConfig.Builder clearAllowedSuccessCodes()

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
PatchJobs.ExecStepConfig.Builder

This builder for chaining.

clearExecutable()

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

clearField(Descriptors.FieldDescriptor field)

public PatchJobs.ExecStepConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides

clearGcsObject()

public PatchJobs.ExecStepConfig.Builder clearGcsObject()

A Cloud Storage object containing the executable.

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

Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

clearInterpreter()

public PatchJobs.ExecStepConfig.Builder clearInterpreter()

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.Builder

This builder for chaining.

clearLocalPath()

public PatchJobs.ExecStepConfig.Builder clearLocalPath()

An absolute path to the executable on the VM.

string local_path = 1;

Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PatchJobs.ExecStepConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides

clone()

public PatchJobs.ExecStepConfig.Builder clone()
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getGcsObjectBuilder()

public PatchJobs.GcsObject.Builder getGcsObjectBuilder()

A Cloud Storage object containing the executable.

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

Returns
TypeDescription
PatchJobs.GcsObject.Builder

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PatchJobs.ExecStepConfig other)

public PatchJobs.ExecStepConfig.Builder mergeFrom(PatchJobs.ExecStepConfig other)
Parameter
NameDescription
otherPatchJobs.ExecStepConfig
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PatchJobs.ExecStepConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PatchJobs.ExecStepConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides

mergeGcsObject(PatchJobs.GcsObject value)

public PatchJobs.ExecStepConfig.Builder mergeGcsObject(PatchJobs.GcsObject value)

A Cloud Storage object containing the executable.

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

Parameter
NameDescription
valuePatchJobs.GcsObject
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PatchJobs.ExecStepConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides

setAllowedSuccessCodes(int index, int value)

public PatchJobs.ExecStepConfig.Builder setAllowedSuccessCodes(int index, int value)

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

repeated int32 allowed_success_codes = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueint

The allowedSuccessCodes to set.

Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PatchJobs.ExecStepConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides

setGcsObject(PatchJobs.GcsObject value)

public PatchJobs.ExecStepConfig.Builder setGcsObject(PatchJobs.GcsObject value)

A Cloud Storage object containing the executable.

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

Parameter
NameDescription
valuePatchJobs.GcsObject
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

setGcsObject(PatchJobs.GcsObject.Builder builderForValue)

public PatchJobs.ExecStepConfig.Builder setGcsObject(PatchJobs.GcsObject.Builder builderForValue)

A Cloud Storage object containing the executable.

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

Parameter
NameDescription
builderForValuePatchJobs.GcsObject.Builder
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

setInterpreter(PatchJobs.ExecStepConfig.Interpreter value)

public PatchJobs.ExecStepConfig.Builder setInterpreter(PatchJobs.ExecStepConfig.Interpreter value)

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;

Parameter
NameDescription
valuePatchJobs.ExecStepConfig.Interpreter

The interpreter to set.

Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

This builder for chaining.

setInterpreterValue(int value)

public PatchJobs.ExecStepConfig.Builder setInterpreterValue(int value)

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;

Parameter
NameDescription
valueint

The enum numeric value on the wire for interpreter to set.

Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

This builder for chaining.

setLocalPath(String value)

public PatchJobs.ExecStepConfig.Builder setLocalPath(String value)

An absolute path to the executable on the VM.

string local_path = 1;

Parameter
NameDescription
valueString

The localPath to set.

Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

This builder for chaining.

setLocalPathBytes(ByteString value)

public PatchJobs.ExecStepConfig.Builder setLocalPathBytes(ByteString value)

An absolute path to the executable on the VM.

string local_path = 1;

Parameter
NameDescription
valueByteString

The bytes for localPath to set.

Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PatchJobs.ExecStepConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PatchJobs.ExecStepConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PatchJobs.ExecStepConfig.Builder
Overrides