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
Static Fields
ASSOCIATION_INFO_FIELD_NUMBER
public static final int ASSOCIATION_INFO_FIELD_NUMBER
Field Value
COMMITMENT_SETTINGS_FIELD_NUMBER
public static final int COMMITMENT_SETTINGS_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
OFFER_FIELD_NUMBER
public static final int OFFER_FIELD_NUMBER
Field Value
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
Field Value
PROVISIONED_SERVICE_FIELD_NUMBER
public static final int PROVISIONED_SERVICE_FIELD_NUMBER
Field Value
PROVISIONING_STATE_FIELD_NUMBER
public static final int PROVISIONING_STATE_FIELD_NUMBER
Field Value
PURCHASE_ORDER_ID_FIELD_NUMBER
public static final int PURCHASE_ORDER_ID_FIELD_NUMBER
Field Value
SUSPENSION_REASONS_FIELD_NUMBER
public static final int SUSPENSION_REASONS_FIELD_NUMBER
Field Value
TRIAL_SETTINGS_FIELD_NUMBER
public static final int TRIAL_SETTINGS_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Entitlement getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Entitlement.Builder newBuilder()
Returns
newBuilder(Entitlement prototype)
public static Entitlement.Builder newBuilder(Entitlement prototype)
Parameter
Returns
public static Entitlement parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Entitlement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Entitlement parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Entitlement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Entitlement parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Entitlement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Entitlement parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Entitlement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Entitlement parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Entitlement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Entitlement parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Entitlement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Entitlement> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAssociationInfo()
public AssociationInfo getAssociationInfo()
Association information to other entitlements.
.google.cloud.channel.v1.AssociationInfo association_info = 23;
getAssociationInfoOrBuilder()
public AssociationInfoOrBuilder getAssociationInfoOrBuilder()
Association information to other entitlements.
.google.cloud.channel.v1.AssociationInfo association_info = 23;
getCommitmentSettings()
public CommitmentSettings getCommitmentSettings()
Commitment settings for a commitment-based Offer.
Required for commitment based offers.
.google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;
getCommitmentSettingsOrBuilder()
public CommitmentSettingsOrBuilder getCommitmentSettingsOrBuilder()
Commitment settings for a commitment-based Offer.
Required for commitment based offers.
.google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;
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];
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];
getDefaultInstanceForType()
public Entitlement getDefaultInstanceForType()
Returns
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];
| 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];
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) = { ... }
| 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) = { ... }
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.
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.
repeated .google.cloud.channel.v1.Parameter parameters = 26;
getParametersCount()
public int getParametersCount()
Extended entitlement parameters. When creating an entitlement, valid
parameter names and values are defined in the
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.
repeated .google.cloud.channel.v1.Parameter parameters = 26;
getParametersList()
public List<Parameter> getParametersList()
Extended entitlement parameters. When creating an entitlement, valid
parameter names and values are defined in the
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.
repeated .google.cloud.channel.v1.Parameter parameters = 26;
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.
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.
repeated .google.cloud.channel.v1.Parameter parameters = 26;
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.
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.
repeated .google.cloud.channel.v1.Parameter parameters = 26;
| Type | Description |
| List<? extends com.google.cloud.channel.v1.ParameterOrBuilder> | |
getParserForType()
public Parser<Entitlement> getParserForType()
Returns
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];
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];
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];
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];
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for purchaseOrderId.
|
getSerializedSize()
public int getSerializedSize()
Returns
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];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
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];
| 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];
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];
| 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];
| 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];
getTrialSettingsOrBuilder()
public TrialSettingsOrBuilder getTrialSettingsOrBuilder()
Output only. Settings for trial offers.
.google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
hasAssociationInfo()
public boolean hasAssociationInfo()
Association information to other entitlements.
.google.cloud.channel.v1.AssociationInfo association_info = 23;
| 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;
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Entitlement.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Entitlement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Entitlement.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
