Package com.google.cloud.channel.v1

Class Entitlement

  • All Implemented Interfaces:
    EntitlementOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Entitlement
extends com.google.protobuf.GeneratedMessageV3
implements EntitlementOrBuilder
     An entitlement is a representation of a customer's ability to use a service.
    Protobuf type google.cloud.channel.v1.Entitlement
    See Also:
    Serialized Form

    • Field Detail

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COMMITMENT_SETTINGS_FIELD_NUMBER

        public static final int COMMITMENT_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROVISIONING_STATE_FIELD_NUMBER

        public static final int PROVISIONING_STATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROVISIONED_SERVICE_FIELD_NUMBER

        public static final int PROVISIONED_SERVICE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUSPENSION_REASONS_FIELD_NUMBER

        public static final int SUSPENSION_REASONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PURCHASE_ORDER_ID_FIELD_NUMBER

        public static final int PURCHASE_ORDER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRIAL_SETTINGS_FIELD_NUMBER

        public static final int TRIAL_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ASSOCIATION_INFO_FIELD_NUMBER

        public static final int ASSOCIATION_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARAMETERS_FIELD_NUMBER

        public static final int PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BILLING_ACCOUNT_FIELD_NUMBER

        public static final int BILLING_ACCOUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. Resource name of an entitlement in the form:
 accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface EntitlementOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Resource name of an entitlement in the form:
 accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface EntitlementOrBuilder
        Returns:
        The bytes for name.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time at which the entitlement is created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface EntitlementOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time at which the entitlement is created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface EntitlementOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time at which the entitlement is created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface EntitlementOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The time at which the entitlement is updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface EntitlementOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time at which the entitlement is updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface EntitlementOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time at which the entitlement is updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface EntitlementOrBuilder

      • getOffer

        public String getOffer()
         Required. The offer resource name for which the entitlement is to be
 created. Takes the form: accounts/{account_id}/offers/{offer_id}.
        string offer = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getOffer in interface EntitlementOrBuilder
        Returns:
        The offer.

      • getOfferBytes

        public com.google.protobuf.ByteString getOfferBytes()
         Required. The offer resource name for which the entitlement is to be
 created. Takes the form: accounts/{account_id}/offers/{offer_id}.
        string offer = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getOfferBytes in interface EntitlementOrBuilder
        Returns:
        The bytes for offer.

      • hasCommitmentSettings

        public boolean hasCommitmentSettings()
         Commitment settings for a commitment-based Offer.
 Required for commitment based offers.
        .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;
        Specified by:
        hasCommitmentSettings in interface EntitlementOrBuilder
        Returns:
        Whether the commitmentSettings field is set.

      • getCommitmentSettings

        public CommitmentSettings getCommitmentSettings()
         Commitment settings for a commitment-based Offer.
 Required for commitment based offers.
        .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;
        Specified by:
        getCommitmentSettings in interface EntitlementOrBuilder
        Returns:
        The commitmentSettings.

      • getProvisioningStateValue

        public int getProvisioningStateValue()
         Output only. Current provisioning state of the entitlement.
        .google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProvisioningStateValue in interface EntitlementOrBuilder
        Returns:
        The enum numeric value on the wire for provisioningState.

      • getProvisioningState

        public Entitlement.ProvisioningState getProvisioningState()
         Output only. Current provisioning state of the entitlement.
        .google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProvisioningState in interface EntitlementOrBuilder
        Returns:
        The provisioningState.

      • hasProvisionedService

        public boolean hasProvisionedService()
         Output only. Service provisioning details for the entitlement.
        .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasProvisionedService in interface EntitlementOrBuilder
        Returns:
        Whether the provisionedService field is set.

      • getProvisionedService

        public ProvisionedService getProvisionedService()
         Output only. Service provisioning details for the entitlement.
        .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProvisionedService in interface EntitlementOrBuilder
        Returns:
        The provisionedService.

      • getSuspensionReasonsList

        public List<Entitlement.SuspensionReason> getSuspensionReasonsList()
         Output only. Enumerable of all current suspension reasons for an
 entitlement.
        repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasonsList in interface EntitlementOrBuilder
        Returns:
        A list containing the suspensionReasons.

      • getSuspensionReasonsCount

        public int getSuspensionReasonsCount()
         Output only. Enumerable of all current suspension reasons for an
 entitlement.
        repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasonsCount in interface EntitlementOrBuilder
        Returns:
        The count of suspensionReasons.

      • getSuspensionReasons

        public Entitlement.SuspensionReason getSuspensionReasons​(int index)
         Output only. Enumerable of all current suspension reasons for an
 entitlement.
        repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasons in interface EntitlementOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The suspensionReasons at the given index.

      • getSuspensionReasonsValueList

        public List<Integer> getSuspensionReasonsValueList()
         Output only. Enumerable of all current suspension reasons for an
 entitlement.
        repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasonsValueList in interface EntitlementOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for suspensionReasons.

      • getSuspensionReasonsValue

        public int getSuspensionReasonsValue​(int index)
         Output only. Enumerable of all current suspension reasons for an
 entitlement.
        repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasonsValue in interface EntitlementOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of suspensionReasons at the given index.

      • getPurchaseOrderId

        public String getPurchaseOrderId()
         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. This is only supported for Google
 Workspace entitlements.
        string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPurchaseOrderId in interface EntitlementOrBuilder
        Returns:
        The purchaseOrderId.

      • getPurchaseOrderIdBytes

        public com.google.protobuf.ByteString getPurchaseOrderIdBytes()
         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. This is only supported for Google
 Workspace entitlements.
        string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPurchaseOrderIdBytes in interface EntitlementOrBuilder
        Returns:
        The bytes for purchaseOrderId.

      • hasTrialSettings

        public boolean hasTrialSettings()
         Output only. Settings for trial offers.
        .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasTrialSettings in interface EntitlementOrBuilder
        Returns:
        Whether the trialSettings field is set.

      • getTrialSettings

        public TrialSettings getTrialSettings()
         Output only. Settings for trial offers.
        .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrialSettings in interface EntitlementOrBuilder
        Returns:
        The trialSettings.

      • hasAssociationInfo

        public boolean hasAssociationInfo()
         Association information to other entitlements.
        .google.cloud.channel.v1.AssociationInfo association_info = 23;
        Specified by:
        hasAssociationInfo in interface EntitlementOrBuilder
        Returns:
        Whether the associationInfo field is set.

      • getAssociationInfo

        public AssociationInfo getAssociationInfo()
         Association information to other entitlements.
        .google.cloud.channel.v1.AssociationInfo association_info = 23;
        Specified by:
        getAssociationInfo in interface EntitlementOrBuilder
        Returns:
        The associationInfo.

      • getParametersList

        public List<Parameter> getParametersList()
         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].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
        repeated .google.cloud.channel.v1.Parameter parameters = 26;
        Specified by:
        getParametersList in interface EntitlementOrBuilder

      • getParametersOrBuilderList

        public List<? extends ParameterOrBuilder> getParametersOrBuilderList()
         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].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
        repeated .google.cloud.channel.v1.Parameter parameters = 26;
        Specified by:
        getParametersOrBuilderList in interface EntitlementOrBuilder

      • getParametersCount

        public int getParametersCount()
         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].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
        repeated .google.cloud.channel.v1.Parameter parameters = 26;
        Specified by:
        getParametersCount in interface EntitlementOrBuilder

      • getParameters

        public Parameter getParameters​(int index)
         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].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
        repeated .google.cloud.channel.v1.Parameter parameters = 26;
        Specified by:
        getParameters in interface EntitlementOrBuilder

      • getParametersOrBuilder

        public ParameterOrBuilder getParametersOrBuilder​(int index)
         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].

 For Google Workspace, the following Parameters may be accepted as input:

 - max_units: The maximum assignable units for a flexible offer

 OR

 - num_units: The total commitment for commitment-based offers

 The response may additionally include the following output-only Parameters:

 - assigned_units: The number of licenses assigned to users.

 For Google Cloud billing subaccounts, the following Parameter may be
 accepted as input:

 - display_name: The display name of the billing subaccount.
        repeated .google.cloud.channel.v1.Parameter parameters = 26;
        Specified by:
        getParametersOrBuilder in interface EntitlementOrBuilder

      • getBillingAccount

        public String getBillingAccount()
         Optional. The billing account resource name that is used to pay for this
 entitlement.
        string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBillingAccount in interface EntitlementOrBuilder
        Returns:
        The billingAccount.

      • getBillingAccountBytes

        public com.google.protobuf.ByteString getBillingAccountBytes()
         Optional. The billing account resource name that is used to pay for this
 entitlement.
        string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getBillingAccountBytes in interface EntitlementOrBuilder
        Returns:
        The bytes for billingAccount.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Entitlement parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Entitlement parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Entitlement parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Entitlement parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Entitlement parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Entitlement parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Entitlement parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Entitlement.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Entitlement.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Entitlement.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Entitlement getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Entitlement> parser()

      • getParserForType

        public com.google.protobuf.Parser<Entitlement> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Entitlement getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder