Class Entitlement.Builder (3.31.0)

public static final class Entitlement.Builder extends GeneratedMessageV3.Builder<Entitlement.Builder> implements EntitlementOrBuilder

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

Protobuf type google.cloud.channel.v1.Entitlement

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllParameters(Iterable<? extends Parameter> values)

public Entitlement.Builder addAllParameters(Iterable<? extends Parameter> values)

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
NameDescription
valuesIterable<? extends com.google.cloud.channel.v1.Parameter>
Returns
TypeDescription
Entitlement.Builder

addAllSuspensionReasons(Iterable<? extends Entitlement.SuspensionReason> values)

public Entitlement.Builder addAllSuspensionReasons(Iterable<? extends Entitlement.SuspensionReason> values)

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
NameDescription
valuesIterable<? extends com.google.cloud.channel.v1.Entitlement.SuspensionReason>

The suspensionReasons to add.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

addAllSuspensionReasonsValue(Iterable<Integer> values)

public Entitlement.Builder addAllSuspensionReasonsValue(Iterable<Integer> values)

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
NameDescription
valuesIterable<Integer>

The enum numeric values on the wire for suspensionReasons to add.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

addParameters(Parameter value)

public Entitlement.Builder addParameters(Parameter value)

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
NameDescription
valueParameter
Returns
TypeDescription
Entitlement.Builder

addParameters(Parameter.Builder builderForValue)

public Entitlement.Builder addParameters(Parameter.Builder builderForValue)

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
NameDescription
builderForValueParameter.Builder
Returns
TypeDescription
Entitlement.Builder

addParameters(int index, Parameter value)

public Entitlement.Builder addParameters(int index, Parameter value)

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;

Parameters
NameDescription
indexint
valueParameter
Returns
TypeDescription
Entitlement.Builder

addParameters(int index, Parameter.Builder builderForValue)

