Interface OperationOrBuilder (2.57.0)

public interface OperationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsPathFilters(String key)

public abstract boolean containsPathFilters(String key)

Set of filters to apply if path refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers.

  • Example: ` { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ` When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.protobuf.Value> path_filters = 8;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsPathValueMatchers(String key)

public abstract boolean containsPathValueMatchers(String key)

Similar to path_filters, this contains set of filters to apply if path field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.cloud.recommender.v1.ValueMatcher> path_value_matchers = 11;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAction()

public abstract String getAction()

Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.

string action = 1;

Returns
Type Description
String

The action.

getActionBytes()

public abstract ByteString getActionBytes()

Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.

string action = 1;

Returns
Type Description
ByteString

The bytes for action.

getPath()

public abstract String getPath()

Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated.

string path = 4;

Returns
Type Description
String

The path.

getPathBytes()

public abstract ByteString getPathBytes()

Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated.

string path = 4;

Returns
Type Description
ByteString

The bytes for path.

getPathFilters() (deprecated)

public abstract Map<String,Value> getPathFilters()

Use #getPathFiltersMap() instead.

Returns
Type Description
Map<String,Value>

getPathFiltersCount()

public abstract int getPathFiltersCount()

Set of filters to apply if path refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers.

  • Example: ` { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ` When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.protobuf.Value> path_filters = 8;

Returns
Type Description
int

getPathFiltersMap()

public abstract Map<String,Value> getPathFiltersMap()

Set of filters to apply if path refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers.

  • Example: ` { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ` When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.protobuf.Value> path_filters = 8;

Returns
Type Description
Map<String,Value>

getPathFiltersOrDefault(String key, Value defaultValue)

public abstract Value getPathFiltersOrDefault(String key, Value defaultValue)

Set of filters to apply if path refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers.

  • Example: ` { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ` When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.protobuf.Value> path_filters = 8;

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getPathFiltersOrThrow(String key)

public abstract Value getPathFiltersOrThrow(String key)

Set of filters to apply if path refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers.

  • Example: ` { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null }
  • Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ` When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.protobuf.Value> path_filters = 8;

Parameter
Name Description
key String
Returns
Type Description
Value

getPathValueCase()

public abstract Operation.PathValueCase getPathValueCase()
Returns
Type Description
Operation.PathValueCase

getPathValueMatchers() (deprecated)

public abstract Map<String,ValueMatcher> getPathValueMatchers()
Returns
Type Description
Map<String,ValueMatcher>

getPathValueMatchersCount()

public abstract int getPathValueMatchersCount()

Similar to path_filters, this contains set of filters to apply if path field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.cloud.recommender.v1.ValueMatcher> path_value_matchers = 11;

Returns
Type Description
int

getPathValueMatchersMap()

public abstract Map<String,ValueMatcher> getPathValueMatchersMap()

Similar to path_filters, this contains set of filters to apply if path field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.cloud.recommender.v1.ValueMatcher> path_value_matchers = 11;

Returns
Type Description
Map<String,ValueMatcher>

getPathValueMatchersOrDefault(String key, ValueMatcher defaultValue)

public abstract ValueMatcher getPathValueMatchersOrDefault(String key, ValueMatcher defaultValue)

Similar to path_filters, this contains set of filters to apply if path field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.cloud.recommender.v1.ValueMatcher> path_value_matchers = 11;

Parameters
Name Description
key String
defaultValue ValueMatcher
Returns
Type Description
ValueMatcher

getPathValueMatchersOrThrow(String key)

public abstract ValueMatcher getPathValueMatchersOrThrow(String key)

Similar to path_filters, this contains set of filters to apply if path field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

map<string, .google.cloud.recommender.v1.ValueMatcher> path_value_matchers = 11;

Parameter
Name Description
key String
Returns
Type Description
ValueMatcher

getResource()

public abstract String getResource()

Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.

string resource = 3;

Returns
Type Description
String

The resource.

getResourceBytes()

public abstract ByteString getResourceBytes()

Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.

string resource = 3;

Returns
Type Description
ByteString

The bytes for resource.

getResourceType()

public abstract String getResourceType()

Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance

string resource_type = 2;

Returns
Type Description
String

The resourceType.

getResourceTypeBytes()

public abstract ByteString getResourceTypeBytes()

Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance

string resource_type = 2;

Returns
Type Description
ByteString

The bytes for resourceType.

getSourcePath()

public abstract String getSourcePath()

Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.

string source_path = 6;

Returns
Type Description
String

The sourcePath.

getSourcePathBytes()

public abstract ByteString getSourcePathBytes()

Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.

string source_path = 6;

Returns
Type Description
ByteString

The bytes for sourcePath.

getSourceResource()

public abstract String getSourceResource()

Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = <source> and resource_name = <target>. This field is empty for all other values of action.

string source_resource = 5;

Returns
Type Description
String

The sourceResource.

getSourceResourceBytes()

public abstract ByteString getSourceResourceBytes()

Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = <source> and resource_name = <target>. This field is empty for all other values of action.

string source_resource = 5;

Returns
Type Description
ByteString

The bytes for sourceResource.

getValue()

public abstract Value getValue()

Value for the path field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or value_matcher will be set for 'test' operation. An exact match must be performed.

.google.protobuf.Value value = 7;

Returns
Type Description
Value

The value.

getValueMatcher()

public abstract ValueMatcher getValueMatcher()

Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or value will be set for 'test' operation.

.google.cloud.recommender.v1.ValueMatcher value_matcher = 10;

Returns
Type Description
ValueMatcher

The valueMatcher.

getValueMatcherOrBuilder()

public abstract ValueMatcherOrBuilder getValueMatcherOrBuilder()

Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or value will be set for 'test' operation.

.google.cloud.recommender.v1.ValueMatcher value_matcher = 10;

Returns
Type Description
ValueMatcherOrBuilder

getValueOrBuilder()

public abstract ValueOrBuilder getValueOrBuilder()

Value for the path field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or value_matcher will be set for 'test' operation. An exact match must be performed.

.google.protobuf.Value value = 7;

Returns
Type Description
ValueOrBuilder

hasValue()

public abstract boolean hasValue()

Value for the path field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or value_matcher will be set for 'test' operation. An exact match must be performed.

.google.protobuf.Value value = 7;

Returns
Type Description
boolean

Whether the value field is set.

hasValueMatcher()

public abstract boolean hasValueMatcher()

Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or value will be set for 'test' operation.

.google.cloud.recommender.v1.ValueMatcher value_matcher = 10;

Returns
Type Description
boolean

Whether the valueMatcher field is set.