Class PatchJobs.PatchInstanceFilter (2.5.2)

Stay organized with collections Save and categorize content based on your preferences.
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
TypeDescription
int

GROUP_LABELS_FIELD_NUMBER

public static final int GROUP_LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_NAME_PREFIXES_FIELD_NUMBER

public static final int INSTANCE_NAME_PREFIXES_FIELD_NUMBER
Field Value
TypeDescription
int

ZONES_FIELD_NUMBER

public static final int ZONES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(PatchJobs.PatchInstanceFilter prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAll()

public boolean getAll()

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

bool all = 1;

Returns
TypeDescription
boolean

The all.

getDefaultInstanceForType()

public PatchJobs.PatchInstanceFilter getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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