Class ResourceFilter (0.1.0)

public final class ResourceFilter extends GeneratedMessage implements ResourceFilterOrBuilder

Resource filter for an evaluation defining the scope of resources to be evaluated.

Protobuf type google.cloud.workloadmanager.v1.ResourceFilter

Static Fields

GCE_INSTANCE_FILTER_FIELD_NUMBER

public static final int GCE_INSTANCE_FILTER_FIELD_NUMBER
Field Value
Type Description
int

INCLUSION_LABELS_FIELD_NUMBER

public static final int INCLUSION_LABELS_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_ID_PATTERNS_FIELD_NUMBER

public static final int RESOURCE_ID_PATTERNS_FIELD_NUMBER
Field Value
Type Description
int

SCOPES_FIELD_NUMBER

public static final int SCOPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResourceFilter getDefaultInstance()
Returns
Type Description
ResourceFilter

getDescriptor()

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

newBuilder()

public static ResourceFilter.Builder newBuilder()
Returns
Type Description
ResourceFilter.Builder

newBuilder(ResourceFilter prototype)

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

parseDelimitedFrom(InputStream input)

public static ResourceFilter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResourceFilter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ResourceFilter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ResourceFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ResourceFilter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ResourceFilter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ResourceFilter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResourceFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ResourceFilter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ResourceFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ResourceFilter> parser()
Returns
Type Description
Parser<ResourceFilter>

Methods

containsInclusionLabels(String key)

public boolean containsInclusionLabels(String key)

Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying { "env": "prod", "database": "nosql" } will only include resources that have labels env=prod and database=nosql.

map<string, string> inclusion_labels = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public ResourceFilter getDefaultInstanceForType()
Returns
Type Description
ResourceFilter

getGceInstanceFilter()

public GceInstanceFilter getGceInstanceFilter()

Filter compute engine resources.

.google.cloud.workloadmanager.v1.GceInstanceFilter gce_instance_filter = 4;

Returns
Type Description
GceInstanceFilter

The gceInstanceFilter.

getGceInstanceFilterOrBuilder()

public GceInstanceFilterOrBuilder getGceInstanceFilterOrBuilder()

Filter compute engine resources.

.google.cloud.workloadmanager.v1.GceInstanceFilter gce_instance_filter = 4;

Returns
Type Description
GceInstanceFilterOrBuilder

getInclusionLabels() (deprecated)

public Map<String,String> getInclusionLabels()
Returns
Type Description
Map<String,String>

getInclusionLabelsCount()

public int getInclusionLabelsCount()

Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying { "env": "prod", "database": "nosql" } will only include resources that have labels env=prod and database=nosql.

map<string, string> inclusion_labels = 3;

Returns
Type Description
int

getInclusionLabelsMap()

public Map<String,String> getInclusionLabelsMap()

Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying { "env": "prod", "database": "nosql" } will only include resources that have labels env=prod and database=nosql.

map<string, string> inclusion_labels = 3;

Returns
Type Description
Map<String,String>

getInclusionLabelsOrDefault(String key, String defaultValue)

public String getInclusionLabelsOrDefault(String key, String defaultValue)

Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying { "env": "prod", "database": "nosql" } will only include resources that have labels env=prod and database=nosql.

map<string, string> inclusion_labels = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getInclusionLabelsOrThrow(String key)

public String getInclusionLabelsOrThrow(String key)

Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying { "env": "prod", "database": "nosql" } will only include resources that have labels env=prod and database=nosql.

map<string, string> inclusion_labels = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<ResourceFilter> getParserForType()
Returns
Type Description
Parser<ResourceFilter>
Overrides

getResourceIdPatterns(int index)

public String getResourceIdPatterns(int index)

The pattern to filter resources by their id For example, a pattern of ".prod-cluster." will match all resources that contain "prod-cluster" in their ID.

repeated string resource_id_patterns = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The resourceIdPatterns at the given index.

getResourceIdPatternsBytes(int index)

public ByteString getResourceIdPatternsBytes(int index)

The pattern to filter resources by their id For example, a pattern of ".prod-cluster." will match all resources that contain "prod-cluster" in their ID.

repeated string resource_id_patterns = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the resourceIdPatterns at the given index.

getResourceIdPatternsCount()

public int getResourceIdPatternsCount()

The pattern to filter resources by their id For example, a pattern of ".prod-cluster." will match all resources that contain "prod-cluster" in their ID.

repeated string resource_id_patterns = 2;

Returns
Type Description
int

The count of resourceIdPatterns.

getResourceIdPatternsList()

public ProtocolStringList getResourceIdPatternsList()

The pattern to filter resources by their id For example, a pattern of ".prod-cluster." will match all resources that contain "prod-cluster" in their ID.

repeated string resource_id_patterns = 2;

Returns
Type Description
ProtocolStringList

A list containing the resourceIdPatterns.

getScopes(int index)

public String getScopes(int index)

The scopes of evaluation resource. Format:

  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

repeated string scopes = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The scopes at the given index.

getScopesBytes(int index)

public ByteString getScopesBytes(int index)

The scopes of evaluation resource. Format:

  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

repeated string scopes = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the scopes at the given index.

getScopesCount()

public int getScopesCount()

The scopes of evaluation resource. Format:

  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

repeated string scopes = 1;

Returns
Type Description
int

The count of scopes.

getScopesList()

public ProtocolStringList getScopesList()

The scopes of evaluation resource. Format:

  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

repeated string scopes = 1;

Returns
Type Description
ProtocolStringList

A list containing the scopes.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasGceInstanceFilter()

public boolean hasGceInstanceFilter()

Filter compute engine resources.

.google.cloud.workloadmanager.v1.GceInstanceFilter gce_instance_filter = 4;

Returns
Type Description
boolean

Whether the gceInstanceFilter field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ResourceFilter.Builder newBuilderForType()
Returns
Type Description
ResourceFilter.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ResourceFilter.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ResourceFilter.Builder
Overrides

toBuilder()

public ResourceFilter.Builder toBuilder()
Returns
Type Description
ResourceFilter.Builder

writeTo(CodedOutputStream output)

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