Class PatchJobs.ExecutePatchJobRequest (2.5.4)

Stay organized with collections Save and categorize content based on your preferences.
public static final class PatchJobs.ExecutePatchJobRequest extends GeneratedMessageV3 implements PatchJobs.ExecutePatchJobRequestOrBuilder

A request message to initiate patching across Compute Engine instances.

Protobuf type google.cloud.osconfig.v1.ExecutePatchJobRequest

Inheritance

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

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

DRY_RUN_FIELD_NUMBER

public static final int DRY_RUN_FIELD_NUMBER
Field Value
TypeDescription
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_FILTER_FIELD_NUMBER

public static final int INSTANCE_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

PATCH_CONFIG_FIELD_NUMBER

public static final int PATCH_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

ROLLOUT_FIELD_NUMBER

public static final int ROLLOUT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(PatchJobs.ExecutePatchJobRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getDescription()

public String getDescription()

Description of the patch job. Length of the description is limited to 1024 characters.

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the patch job. Length of the description is limited to 1024 characters.

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Display name for this patch job. This does not have to be unique.

string display_name = 8;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name for this patch job. This does not have to be unique.

string display_name = 8;

Returns
TypeDescription
ByteString

The bytes for displayName.

getDryRun()

public boolean getDryRun()

If this patch is a dry-run only, instances are contacted but will do nothing.

bool dry_run = 6;

Returns
TypeDescription
boolean

The dryRun.

getDuration()

public Duration getDuration()

Duration of the patch job. After the duration ends, the patch job times out.

.google.protobuf.Duration duration = 5;

Returns
TypeDescription
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration of the patch job. After the duration ends, the patch job times out.

.google.protobuf.Duration duration = 5;

Returns
TypeDescription
DurationOrBuilder

getInstanceFilter()

public PatchJobs.PatchInstanceFilter getInstanceFilter()

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
PatchJobs.PatchInstanceFilter

The instanceFilter.

getInstanceFilterOrBuilder()

public PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
PatchJobs.PatchInstanceFilterOrBuilder

getParent()

public String getParent()

Required. The project in which to run this patch in the form projects/*

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project in which to run this patch in the form projects/*

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<PatchJobs.ExecutePatchJobRequest> getParserForType()
Returns
TypeDescription<