Class PatchJobs.ExecStepConfig (2.18.0)

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

Common configurations for an ExecStep.

Protobuf type google.cloud.osconfig.v1.ExecStepConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PatchJobs.ExecStepConfig

Implements

PatchJobs.ExecStepConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOWED_SUCCESS_CODES_FIELD_NUMBER

public static final int ALLOWED_SUCCESS_CODES_FIELD_NUMBER

Field Value
Type	Description
`int`

GCS_OBJECT_FIELD_NUMBER

public static final int GCS_OBJECT_FIELD_NUMBER

Field Value
Type	Description
`int`

INTERPRETER_FIELD_NUMBER

public static final int INTERPRETER_FIELD_NUMBER

Field Value
Type	Description
`int`

LOCAL_PATH_FIELD_NUMBER

public static final int LOCAL_PATH_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static PatchJobs.ExecStepConfig getDefaultInstance()

Returns
Type	Description
`PatchJobs.ExecStepConfig`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static PatchJobs.ExecStepConfig.Builder newBuilder()

Returns
Type	Description
`PatchJobs.ExecStepConfig.Builder`

newBuilder(PatchJobs.ExecStepConfig prototype)

public static PatchJobs.ExecStepConfig.Builder newBuilder(PatchJobs.ExecStepConfig prototype)

Parameter
Name	Description
`prototype`	`PatchJobs.ExecStepConfig`

Returns
Type	Description
`PatchJobs.ExecStepConfig.Builder`

parseDelimitedFrom(InputStream input)

public static PatchJobs.ExecStepConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static PatchJobs.ExecStepConfig parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static PatchJobs.ExecStepConfig parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static PatchJobs.ExecStepConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static PatchJobs.ExecStepConfig parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static PatchJobs.ExecStepConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.ExecStepConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PatchJobs.ExecStepConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<PatchJobs.ExecStepConfig> parser()

Returns
Type	Description
`Parser<ExecStepConfig>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`List<Integer>`	A list containing the allowedSuccessCodes.

getDefaultInstanceForType()

public PatchJobs.ExecStepConfig getDefaultInstanceForType()

Returns
Type	Description
`PatchJobs.ExecStepConfig`

getExecutableCase()

public PatchJobs.ExecStepConfig.ExecutableCase getExecutableCase()

Returns
Type	Description
`PatchJobs.ExecStepConfig.ExecutableCase`

getGcsObject()

public PatchJobs.GcsObject getGcsObject()

A Cloud Storage object containing the executable.

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

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`String`	The localPath.

getLocalPathBytes()

public ByteString getLocalPathBytes()

An absolute path to the executable on the VM.

string local_path = 1;

Returns
Type	Description
`ByteString`	The bytes for localPath.

getParserForType()

public Parser<PatchJobs.ExecStepConfig> getParserForType()

Returns
Type	Description
`Parser<ExecStepConfig>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

hasGcsObject()

public boolean hasGcsObject()

A Cloud Storage object containing the executable.

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

Returns
Type	Description
`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
Type	Description
`boolean`	Whether the localPath field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public PatchJobs.ExecStepConfig.Builder newBuilderForType()

Returns
Type	Description
`PatchJobs.ExecStepConfig.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchJobs.ExecStepConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`PatchJobs.ExecStepConfig.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public PatchJobs.ExecStepConfig.Builder toBuilder()

Returns
Type	Description
`PatchJobs.ExecStepConfig.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`