Class Entitlement (3.48.0) 

public final class Entitlement extends GeneratedMessageV3 implements EntitlementOrBuilder

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

Protobuf type google.cloud.channel.v1.Entitlement

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Entitlement

Static Fields

ASSOCIATION_INFO_FIELD_NUMBER

public static final int ASSOCIATION_INFO_FIELD_NUMBER
Field Value
Type Description
int

BILLING_ACCOUNT_FIELD_NUMBER

public static final int BILLING_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

COMMITMENT_SETTINGS_FIELD_NUMBER

public static final int COMMITMENT_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OFFER_FIELD_NUMBER

public static final int OFFER_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

PROVISIONED_SERVICE_FIELD_NUMBER

public static final int PROVISIONED_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

PROVISIONING_STATE_FIELD_NUMBER

public static final int PROVISIONING_STATE_FIELD_NUMBER
Field Value
Type Description
int

PURCHASE_ORDER_ID_FIELD_NUMBER

public static final int PURCHASE_ORDER_ID_FIELD_NUMBER
Field Value
Type Description
int

SUSPENSION_REASONS_FIELD_NUMBER

public static final int SUSPENSION_REASONS_FIELD_NUMBER
Field Value
Type Description
int

TRIAL_SETTINGS_FIELD_NUMBER

public static final int TRIAL_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Entitlement getDefaultInstance()
Returns
Type Description
Entitlement

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Entitlement.Builder newBuilder()
Returns
Type Description
Entitlement.Builder

newBuilder(Entitlement prototype)

public static Entitlement.Builder newBuilder(Entitlement prototype)
Parameter
Name Description
prototype Entitlement
Returns
Type Description
Entitlement.Builder

parseDelimitedFrom(InputStream input)

public static Entitlement parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Entitlement
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entitlement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entitlement
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Entitlement parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Entitlement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Entitlement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entitlement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Entitlement parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Entitlement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Entitlement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entitlement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Entitlement parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Entitlement
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Entitlement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entitlement
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Entitlement parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Entitlement
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entitlement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entitlement
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Entitlement parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Entitlement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Entitlement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entitlement
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Entitlement> parser()
Returns
Type Description
Parser<Entitlement>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAssociationInfo()

public AssociationInfo getAssociationInfo()

Association information to other entitlements.

.google.cloud.channel.v1.AssociationInfo association_info = 23;

Returns
Type Description
AssociationInfo

The associationInfo.

getAssociationInfoOrBuilder()

public AssociationInfoOrBuilder getAssociationInfoOrBuilder()

Association information to other entitlements.

.google.cloud.channel.v1.AssociationInfo association_info = 23;

Returns
Type Description
AssociationInfoOrBuilder

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];

Returns
Type Description
String

The billingAccount.

getBillingAccountBytes()

public 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];

Returns
Type Description
ByteString

The bytes for billingAccount.

getCommitmentSettings()

public CommitmentSettings getCommitmentSettings()

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

.google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;

Returns
Type Description
CommitmentSettings

The commitmentSettings.

getCommitmentSettingsOrBuilder()

public CommitmentSettingsOrBuilder getCommitmentSettingsOrBuilder()

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

.google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;

Returns
Type Description
CommitmentSettingsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Entitlement getDefaultInstanceForType()
Returns
Type Description
Entitlement

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];

Returns
Type Description
String

The name.

getNameBytes()

public 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];

Returns
Type Description
ByteString

The bytes for name.

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) = { ... }

Returns
Type Description
String

The offer.

getOfferBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for offer.

getParameters(int index)

public Parameter getParameters(int index)

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the 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;

Parameter
Name Description
index int
Returns
Type Description
Parameter

getParametersCount()

public int getParametersCount()

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the 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;

Returns
Type Description
int

getParametersList()

public List<Parameter> getParametersList()

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the 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;

Returns
Type Description
List<Parameter>

getParametersOrBuilder(int index)

public ParameterOrBuilder getParametersOrBuilder(int index)

Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the 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;

Parameter
Name Description
index int
Returns
Type Description
ParameterOrBuilder

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.

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;

Returns
Type Description
List<? extends com.google.cloud.channel.v1.ParameterOrBuilder>

getParserForType()

public Parser<Entitlement> getParserForType()
Returns
Type Description
Parser<Entitlement>
Overrides

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];

Returns
Type Description
ProvisionedService

The provisionedService.

getProvisionedServiceOrBuilder()

public ProvisionedServiceOrBuilder getProvisionedServiceOrBuilder()

Output only. Service provisioning details for the entitlement.

.google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProvisionedServiceOrBuilder

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];

Returns
Type Description
Entitlement.ProvisioningState

The provisioningState.

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];

Returns
Type Description
int

The enum numeric value on the wire for provisioningState.

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];

Returns
Type Description
String

The purchaseOrderId.

getPurchaseOrderIdBytes()

public 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];

Returns
Type Description
ByteString

The bytes for purchaseOrderId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSuspensionReasons(int index)

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];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
Entitlement.SuspensionReason

The suspensionReasons at the given index.

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];

Returns
Type Description
int

The count of suspensionReasons.

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];

Returns
Type Description
List<SuspensionReason>

A list containing the suspensionReasons.

getSuspensionReasonsValue(int index)

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];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of 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];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for suspensionReasons.

getTrialSettings()

public TrialSettings getTrialSettings()

Output only. Settings for trial offers.

.google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TrialSettings

The trialSettings.

getTrialSettingsOrBuilder()

public TrialSettingsOrBuilder getTrialSettingsOrBuilder()

Output only. Settings for trial offers.

.google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TrialSettingsOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAssociationInfo()

public boolean hasAssociationInfo()

Association information to other entitlements.

.google.cloud.channel.v1.AssociationInfo association_info = 23;

Returns
Type Description
boolean

Whether the associationInfo field is set.

hasCommitmentSettings()

public boolean hasCommitmentSettings()

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

.google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;

Returns
Type Description
boolean

Whether the commitmentSettings field is set.

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];

Returns
Type Description
boolean

Whether the createTime field is set.

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];

Returns
Type Description
boolean

Whether the provisionedService field is set.

hasTrialSettings()

public boolean hasTrialSettings()

Output only. Settings for trial offers.

.google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the trialSettings field is set.

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];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Entitlement.Builder newBuilderForType()
Returns
Type Description
Entitlement.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Entitlement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Entitlement.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Entitlement.Builder toBuilder()
Returns
Type Description
Entitlement.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException