Class PatchJobs.PatchInstanceFilter (2.56.0)

public static final class PatchJobs.PatchInstanceFilter extends GeneratedMessageV3 implements PatchJobs.PatchInstanceFilterOrBuilder

A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones.

Protobuf type google.cloud.osconfig.v1beta.PatchInstanceFilter

Static Fields

ALL_FIELD_NUMBER

public static final int ALL_FIELD_NUMBER
Field Value
Type Description
int

GROUP_LABELS_FIELD_NUMBER

public static final int GROUP_LABELS_FIELD_NUMBER
Field Value
Type Description
int

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_NAME_PREFIXES_FIELD_NUMBER

public static final int INSTANCE_NAME_PREFIXES_FIELD_NUMBER
Field Value
Type Description
int

ZONES_FIELD_NUMBER

public static final int ZONES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PatchJobs.PatchInstanceFilter getDefaultInstance()
Returns
Type Description
PatchJobs.PatchInstanceFilter

getDescriptor()

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

newBuilder()

public static PatchJobs.PatchInstanceFilter.Builder newBuilder()
Returns
Type Description
PatchJobs.PatchInstanceFilter.Builder

newBuilder(PatchJobs.PatchInstanceFilter prototype)

public static PatchJobs.PatchInstanceFilter.Builder newBuilder(PatchJobs.PatchInstanceFilter prototype)
Parameter
Name Description
prototype PatchJobs.PatchInstanceFilter
Returns
Type Description
PatchJobs.PatchInstanceFilter.Builder

parseDelimitedFrom(InputStream input)

public static PatchJobs.PatchInstanceFilter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PatchJobs.PatchInstanceFilter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static PatchJobs.PatchInstanceFilter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PatchJobs.PatchInstanceFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static PatchJobs.PatchInstanceFilter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PatchJobs.PatchInstanceFilter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static PatchJobs.PatchInstanceFilter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PatchJobs.PatchInstanceFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static PatchJobs.PatchInstanceFilter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PatchJobs.PatchInstanceFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<PatchJobs.PatchInstanceFilter> parser()
Returns
Type Description
Parser<PatchInstanceFilter>

Methods

equals(Object obj)

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

getAll()

public boolean getAll()

Target all VM instances in the project. If true, no other criteria is permitted.

bool all = 1;

Returns
Type Description
boolean

The all.

getDefaultInstanceForType()

public PatchJobs.PatchInstanceFilter getDefaultInstanceForType()
Returns
Type Description
PatchJobs.PatchInstanceFilter

getGroupLabels(int index)

public PatchJobs.PatchInstanceFilter.GroupLabel getGroupLabels(int index)

Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.PatchInstanceFilter.GroupLabel group_labels = 2;

Parameter
Name Description
index int
Returns
Type Description
PatchJobs.PatchInstanceFilter.GroupLabel

getGroupLabelsCount()

public int getGroupLabelsCount()

Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.PatchInstanceFilter.GroupLabel group_labels = 2;

Returns
Type Description
int

getGroupLabelsList()

public List<PatchJobs.PatchInstanceFilter.GroupLabel> getGroupLabelsList()

Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.PatchInstanceFilter.GroupLabel group_labels = 2;

Returns
Type Description
List<GroupLabel>

getGroupLabelsOrBuilder(int index)

public PatchJobs.PatchInstanceFilter.GroupLabelOrBuilder getGroupLabelsOrBuilder(int index)

Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.PatchInstanceFilter.GroupLabel group_labels = 2;

Parameter
Name Description
index int
Returns
Type Description
PatchJobs.PatchInstanceFilter.GroupLabelOrBuilder

getGroupLabelsOrBuilderList()

public List<? extends PatchJobs.PatchInstanceFilter.GroupLabelOrBuilder> getGroupLabelsOrBuilderList()

Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging".

repeated .google.cloud.osconfig.v1beta.PatchInstanceFilter.GroupLabel group_labels = 2;

Returns
Type Description
List<? extends com.google.cloud.osconfig.v1beta.PatchJobs.PatchInstanceFilter.GroupLabelOrBuilder>

getInstanceNamePrefixes(int index)

public String getInstanceNamePrefixes(int index)

Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".

repeated string instance_name_prefixes = 5;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The instanceNamePrefixes at the given index.

getInstanceNamePrefixesBytes(int index)

public ByteString getInstanceNamePrefixesBytes(int index)

Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".

repeated string instance_name_prefixes = 5;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the instanceNamePrefixes at the given index.

getInstanceNamePrefixesCount()

public int getInstanceNamePrefixesCount()

Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".

repeated string instance_name_prefixes = 5;

Returns
Type Description
int

The count of instanceNamePrefixes.

getInstanceNamePrefixesList()

public ProtocolStringList getInstanceNamePrefixesList()

Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".

repeated string instance_name_prefixes = 5;

Returns
Type Description
ProtocolStringList

A list containing the instanceNamePrefixes.

getInstances(int index)

public String getInstances(int index)

Targets any of the VM instances specified. Instances are specified by their URI in the form zones/[ZONE]/instances/[INSTANCE_NAME], projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME], or https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]

repeated string instances = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The instances at the given index.

getInstancesBytes(int index)

public ByteString getInstancesBytes(int index)

Targets any of the VM instances specified. Instances are specified by their URI in the form zones/[ZONE]/instances/[INSTANCE_NAME], projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME], or https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]

repeated string instances = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the instances at the given index.

getInstancesCount()

public int getInstancesCount()

Targets any of the VM instances specified. Instances are specified by their URI in the form zones/[ZONE]/instances/[INSTANCE_NAME], projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME], or https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]

repeated string instances = 4;

Returns
Type Description
int

The count of instances.

getInstancesList()

public ProtocolStringList getInstancesList()

Targets any of the VM instances specified. Instances are specified by their URI in the form zones/[ZONE]/instances/[INSTANCE_NAME], projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME], or https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]

repeated string instances = 4;

Returns
Type Description
ProtocolStringList

A list containing the instances.

getParserForType()

public Parser<PatchJobs.PatchInstanceFilter> getParserForType()
Returns
Type Description
Parser<PatchInstanceFilter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getZones(int index)

public String getZones(int index)

Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.

repeated string zones = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The zones at the given index.

getZonesBytes(int index)

public ByteString getZonesBytes(int index)

Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.

repeated string zones = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the zones at the given index.

getZonesCount()

public int getZonesCount()

Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.

repeated string zones = 3;

Returns
Type Description
int

The count of zones.

getZonesList()

public ProtocolStringList getZonesList()

Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.

repeated string zones = 3;

Returns
Type Description
ProtocolStringList

A list containing the zones.

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 PatchJobs.PatchInstanceFilter.Builder newBuilderForType()
Returns
Type Description
PatchJobs.PatchInstanceFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchJobs.PatchInstanceFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PatchJobs.PatchInstanceFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public PatchJobs.PatchInstanceFilter.Builder toBuilder()
Returns
Type Description
PatchJobs.PatchInstanceFilter.Builder

writeTo(CodedOutputStream output)

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