Class Operation (2.10.0)

Operation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
`action`	`str` Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.
`resource_type`	`str` Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance
`resource`	`str` Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.
`path`	`str` 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.
`source_resource`	`str` 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 = and resource_name = . This field is empty for all other values of `action`.
`source_path`	`str` 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.
`value`	`google.protobuf.struct_pb2.Value` 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. This field is a member of `oneof`_ `path_value`.
`value_matcher`	`google.cloud.recommender_v1.types.ValueMatcher` 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. This field is a member of `oneof`_ `path_value`.
`path_filters`	`MutableMapping[str, google.protobuf.struct_pb2.Value]` 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.
`path_value_matchers`	`MutableMapping[str, google.cloud.recommender_v1.types.ValueMatcher]` 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.

Classes

PathFiltersEntry

PathFiltersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

PathValueMatchersEntry

PathValueMatchersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.