Skip to main content

Operation

Struct Operation 

Source
#[non_exhaustive]
pub struct Operation { pub action: String, pub resource_type: String, pub resource: String, pub path: String, pub source_resource: String, pub source_path: String, pub path_filters: HashMap<String, Value>, pub path_value_matchers: HashMap<String, ValueMatcher>, pub path_value: Option<PathValue>, /* private fields */ }
Expand description

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.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§action: String

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: String

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

§resource: String

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

§path: String

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: String

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.

§source_path: String

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.

§path_filters: HashMap<String, 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: HashMap<String, 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.

§path_value: Option<PathValue>

One of the fields in the following block will be set and intend to describe a value for ‘path’ field.

Implementations§

Source§

impl Operation

Source

pub fn new() -> Self

Creates a new default instance.

Source

pub fn set_action<T: Into<String>>(self, v: T) -> Self

Sets the value of action.

§Example
let x = Operation::new().set_action("example");
Source

pub fn set_resource_type<T: Into<String>>(self, v: T) -> Self

Sets the value of resource_type.

§Example
let x = Operation::new().set_resource_type("example");
Source

pub fn set_resource<T: Into<String>>(self, v: T) -> Self

Sets the value of resource.

§Example
let x = Operation::new().set_resource("example");
Source

pub fn set_path<T: Into<String>>(self, v: T) -> Self

Sets the value of path.

§Example
let x = Operation::new().set_path("example");
Source

pub fn set_source_resource<T: Into<String>>(self, v: T) -> Self

Sets the value of source_resource.

§Example
let x = Operation::new().set_source_resource("example");
Source

pub fn set_source_path<T: Into<String>>(self, v: T) -> Self

Sets the value of source_path.

§Example
let x = Operation::new().set_source_path("example");
Source

pub fn set_path_filters<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<Value>,

Sets the value of path_filters.

§Example
use wkt::Value;
let x = Operation::new().set_path_filters([
    ("key0", Value::default()/* use setters */),
    ("key1", Value::default()/* use (different) setters */),
]);
Source

pub fn set_path_value_matchers<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<ValueMatcher>,

Sets the value of path_value_matchers.

§Example
use google_cloud_recommender_v1::model::ValueMatcher;
let x = Operation::new().set_path_value_matchers([
    ("key0", ValueMatcher::default()/* use setters */),
    ("key1", ValueMatcher::default()/* use (different) setters */),
]);
Source

pub fn set_path_value<T: Into<Option<PathValue>>>(self, v: T) -> Self

Sets the value of path_value.

Note that all the setters affecting path_value are mutually exclusive.

§Example
use wkt::Value;
let x = Operation::new().set_path_value(Some(
    google_cloud_recommender_v1::model::operation::PathValue::Value(Value::default().into())));
Source

pub fn value(&self) -> Option<&Box<Value>>

The value of path_value if it holds a Value, None if the field is not set or holds a different branch.

Source

pub fn set_value<T: Into<Box<Value>>>(self, v: T) -> Self

Sets the value of path_value to hold a Value.

Note that all the setters affecting path_value are mutually exclusive.

§Example
use wkt::Value;
let x = Operation::new().set_value(Value::default()/* use setters */);
assert!(x.value().is_some());
assert!(x.value_matcher().is_none());
Source

pub fn value_matcher(&self) -> Option<&Box<ValueMatcher>>

The value of path_value if it holds a ValueMatcher, None if the field is not set or holds a different branch.

Source

pub fn set_value_matcher<T: Into<Box<ValueMatcher>>>(self, v: T) -> Self

Sets the value of path_value to hold a ValueMatcher.

Note that all the setters affecting path_value are mutually exclusive.

§Example
use google_cloud_recommender_v1::model::ValueMatcher;
let x = Operation::new().set_value_matcher(ValueMatcher::default()/* use setters */);
assert!(x.value_matcher().is_some());
assert!(x.value().is_none());

Trait Implementations§

Source§

impl Clone for Operation

Source§

fn clone(&self) -> Operation

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Operation

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Operation

Source§

fn default() -> Operation

Returns the “default value” for a type. Read more
Source§

impl Message for Operation

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for Operation

Source§

fn eq(&self, other: &Operation) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Operation

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,