Class PatchDeployments.PatchDeployment (2.45.0)

public static final class PatchDeployments.PatchDeployment extends GeneratedMessageV3 implements PatchDeployments.PatchDeploymentOrBuilder

Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see Scheduling patch jobs.

Protobuf type google.cloud.osconfig.v1.PatchDeployment

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PatchDeployments.PatchDeployment

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FILTER_FIELD_NUMBER

public static final int INSTANCE_FILTER_FIELD_NUMBER
Field Value
Type Description
int

LAST_EXECUTE_TIME_FIELD_NUMBER

public static final int LAST_EXECUTE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ONE_TIME_SCHEDULE_FIELD_NUMBER

public static final int ONE_TIME_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

PATCH_CONFIG_FIELD_NUMBER

public static final int PATCH_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

RECURRING_SCHEDULE_FIELD_NUMBER

public static final int RECURRING_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

ROLLOUT_FIELD_NUMBER

public static final int ROLLOUT_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PatchDeployments.PatchDeployment getDefaultInstance()
Returns
Type Description
PatchDeployments.PatchDeployment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PatchDeployments.PatchDeployment.Builder newBuilder()
Returns
Type Description
PatchDeployments.PatchDeployment.Builder

newBuilder(PatchDeployments.PatchDeployment prototype)

public static PatchDeployments.PatchDeployment.Builder newBuilder(PatchDeployments.PatchDeployment prototype)
Parameter
Name Description
prototype PatchDeployments.PatchDeployment
Returns
Type Description
PatchDeployments.PatchDeployment.Builder

parseDelimitedFrom(InputStream input)

public static PatchDeployments.PatchDeployment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchDeployments.PatchDeployment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PatchDeployments.PatchDeployment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PatchDeployments.PatchDeployment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PatchDeployments.PatchDeployment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PatchDeployments.PatchDeployment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PatchDeployments.PatchDeployment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchDeployments.PatchDeployment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PatchDeployments.PatchDeployment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchDeployments.PatchDeployment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PatchDeployments.PatchDeployment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PatchDeployments.PatchDeployment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchDeployments.PatchDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PatchDeployments.PatchDeployment> parser()
Returns
Type Description
Parser<PatchDeployment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public PatchDeployments.PatchDeployment getDefaultInstanceForType()
Returns
Type Description
PatchDeployments.PatchDeployment

getDescription()

public String getDescription()

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

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDuration()

public Duration getDuration()

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

.google.protobuf.Duration duration = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

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

.google.protobuf.Duration duration = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getInstanceFilter()

public PatchJobs.PatchInstanceFilter getInstanceFilter()

Required. VM instances to patch.

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

Returns
Type Description
PatchJobs.PatchInstanceFilter

The instanceFilter.

getInstanceFilterOrBuilder()

public PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()

Required. VM instances to patch.

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

Returns
Type Description
PatchJobs.PatchInstanceFilterOrBuilder

getLastExecuteTime()

public Timestamp getLastExecuteTime()

Output only. The last time a patch job was started by this deployment. Timestamp is in RFC3339 text format.

.google.protobuf.Timestamp last_execute_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The lastExecuteTime.

getLastExecuteTimeOrBuilder()

public TimestampOrBuilder getLastExecuteTimeOrBuilder()

Output only. The last time a patch job was started by this deployment. Timestamp is in RFC3339 text format.

.google.protobuf.Timestamp last_execute_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Unique name for the patch deployment resource in a project. The patch deployment name is in the form: projects/{project_id}/patchDeployments/{patch_deployment_id}. This field is ignored when you create a new patch deployment.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Unique name for the patch deployment resource in a project. The patch deployment name is in the form: projects/{project_id}/patchDeployments/{patch_deployment_id}. This field is ignored when you create a new patch deployment.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOneTimeSchedule()

public PatchDeployments.OneTimeSchedule getOneTimeSchedule()

Required. Schedule a one-time execution.

.google.cloud.osconfig.v1.OneTimeSchedule one_time_schedule = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PatchDeployments.OneTimeSchedule

The oneTimeSchedule.

getOneTimeScheduleOrBuilder()

public PatchDeployments.OneTimeScheduleOrBuilder getOneTimeScheduleOrBuilder()

Required. Schedule a one-time execution.