public Entitlement.Builder addParameters(int index, Parameter.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueParameter.Builder
Returns
TypeDescription
Entitlement.Builder

addParametersBuilder()

public Parameter.Builder addParametersBuilder()

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
TypeDescription
Parameter.Builder

addParametersBuilder(int index)

public Parameter.Builder addParametersBuilder(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
NameDescription
indexint
Returns
TypeDescription
Parameter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Entitlement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Entitlement.Builder
Overrides

addSuspensionReasons(Entitlement.SuspensionReason value)

public Entitlement.Builder addSuspensionReasons(Entitlement.SuspensionReason value)

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
NameDescription
valueEntitlement.SuspensionReason

The suspensionReasons to add.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

addSuspensionReasonsValue(int value)

public Entitlement.Builder addSuspensionReasonsValue(int value)

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
NameDescription
valueint

The enum numeric value on the wire for suspensionReasons to add.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

build()

public Entitlement build()
Returns
TypeDescription
Entitlement

buildPartial()

public Entitlement buildPartial()
Returns
TypeDescription
Entitlement

clear()

public Entitlement.Builder clear()
Returns
TypeDescription
Entitlement.Builder
Overrides

clearAssociationInfo()

public Entitlement.Builder clearAssociationInfo()

Association information to other entitlements.

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

Returns
TypeDescription
Entitlement.Builder

clearBillingAccount()

public Entitlement.Builder clearBillingAccount()

Optional. The billing account resource name that is used to pay for this entitlement.

string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

clearCommitmentSettings()

public Entitlement.Builder clearCommitmentSettings()

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

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

Returns
TypeDescription
Entitlement.Builder

clearCreateTime()

public Entitlement.Builder clearCreateTime()

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

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

Returns
TypeDescription
Entitlement.Builder

clearField(Descriptors.FieldDescriptor field)

public Entitlement.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Entitlement.Builder
Overrides

clearName()

public Entitlement.Builder clearName()

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
TypeDescription
Entitlement.Builder

This builder for chaining.

clearOffer()

public Entitlement.Builder clearOffer()

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
TypeDescription
Entitlement.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Entitlement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Entitlement.Builder
Overrides

clearParameters()

public Entitlement.Builder clearParameters()

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
TypeDescription
Entitlement.Builder

clearProvisionedService()

public Entitlement.Builder clearProvisionedService()

Output only. Service provisioning details for the entitlement.

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

Returns
TypeDescription
Entitlement.Builder

clearProvisioningState()

public Entitlement.Builder clearProvisioningState()

Output only. Current provisioning state of the entitlement.

.google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

clearPurchaseOrderId()

public Entitlement.Builder clearPurchaseOrderId()

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
TypeDescription
Entitlement.Builder

This builder for chaining.

clearSuspensionReasons()

public Entitlement.Builder clearSuspensionReasons()

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
TypeDescription
Entitlement.Builder

This builder for chaining.

clearTrialSettings()

public Entitlement.Builder clearTrialSettings()

Output only. Settings for trial offers.

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

Returns
TypeDescription
Entitlement.Builder

clearUpdateTime()

public Entitlement.Builder clearUpdateTime()

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

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

Returns
TypeDescription
Entitlement.Builder

clone()

public Entitlement.Builder clone()
Returns
TypeDescription
Entitlement.Builder
Overrides

getAssociationInfo()

public AssociationInfo getAssociationInfo()

Association information to other entitlements.

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

Returns
TypeDescription
AssociationInfo

The associationInfo.

getAssociationInfoBuilder()

public AssociationInfo.Builder getAssociationInfoBuilder()

Association information to other entitlements.

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

Returns
TypeDescription
AssociationInfo.Builder

getAssociationInfoOrBuilder()

public AssociationInfoOrBuilder getAssociationInfoOrBuilder()

Association information to other entitlements.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
CommitmentSettings

The commitmentSettings.

getCommitmentSettingsBuilder()

public CommitmentSettings.Builder getCommitmentSettingsBuilder()

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

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

Returns
TypeDescription
CommitmentSettings.Builder

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
TypeDescription
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
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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

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

Returns
TypeDescription
Builder

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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Entitlement getDefaultInstanceForType()
Returns
TypeDescription
Entitlement

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Parameter

getParametersBuilder(int index)

public Parameter.Builder getParametersBuilder(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
NameDescription
indexint
Returns
TypeDescription
Parameter.Builder

getParametersBuilderList()

public List<Parameter.Builder> getParametersBuilderList()

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
TypeDescription
List<Builder>

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.channel.v1.ParameterOrBuilder>

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
TypeDescription
ProvisionedService

The provisionedService.

getProvisionedServiceBuilder()

public ProvisionedService.Builder getProvisionedServiceBuilder()

Output only. Service provisioning details for the entitlement.

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

Returns
TypeDescription
ProvisionedService.Builder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for purchaseOrderId.

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TrialSettings

The trialSettings.

getTrialSettingsBuilder()

public TrialSettings.Builder getTrialSettingsBuilder()

Output only. Settings for trial offers.

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

Returns
TypeDescription
TrialSettings.Builder

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
TypeDescription
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
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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

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

Returns
TypeDescription
Builder

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
TypeDescription
TimestampOrBuilder

hasAssociationInfo()

public boolean hasAssociationInfo()

Association information to other entitlements.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAssociationInfo(AssociationInfo value)

public Entitlement.Builder mergeAssociationInfo(AssociationInfo value)

Association information to other entitlements.

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

Parameter
NameDescription
valueAssociationInfo
Returns
TypeDescription
Entitlement.Builder

mergeCommitmentSettings(CommitmentSettings value)

public Entitlement.Builder mergeCommitmentSettings(CommitmentSettings value)

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

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

Parameter
NameDescription
valueCommitmentSettings
Returns
TypeDescription
Entitlement.Builder

mergeCreateTime(Timestamp value)

public Entitlement.Builder mergeCreateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Entitlement.Builder

mergeFrom(Entitlement other)

public Entitlement.Builder mergeFrom(Entitlement other)
Parameter
NameDescription
otherEntitlement
Returns
TypeDescription
Entitlement.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Entitlement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Entitlement.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Entitlement.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Entitlement.Builder
Overrides

mergeProvisionedService(ProvisionedService value)

public Entitlement.Builder mergeProvisionedService(ProvisionedService value)

Output only. Service provisioning details for the entitlement.

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

Parameter
NameDescription
valueProvisionedService
Returns
TypeDescription
Entitlement.Builder

mergeTrialSettings(TrialSettings value)

public Entitlement.Builder mergeTrialSettings(TrialSettings value)

Output only. Settings for trial offers.

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

Parameter
NameDescription
valueTrialSettings
Returns
TypeDescription
Entitlement.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Entitlement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Entitlement.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Entitlement.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Entitlement.Builder

removeParameters(int index)

public Entitlement.Builder removeParameters(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
NameDescription
indexint
Returns
TypeDescription
Entitlement.Builder

setAssociationInfo(AssociationInfo value)

public Entitlement.Builder setAssociationInfo(AssociationInfo value)

Association information to other entitlements.

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

Parameter
NameDescription
valueAssociationInfo
Returns
TypeDescription
Entitlement.Builder

setAssociationInfo(AssociationInfo.Builder builderForValue)

public Entitlement.Builder setAssociationInfo(AssociationInfo.Builder builderForValue)

Association information to other entitlements.

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

Parameter
NameDescription
builderForValueAssociationInfo.Builder
Returns
TypeDescription
Entitlement.Builder

setBillingAccount(String value)

public Entitlement.Builder setBillingAccount(String value)

Optional. The billing account resource name that is used to pay for this entitlement.

string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The billingAccount to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setBillingAccountBytes(ByteString value)

public Entitlement.Builder setBillingAccountBytes(ByteString value)

Optional. The billing account resource name that is used to pay for this entitlement.

string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for billingAccount to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setCommitmentSettings(CommitmentSettings value)

public Entitlement.Builder setCommitmentSettings(CommitmentSettings value)

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

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

Parameter
NameDescription
valueCommitmentSettings
Returns
TypeDescription
Entitlement.Builder

setCommitmentSettings(CommitmentSettings.Builder builderForValue)

public Entitlement.Builder setCommitmentSettings(CommitmentSettings.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueCommitmentSettings.Builder
Returns
TypeDescription
Entitlement.Builder

setCreateTime(Timestamp value)

public Entitlement.Builder setCreateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Entitlement.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Entitlement.Builder setCreateTime(Timestamp.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Entitlement.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Entitlement.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Entitlement.Builder
Overrides

setName(String value)

public Entitlement.Builder setName(String value)

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Entitlement.Builder setNameBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setOffer(String value)

public Entitlement.Builder setOffer(String value)

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

Parameter
NameDescription
valueString

The offer to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setOfferBytes(ByteString value)

public Entitlement.Builder setOfferBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for offer to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setParameters(int index, Parameter value)

public Entitlement.Builder setParameters(int index, Parameter value)

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;

Parameters
NameDescription
indexint
valueParameter
Returns
TypeDescription
Entitlement.Builder

setParameters(int index, Parameter.Builder builderForValue)

public Entitlement.Builder setParameters(int index, Parameter.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueParameter.Builder
Returns
TypeDescription
Entitlement.Builder

setProvisionedService(ProvisionedService value)

public Entitlement.Builder setProvisionedService(ProvisionedService value)

Output only. Service provisioning details for the entitlement.

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

Parameter
NameDescription
valueProvisionedService
Returns
TypeDescription
Entitlement.Builder

setProvisionedService(ProvisionedService.Builder builderForValue)

public Entitlement.Builder setProvisionedService(ProvisionedService.Builder builderForValue)

Output only. Service provisioning details for the entitlement.

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

Parameter
NameDescription
builderForValueProvisionedService.Builder
Returns
TypeDescription
Entitlement.Builder

setProvisioningState(Entitlement.ProvisioningState value)

public Entitlement.Builder setProvisioningState(Entitlement.ProvisioningState value)

Output only. Current provisioning state of the entitlement.

.google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueEntitlement.ProvisioningState

The provisioningState to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setProvisioningStateValue(int value)

public Entitlement.Builder setProvisioningStateValue(int value)

Output only. Current provisioning state of the entitlement.

.google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for provisioningState to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setPurchaseOrderId(String value)

public Entitlement.Builder setPurchaseOrderId(String value)

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

Parameter
NameDescription
valueString

The purchaseOrderId to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setPurchaseOrderIdBytes(ByteString value)

public Entitlement.Builder setPurchaseOrderIdBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for purchaseOrderId to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Entitlement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Entitlement.Builder
Overrides

setSuspensionReasons(int index, Entitlement.SuspensionReason value)

public Entitlement.Builder setSuspensionReasons(int index, Entitlement.SuspensionReason value)

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

Parameters
NameDescription
indexint

The index to set the value at.

valueEntitlement.SuspensionReason

The suspensionReasons to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setSuspensionReasonsValue(int index, int value)

public Entitlement.Builder setSuspensionReasonsValue(int index, int value)

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

Parameters
NameDescription
indexint

The index to set the value at.

valueint

The enum numeric value on the wire for suspensionReasons to set.

Returns
TypeDescription
Entitlement.Builder

This builder for chaining.

setTrialSettings(TrialSettings value)

public Entitlement.Builder setTrialSettings(TrialSettings value)

Output only. Settings for trial offers.

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

Parameter
NameDescription
valueTrialSettings
Returns
TypeDescription
Entitlement.Builder

setTrialSettings(TrialSettings.Builder builderForValue)

public Entitlement.Builder setTrialSettings(TrialSettings.Builder builderForValue)

Output only. Settings for trial offers.

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

Parameter
NameDescription
builderForValueTrialSettings.Builder
Returns
TypeDescription
Entitlement.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Entitlement.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Entitlement.Builder
Overrides

setUpdateTime(Timestamp value)

public Entitlement.Builder setUpdateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Entitlement.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Entitlement.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Entitlement.Builder