- 3.57.0 (latest)
- 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 static final class Entitlement.Builder extends GeneratedMessageV3.Builder<Entitlement.Builder> implements EntitlementOrBuilderAn entitlement is a representation of a customer's ability to use a service.
Protobuf type google.cloud.channel.v1.Entitlement
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Entitlement.BuilderImplements
EntitlementOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.channel.v1.Parameter> |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.channel.v1.Entitlement.SuspensionReason>The suspensionReasons to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values |
Iterable<Integer>The enum numeric values on the wire for suspensionReasons to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
Parameter |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
Parameter.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
value |
Parameter |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Parameter.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Parameter.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Entitlement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
Entitlement.SuspensionReasonThe suspensionReasons to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for suspensionReasons to add. |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
This builder for chaining. |
build()
public Entitlement build()| Returns | |
|---|---|
| Type | Description |
Entitlement |
|
buildPartial()
public Entitlement buildPartial()| Returns | |
|---|---|
| Type | Description |
Entitlement |
|
clear()
public Entitlement.Builder clear()| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
clearAssociationInfo()
public Entitlement.Builder clearAssociationInfo()Association information to other entitlements.
.google.cloud.channel.v1.AssociationInfo association_info = 23;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Entitlement.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entitlement.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Entitlement.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
clone()
public Entitlement.Builder clone()| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
getAssociationInfo()
public AssociationInfo getAssociationInfo()Association information to other entitlements.
.google.cloud.channel.v1.AssociationInfo association_info = 23;
| Returns | |
|---|---|
| Type | Description |
AssociationInfo |
The associationInfo. |
getAssociationInfoBuilder()
public AssociationInfo.Builder getAssociationInfoBuilder()Association information to other entitlements.
.google.cloud.channel.v1.AssociationInfo association_info = 23;
| Returns | |
|---|---|
| Type | Description |
AssociationInfo.Builder |
|
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public Entitlement getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Entitlement |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
|
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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> |
|
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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 |
intThe 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 |
intThe 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAssociationInfo(AssociationInfo value)
public Entitlement.Builder mergeAssociationInfo(AssociationInfo value)Association information to other entitlements.
.google.cloud.channel.v1.AssociationInfo association_info = 23;
| Parameter | |
|---|---|
| Name | Description |
value |
AssociationInfo |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
CommitmentSettings |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeFrom(Entitlement other)
public Entitlement.Builder mergeFrom(Entitlement other)| Parameter | |
|---|---|
| Name | Description |
other |
Entitlement |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Entitlement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Entitlement.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
ProvisionedService |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
TrialSettings |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Entitlement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
AssociationInfo |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
AssociationInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe billingAccount to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for billingAccount to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
CommitmentSettings |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
CommitmentSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Entitlement.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe offer to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for offer to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
value |
Parameter |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Parameter.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ProvisionedService |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
ProvisionedService.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
Entitlement.ProvisioningStateThe provisioningState to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for provisioningState to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe purchaseOrderId to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for purchaseOrderId to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
Entitlement.SuspensionReasonThe suspensionReasons to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for suspensionReasons to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
TrialSettings |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
TrialSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Entitlement.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|