Struct googapis::google::cloud::channel::v1::Entitlement

pub struct Entitlement {
    pub name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub offer: String,
    pub commitment_settings: Option<CommitmentSettings>,
    pub provisioning_state: i32,
    pub provisioned_service: Option<ProvisionedService>,
    pub suspension_reasons: Vec<i32>,
    pub purchase_order_id: String,
    pub trial_settings: Option<TrialSettings>,
    pub association_info: Option<AssociationInfo>,
    pub parameters: Vec<Parameter>,
}

An entitlement is a representation of a customer’s ability to use a service.

Fields

name: String

Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.

create_time: Option<Timestamp>

Output only. The time at which the entitlement is created.

update_time: Option<Timestamp>

Output only. The time at which the entitlement is updated.

offer: String

Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.

commitment_settings: Option<CommitmentSettings>

Commitment settings for a commitment-based Offer. Required for commitment based offers.

provisioning_state: i32

Output only. Current provisioning state of the entitlement.

provisioned_service: Option<ProvisionedService>

Output only. Service provisioning details for the entitlement.

suspension_reasons: Vec<i32>

Output only. Enumerable of all current suspension reasons for an entitlement.

purchase_order_id: String

Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.

trial_settings: Option<TrialSettings>

Output only. Settings for trial offers.

association_info: Option<AssociationInfo>

Association information to other entitlements.

parameters: Vec<Parameter>

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].

The response may include the following output-only Parameters:

• assigned_units: The number of licenses assigned to users.

• max_units: The maximum assignable units for a flexible offer.

• num_units: The total commitment for commitment-based offers.

Implementations

impl Entitlement

pub fn provisioning_state(&self) -> ProvisioningState

Returns the enum value of provisioning_state, or the default if the field is set to an invalid enum value.

pub fn set_provisioning_state(&mut self, value: ProvisioningState)

Sets provisioning_state to the provided enum value.

pub fn suspension_reasons(
    &self
) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<SuspensionReason>>

Returns an iterator which yields the valid enum values contained in suspension_reasons.

pub fn push_suspension_reasons(&mut self, value: SuspensionReason)

Appends the provided enum value to suspension_reasons.

Trait Implementations

impl Clone for Entitlement

fn clone(&self) -> Entitlement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entitlement

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

Formats the value using the given formatter.

impl Default for Entitlement

fn default() -> Self

Returns the “default value” for a type.

impl Message for Entitlement

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Entitlement> for Entitlement

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Entitlement