Class Entitlement.Builder (3.8.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

Inheritance

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

Implements

EntitlementOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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. The response may include the following output-only Parameters:

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

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)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Parameter

Name	Description
value	`Parameter`

Returns

Type	Description
Entitlement.Builder

addParameters(Parameter.Builder builderForValue)

public Entitlement.Builder addParameters(Parameter.Builder builderForValue)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Parameter

Name	Description
builderForValue	`Parameter.Builder`

Returns

Type	Description
Entitlement.Builder

addParameters(int index, Parameter value)

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

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

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)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Parameters

Name	Description
index	`int`
builderForValue	`Parameter.Builder`

Returns

Type	Description
Entitlement.Builder

addParametersBuilder()

public Parameter.Builder addParametersBuilder()

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Returns

Type	Description
Parameter.Builder

addParametersBuilder(int index)

public Parameter.Builder addParametersBuilder(int index)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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.SuspensionReason` The 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	`int` The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAssociationInfo()

public Entitlement.Builder clearAssociationInfo()

Association information to other entitlements.

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

Returns

Type	Description
Entitlement.Builder

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParameters()

public Entitlement.Builder clearParameters()

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Parameter

getParametersBuilder(int index)

public Parameter.Builder getParametersBuilder(int index)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Parameter.Builder

getParametersBuilderList()

public List<Parameter.Builder> getParametersBuilderList()

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Returns

Type	Description
List<Builder>

getParametersCount()

public int getParametersCount()

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Returns

Type	Description
int

getParametersList()

public List<Parameter> getParametersList()

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Returns

Type	Description
List<Parameter>

getParametersOrBuilder(int index)

public ParameterOrBuilder getParametersOrBuilder(int index)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

Parameter

Name	Description
index	`int`

Returns

Type	Description
ParameterOrBuilder

getParametersOrBuilderList()

public List<? extends ParameterOrBuilder> getParametersOrBuilderList()

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

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()

string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The purchaseOrderId.

getPurchaseOrderIdBytes()

public ByteString getPurchaseOrderIdBytes()

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	`int` The index of the element to return.

Returns

Type	Description
Entitlement.SuspensionReason	The suspensionReasons at the given index.

getSuspensionReasonsCount()

public int getSuspensionReasonsCount()

Output only. Enumerable of all current suspension reasons for an entitlement.

repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int	The count of suspensionReasons.

getSuspensionReasonsList()

public List<Entitlement.SuspensionReason> getSuspensionReasonsList()

Output only. Enumerable of all current suspension reasons for an entitlement.

repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
List<SuspensionReason>	A list containing the suspensionReasons.

getSuspensionReasonsValue(int index)

public int getSuspensionReasonsValue(int index)

Output only. Enumerable of all current suspension reasons for an entitlement.

repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
int	The enum numeric value on the wire of suspensionReasons at the given index.

getSuspensionReasonsValueList()

public List<Integer> getSuspensionReasonsValueList()

Output only. Enumerable of all current suspension reasons for an entitlement.

repeated .google.cloud.channel.v1.Entitlement.SuspensionReason suspension_reasons = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
List<Integer>	A list containing the enum numeric values on the wire for suspensionReasons.

getTrialSettings()

public TrialSettings getTrialSettings()

Output only. Settings for trial offers.

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

Returns

Type	Description
TrialSettings	The trialSettings.

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Entitlement.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
Entitlement.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

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

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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	`String` The 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	`ByteString` The 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	`String` The 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	`ByteString` The 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)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

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)

assigned_units: The number of licenses assigned to users.
max_units: The maximum assignable units for a flexible offer.
num_units: The total commitment for commitment-based offers.

repeated .google.cloud.channel.v1.Parameter parameters = 26;

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.ProvisioningState` The 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	`int` The 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)

string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`String` The purchaseOrderId to set.

Returns

Type	Description
Entitlement.Builder	This builder for chaining.

setPurchaseOrderIdBytes(ByteString value)

public Entitlement.Builder setPurchaseOrderIdBytes(ByteString value)

string purchase_order_id = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`ByteString` The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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	`int` The index to set the value at.
value	`Entitlement.SuspensionReason` The 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	`int` The index to set the value at.
value	`int` The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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