Interface EntitlementOrBuilder (3.18.0)

Version 3.18.0

• 3.58.0 (latest)
• 3.57.0
• 3.56.0
• 3.55.0
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.6
• 3.6.1
• 3.5.1
• 3.3.1

public interface EntitlementOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssociationInfo()

public abstract AssociationInfo getAssociationInfo()

Association information to other entitlements.

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

Returns
Type	Description
AssociationInfo	The associationInfo.

getAssociationInfoOrBuilder()

public abstract AssociationInfoOrBuilder getAssociationInfoOrBuilder()

Association information to other entitlements.

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

Returns
Type	Description
AssociationInfoOrBuilder

getCommitmentSettings()

public abstract 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 abstract 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 abstract 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 abstract 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

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 GCP 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 abstract 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 GCP 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 abstract 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 GCP 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 abstract 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 GCP 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 abstract 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 GCP 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>

getProvisionedService()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getSuspensionReasons(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.