/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/channel/v1/entitlements.proto
package com.google.cloud.channel.v1;
public interface EntitlementOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.channel.v1.Entitlement)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. The time at which the entitlement is created.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time at which the entitlement is created.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time at which the entitlement is created.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The time at which the entitlement is updated.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The time at which the entitlement is updated.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. The time at which the entitlement is updated.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* 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) = { ... }
*
*
* @return The offer.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for offer.
*/
com.google.protobuf.ByteString getOfferBytes();
/**
*
*
*
* Commitment settings for a commitment-based Offer.
* Required for commitment based offers.
*
*
* .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;
*
* @return Whether the commitmentSettings field is set.
*/
boolean hasCommitmentSettings();
/**
*
*
*
* Commitment settings for a commitment-based Offer.
* Required for commitment based offers.
*
*
* .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;
*
* @return The commitmentSettings.
*/
com.google.cloud.channel.v1.CommitmentSettings getCommitmentSettings();
/**
*
*
*
* Commitment settings for a commitment-based Offer.
* Required for commitment based offers.
*
*
* .google.cloud.channel.v1.CommitmentSettings commitment_settings = 12;
*/
com.google.cloud.channel.v1.CommitmentSettingsOrBuilder getCommitmentSettingsOrBuilder();
/**
*
*
*
* Output only. Current provisioning state of the entitlement.
*
*
*
* .google.cloud.channel.v1.Entitlement.ProvisioningState provisioning_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for provisioningState.
*/
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];
*
*
* @return The provisioningState.
*/
com.google.cloud.channel.v1.Entitlement.ProvisioningState getProvisioningState();
/**
*
*
*
* Output only. Service provisioning details for the entitlement.
*
*
*
* .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the provisionedService field is set.
*/
boolean hasProvisionedService();
/**
*
*
*
* Output only. Service provisioning details for the entitlement.
*
*
*
* .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The provisionedService.
*/
com.google.cloud.channel.v1.ProvisionedService getProvisionedService();
/**
*
*
*
* Output only. Service provisioning details for the entitlement.
*
*
*
* .google.cloud.channel.v1.ProvisionedService provisioned_service = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.channel.v1.ProvisionedServiceOrBuilder getProvisionedServiceOrBuilder();
/**
*
*
*
* 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];
*
*
* @return A list containing the suspensionReasons.
*/
java.util.List
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];
*
*
* @return The count of suspensionReasons.
*/
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];
*
*
* @param index The index of the element to return.
* @return The suspensionReasons at the given index.
*/
com.google.cloud.channel.v1.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];
*
*
* @return A list containing the enum numeric values on the wire for suspensionReasons.
*/
java.util.List 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];
*
*
* @param index The index of the value to return.
* @return The enum numeric value on the wire of suspensionReasons at the given index.
*/
int getSuspensionReasonsValue(int index);
/**
*
*
*
* 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];
*
* @return The purchaseOrderId.
*/
java.lang.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];
*
* @return The bytes for purchaseOrderId.
*/
com.google.protobuf.ByteString getPurchaseOrderIdBytes();
/**
*
*
*
* Output only. Settings for trial offers.
*
*
*
* .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the trialSettings field is set.
*/
boolean hasTrialSettings();
/**
*
*
*
* Output only. Settings for trial offers.
*
*
*
* .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The trialSettings.
*/
com.google.cloud.channel.v1.TrialSettings getTrialSettings();
/**
*
*
*
* Output only. Settings for trial offers.
*
*
*
* .google.cloud.channel.v1.TrialSettings trial_settings = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.channel.v1.TrialSettingsOrBuilder getTrialSettingsOrBuilder();
/**
*
*
*
* Association information to other entitlements.
*
*
* .google.cloud.channel.v1.AssociationInfo association_info = 23;
*
* @return Whether the associationInfo field is set.
*/
boolean hasAssociationInfo();
/**
*
*
*
* Association information to other entitlements.
*
*
* .google.cloud.channel.v1.AssociationInfo association_info = 23;
*
* @return The associationInfo.
*/
com.google.cloud.channel.v1.AssociationInfo getAssociationInfo();
/**
*
*
*
* Association information to other entitlements.
*
*
* .google.cloud.channel.v1.AssociationInfo association_info = 23;
*/
com.google.cloud.channel.v1.AssociationInfoOrBuilder getAssociationInfoOrBuilder();
/**
*
*
*
* Extended entitlement parameters. When creating an entitlement, valid
* parameter names and values are defined in the
* [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].
* For Google Workspace, the following Parameters may be accepted as input:
* - max_units: The maximum assignable units for a flexible offer
* OR
* - num_units: The total commitment for commitment-based offers
* The response may additionally include the following output-only Parameters:
* - assigned_units: The number of licenses assigned to users.
* For GCP billing subaccounts, the following Parameter may be accepted as
* input:
* - display_name: The display name of the billing subaccount.
*
*
* repeated .google.cloud.channel.v1.Parameter parameters = 26;
*/
java.util.List getParametersList();
/**
*
*
*
* Extended entitlement parameters. When creating an entitlement, valid
* parameter names and values are defined in the
* [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].
* For Google Workspace, the following Parameters may be accepted as input:
* - max_units: The maximum assignable units for a flexible offer
* OR
* - num_units: The total commitment for commitment-based offers
* The response may additionally include the following output-only Parameters:
* - assigned_units: The number of licenses assigned to users.
* For GCP billing subaccounts, the following Parameter may be accepted as
* input:
* - display_name: The display name of the billing subaccount.
*
*
* repeated .google.cloud.channel.v1.Parameter parameters = 26;
*/
com.google.cloud.channel.v1.Parameter getParameters(int index);
/**
*
*
*
* Extended entitlement parameters. When creating an entitlement, valid
* parameter names and values are defined in the
* [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].
* For Google Workspace, the following Parameters may be accepted as input:
* - max_units: The maximum assignable units for a flexible offer
* OR
* - num_units: The total commitment for commitment-based offers
* The response may additionally include the following output-only Parameters:
* - assigned_units: The number of licenses assigned to users.
* For GCP billing subaccounts, the following Parameter may be accepted as
* input:
* - display_name: The display name of the billing subaccount.
*
*
* repeated .google.cloud.channel.v1.Parameter parameters = 26;
*/
int getParametersCount();
/**
*
*
*
* Extended entitlement parameters. When creating an entitlement, valid
* parameter names and values are defined in the
* [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].
* For Google Workspace, the following Parameters may be accepted as input:
* - max_units: The maximum assignable units for a flexible offer
* OR
* - num_units: The total commitment for commitment-based offers
* The response may additionally include the following output-only Parameters:
* - assigned_units: The number of licenses assigned to users.
* For GCP billing subaccounts, the following Parameter may be accepted as
* input:
* - display_name: The display name of the billing subaccount.
*
*
* repeated .google.cloud.channel.v1.Parameter parameters = 26;
*/
java.util.List
getParametersOrBuilderList();
/**
*
*
*
* Extended entitlement parameters. When creating an entitlement, valid
* parameter names and values are defined in the
* [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions].
* For Google Workspace, the following Parameters may be accepted as input:
* - max_units: The maximum assignable units for a flexible offer
* OR
* - num_units: The total commitment for commitment-based offers
* The response may additionally include the following output-only Parameters:
* - assigned_units: The number of licenses assigned to users.
* For GCP billing subaccounts, the following Parameter may be accepted as
* input:
* - display_name: The display name of the billing subaccount.
*
*
* repeated .google.cloud.channel.v1.Parameter parameters = 26;
*/
com.google.cloud.channel.v1.ParameterOrBuilder getParametersOrBuilder(int index);
/**
*
*
*
* Optional. The billing account resource name that is used to pay for this
* entitlement.
*
*
* string billing_account = 28 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The billingAccount.
*/
java.lang.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];
*
* @return The bytes for billingAccount.
*/
com.google.protobuf.ByteString getBillingAccountBytes();
}