.google.cloud.osconfig.v1.OneTimeSchedule one_time_schedule = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PatchDeployments.OneTimeScheduleOrBuilder

getParserForType()

public Parser<PatchDeployments.PatchDeployment> getParserForType()
Returns
Type Description
Parser<PatchDeployment>
Overrides

getPatchConfig()

public PatchJobs.PatchConfig getPatchConfig()

Optional. Patch configuration that is applied.

.google.cloud.osconfig.v1.PatchConfig patch_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PatchJobs.PatchConfig

The patchConfig.

getPatchConfigOrBuilder()

public PatchJobs.PatchConfigOrBuilder getPatchConfigOrBuilder()

Optional. Patch configuration that is applied.

.google.cloud.osconfig.v1.PatchConfig patch_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PatchJobs.PatchConfigOrBuilder

getRecurringSchedule()

public PatchDeployments.RecurringSchedule getRecurringSchedule()

Required. Schedule recurring executions.

.google.cloud.osconfig.v1.RecurringSchedule recurring_schedule = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PatchDeployments.RecurringSchedule

The recurringSchedule.

getRecurringScheduleOrBuilder()

public PatchDeployments.RecurringScheduleOrBuilder getRecurringScheduleOrBuilder()

Required. Schedule recurring executions.

.google.cloud.osconfig.v1.RecurringSchedule recurring_schedule = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PatchDeployments.RecurringScheduleOrBuilder

getRollout()

public PatchJobs.PatchRollout getRollout()

Optional. Rollout strategy of the patch job.

.google.cloud.osconfig.v1.PatchRollout rollout = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PatchJobs.PatchRollout

The rollout.

getRolloutOrBuilder()

public PatchJobs.PatchRolloutOrBuilder getRolloutOrBuilder()

Optional. Rollout strategy of the patch job.

.google.cloud.osconfig.v1.PatchRollout rollout = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PatchJobs.PatchRolloutOrBuilder

getScheduleCase()

public PatchDeployments.PatchDeployment.ScheduleCase getScheduleCase()
Returns
Type Description
PatchDeployments.PatchDeployment.ScheduleCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public PatchDeployments.PatchDeployment.State getState()

Output only. Current state of the patch deployment.

.google.cloud.osconfig.v1.PatchDeployment.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PatchDeployments.PatchDeployment.State

The state.

getStateValue()

public int getStateValue()

Output only. Current state of the patch deployment.

.google.cloud.osconfig.v1.PatchDeployment.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time the patch deployment was created. Timestamp is in RFC3339 text format.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDuration()

public boolean hasDuration()

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

.google.protobuf.Duration duration = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the duration field is set.

hasInstanceFilter()

public boolean hasInstanceFilter()

Required. VM instances to patch.

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

Returns
Type Description
boolean

Whether the instanceFilter field is set.

hasLastExecuteTime()

public boolean hasLastExecuteTime()

Output only. The last time a patch job was started by this deployment. Timestamp is in RFC3339 text format.

.google.protobuf.Timestamp last_execute_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastExecuteTime field is set.

hasOneTimeSchedule()

public boolean hasOneTimeSchedule()

Required. Schedule a one-time execution.

.google.cloud.osconfig.v1.OneTimeSchedule one_time_schedule = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the oneTimeSchedule field is set.

hasPatchConfig()

public boolean hasPatchConfig()

Optional. Patch configuration that is applied.

.google.cloud.osconfig.v1.PatchConfig patch_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the patchConfig field is set.

hasRecurringSchedule()

public boolean hasRecurringSchedule()

Required. Schedule recurring executions.

.google.cloud.osconfig.v1.RecurringSchedule recurring_schedule = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the recurringSchedule field is set.

hasRollout()

public boolean hasRollout()

Optional. Rollout strategy of the patch job.

.google.cloud.osconfig.v1.PatchRollout rollout = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rollout field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time the patch deployment was last updated. Timestamp is in RFC3339 text format.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PatchDeployments.PatchDeployment.Builder newBuilderForType()
Returns
Type Description
PatchDeployments.PatchDeployment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchDeployments.PatchDeployment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PatchDeployments.PatchDeployment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PatchDeployments.PatchDeployment.Builder toBuilder()
Returns
Type Description
PatchDeployments.PatchDeployment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException