com.google.cloud.recommender.v1

Interface OperationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Operation, Operation.Builder

public interface OperationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
boolean	containsPathValueMatchers(String key) Similar to path_filters, this contains set of filters to apply if `path` field referes to array elements.
String	getAction() Type of this operation.
com.google.protobuf.ByteString	getActionBytes() Type of this operation.
String	getPath() Path to the target field being operated on.
com.google.protobuf.ByteString	getPathBytes() Path to the target field being operated on.
Map<String,com.google.protobuf.Value>	getPathFilters() Deprecated.
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.
Map<String,com.google.protobuf.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.
com.google.protobuf.Value	getPathFiltersOrDefault(String key, com.google.protobuf.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.
com.google.protobuf.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.
Operation.PathValueCase	getPathValueCase()
Map<String,ValueMatcher>	getPathValueMatchers() Deprecated.
int	getPathValueMatchersCount() Similar to path_filters, this contains set of filters to apply if `path` field referes to array elements.
Map<String,ValueMatcher>	getPathValueMatchersMap() Similar to path_filters, this contains set of filters to apply if `path` field referes to array elements.
ValueMatcher	getPathValueMatchersOrDefault(String key, ValueMatcher defaultValue) Similar to path_filters, this contains set of filters to apply if `path` field referes to array elements.
ValueMatcher	getPathValueMatchersOrThrow(String key) Similar to path_filters, this contains set of filters to apply if `path` field referes to array elements.
String	getResource() Contains the fully qualified resource name.
com.google.protobuf.ByteString	getResourceBytes() Contains the fully qualified resource name.
String	getResourceType() Type of GCP resource being modified/tested.
com.google.protobuf.ByteString	getResourceTypeBytes() Type of GCP resource being modified/tested.
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.
com.google.protobuf.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	getSourceResource() Can be set with action 'copy' to copy resource configuration across different resources of the same type.
com.google.protobuf.ByteString	getSourceResourceBytes() Can be set with action 'copy' to copy resource configuration across different resources of the same type.
com.google.protobuf.Value	getValue() Value for the `path` field.
ValueMatcher	getValueMatcher() Can be set for action 'test' for advanced matching for the value of 'path' field.
ValueMatcherOrBuilder	getValueMatcherOrBuilder() Can be set for action 'test' for advanced matching for the value of 'path' field.
com.google.protobuf.ValueOrBuilder	getValueOrBuilder() Value for the `path` field.
boolean	hasValue() Value for the `path` field.
boolean	hasValueMatcher() Can be set for action 'test' for advanced matching for the value of 'path' field.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getAction

String getAction()

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

string action = 1;

Returns:

The action.

getActionBytes

com.google.protobuf.ByteString getActionBytes()

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

string action = 1;

Returns:

The bytes for action.

getResourceType

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:

The resourceType.

getResourceTypeBytes

com.google.protobuf.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:

The bytes for resourceType.

getResource

String getResource()

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

string resource = 3;

Returns:

The resource.

getResourceBytes

com.google.protobuf.ByteString getResourceBytes()

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

string resource = 3;

Returns:

The bytes for resource.

getPath

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:

The path.

getPathBytes

com.google.protobuf.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:

The bytes for path.

getSourceResource

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:

The sourceResource.

getSourceResourceBytes

com.google.protobuf.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:

The bytes for sourceResource.

getSourcePath

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:

The sourcePath.

getSourcePathBytes

com.google.protobuf.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:

The bytes for sourcePath.

hasValue

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:

Whether the value field is set.

getValue

com.google.protobuf.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:

The value.

getValueOrBuilder

com.google.protobuf.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;

hasValueMatcher

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:

Whether the valueMatcher field is set.

getValueMatcher

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:

The valueMatcher.

getValueMatcherOrBuilder

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;

getPathFiltersCount

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/admin"
   "/bindings/*/condition" : null
  }
 * Example: {
   "/bindings/*/role": "roles/admin"
   "/bindings/*/members/*" : ["x@google.com", "y@google.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;

containsPathFilters

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/admin"
   "/bindings/*/condition" : null
  }
 * Example: {
   "/bindings/*/role": "roles/admin"
   "/bindings/*/members/*" : ["x@google.com", "y@google.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;

getPathFilters

@Deprecated
Map<String,com.google.protobuf.Value> getPathFilters()

Deprecated.

Use getPathFiltersMap() instead.

getPathFiltersMap

Map<String,com.google.protobuf.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/admin"
   "/bindings/*/condition" : null
  }
 * Example: {
   "/bindings/*/role": "roles/admin"
   "/bindings/*/members/*" : ["x@google.com", "y@google.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;

getPathFiltersOrDefault

com.google.protobuf.Value getPathFiltersOrDefault(String key,
                                                  com.google.protobuf.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/admin"
   "/bindings/*/condition" : null
  }
 * Example: {
   "/bindings/*/role": "roles/admin"
   "/bindings/*/members/*" : ["x@google.com", "y@google.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;

getPathFiltersOrThrow

com.google.protobuf.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/admin"
   "/bindings/*/condition" : null
  }
 * Example: {
   "/bindings/*/role": "roles/admin"
   "/bindings/*/members/*" : ["x@google.com", "y@google.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;

getPathValueMatchersCount

int getPathValueMatchersCount()

 Similar to path_filters, this contains set of filters to apply if `path`
 field referes 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;

containsPathValueMatchers

boolean containsPathValueMatchers(String key)

 Similar to path_filters, this contains set of filters to apply if `path`
 field referes 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;

getPathValueMatchers

@Deprecated
Map<String,ValueMatcher> getPathValueMatchers()

Deprecated.

Use getPathValueMatchersMap() instead.

getPathValueMatchersMap

Map<String,ValueMatcher> getPathValueMatchersMap()

 Similar to path_filters, this contains set of filters to apply if `path`
 field referes 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;

getPathValueMatchersOrDefault

ValueMatcher getPathValueMatchersOrDefault(String key,
                                           ValueMatcher defaultValue)

 Similar to path_filters, this contains set of filters to apply if `path`
 field referes 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;

getPathValueMatchersOrThrow

ValueMatcher getPathValueMatchersOrThrow(String key)

 Similar to path_filters, this contains set of filters to apply if `path`
 field referes 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;

getPathValueCase

Operation.PathValueCase getPathValueCase()