Class Operation (2.33.0)

public final class Operation extends GeneratedMessageV3 implements OperationOrBuilder

Contains an operation for a resource loosely based on the JSON-PATCH format with support for:

  • Custom filters for describing partial array patch.
  • Extended path values for describing nested arrays.
  • Custom fields for describing the resource for which the operation is being described.
  • Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

Protobuf type google.cloud.recommender.v1.Operation

Implements

OperationOrBuilder

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER
Field Value
TypeDescription
int

PATH_FILTERS_FIELD_NUMBER

public static final int PATH_FILTERS_FIELD_NUMBER
Field Value
TypeDescription
int

PATH_VALUE_MATCHERS_FIELD_NUMBER

public static final int PATH_VALUE_MATCHERS_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_TYPE_FIELD_NUMBER

public static final int RESOURCE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_PATH_FIELD_NUMBER

public static final int SOURCE_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_RESOURCE_FIELD_NUMBER

public static final int SOURCE_RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_MATCHER_FIELD_NUMBER

public static final int VALUE_MATCHER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Operation getDefaultInstance()
Returns
TypeDescription
Operation

getDescriptor()

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

newBuilder()

public static Operation.Builder newBuilder()
Returns
TypeDescription
Operation.Builder

newBuilder(Operation prototype)

public static Operation.Builder newBuilder(Operation prototype)
Parameter
NameDescription
prototypeOperation
Returns
TypeDescription
Operation.Builder

parseDelimitedFrom(InputStream input)

public static Operation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Operation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Operation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Operation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Operation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Operation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Operation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Operation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Operation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Operation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Operation> parser()
Returns
TypeDescription
Parser<Operation>

Methods

containsPathFilters(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
boolean

containsPathValueMatchers(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getAction()

public 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
TypeDescription
String

The action.

getActionBytes()

public 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
TypeDescription
ByteString

The bytes for action.

getDefaultInstanceForType()

public Operation getDefaultInstanceForType()
Returns
TypeDescription
Operation

getParserForType()

public Parser<Operation> getParserForType()
Returns
TypeDescription
Parser<Operation>
Overrides

getPath()

public 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
TypeDescription
String

The path.

getPathBytes()

public 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
TypeDescription
ByteString

The bytes for path.

getPathFilters() (deprecated)

public Map<String,Value> getPathFilters()

Use #getPathFiltersMap() instead.

Returns
TypeDescription
Map<String,Value>

getPathFiltersCount()

public 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
TypeDescription
int

getPathFiltersMap()

public 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
TypeDescription
Map<String,Value>

getPathFiltersOrDefault(String key, Value defaultValue)

public 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
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getPathFiltersOrThrow(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
Value

getPathValueCase()

public Operation.PathValueCase getPathValueCase()
Returns
TypeDescription
Operation.PathValueCase

getPathValueMatchers() (deprecated)

public Map<String,ValueMatcher> getPathValueMatchers()
Returns
TypeDescription
Map<String,ValueMatcher>

getPathValueMatchersCount()

public 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
TypeDescription
int

getPathValueMatchersMap()

public 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
TypeDescription
Map<String,ValueMatcher>

getPathValueMatchersOrDefault(String key, ValueMatcher defaultValue)

public 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
NameDescription
keyString
defaultValueValueMatcher
Returns
TypeDescription
ValueMatcher

getPathValueMatchersOrThrow(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
ValueMatcher

getResource()

public String getResource()

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

string resource = 3;

Returns
TypeDescription
String

The resource.

getResourceBytes()

public ByteString getResourceBytes()

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

string resource = 3;

Returns
TypeDescription
ByteString

The bytes for resource.

getResourceType()

public 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
TypeDescription
String

The resourceType.

getResourceTypeBytes()

public 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
TypeDescription
ByteString

The bytes for resourceType.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourcePath()

public 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
TypeDescription
String

The sourcePath.

getSourcePathBytes()

public 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
TypeDescription
ByteString

The bytes for sourcePath.

getSourceResource()

public 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
TypeDescription
String

The sourceResource.

getSourceResourceBytes()

public 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
TypeDescription
ByteString

The bytes for sourceResource.

getValue()

public 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
TypeDescription
Value

The value.

getValueMatcher()

public 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
TypeDescription
ValueMatcher

The valueMatcher.

getValueMatcherOrBuilder()

public 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
TypeDescription
ValueMatcherOrBuilder

getValueOrBuilder()

public 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
TypeDescription
ValueOrBuilder

hasValue()

public 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
TypeDescription
boolean

Whether the value field is set.

hasValueMatcher()

public 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
TypeDescription
boolean

Whether the valueMatcher field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Operation.Builder newBuilderForType()
Returns
TypeDescription
Operation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Operation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Operation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Operation.Builder toBuilder()
Returns
TypeDescription
Operation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException