Types for Google Cloud Channel v1 API¶
- class google.cloud.channel_v1.types.ActivateEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ActivateEntitlement][google.cloud.channel.v1.CloudChannelService.ActivateEntitlement].
- name¶
Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.AdminUser(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation needed to create an Admin User for Google Workspace.
- class google.cloud.channel_v1.types.AssociationInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAssociation links that an entitlement has to other entitlements.
- class google.cloud.channel_v1.types.BillableSku(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the Billable SKU information.
- sku¶
Resource name of Billable SKU. Format:
billableSkus/{sku}. Example:
billableSkus/6E1B-6634-470F”.
- Type
- service¶
Resource name of Service which contains Repricing SKU. Format: services/{service}. Example:
“services/B7D9-FDCB-15D8”.
- Type
- class google.cloud.channel_v1.types.BillingAccount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a billing account.
- name¶
Output only. Resource name of the billing account. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.
- Type
- create_time¶
Output only. The time when this billing account was created.
- class google.cloud.channel_v1.types.BillingAccountPurchaseInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a billing account that can be used to make a purchase.
- billing_account¶
The billing account resource.
- class google.cloud.channel_v1.types.CancelEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.CancelEntitlement][google.cloud.channel.v1.CloudChannelService.CancelEntitlement].
- name¶
Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.ChangeOfferRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer].
- name¶
Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- parameters¶
Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions] from the desired offer.
- Type
MutableSequence[google.cloud.channel_v1.types.Parameter]
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.ChangeParametersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ChangeParametersRequest][].
- name¶
Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- parameters¶
Required. Entitlement parameters to update. You can only change editable parameters.
To view the available Parameters for a request, refer to the [Offer.parameter_definitions][google.cloud.channel.v1.Offer.parameter_definitions] from the desired offer.
- Type
MutableSequence[google.cloud.channel_v1.types.Parameter]
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.ChangeRenewalSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ChangeRenewalSettings][google.cloud.channel.v1.CloudChannelService.ChangeRenewalSettings].
- name¶
Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- renewal_settings¶
Required. New renewal settings.
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.ChannelPartnerLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntity representing a link between distributors and their indirect resellers in an n-tier resale channel.
- name¶
Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
- Type
- link_state¶
Required. State of the channel partner link.
- invite_link_uri¶
Output only. URI of the web page where partner accepts the link invitation.
- Type
- create_time¶
Output only. Timestamp of when the channel partner link is created.
- update_time¶
Output only. Timestamp of when the channel partner link is updated.
- public_id¶
Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
- Type
- channel_partner_cloud_identity_info¶
Output only. Cloud Identity info of the channel partner (IR).
- class google.cloud.channel_v1.types.ChannelPartnerLinkState(value)[source]¶
Bases:
proto.enums.EnumChannelPartnerLinkState represents state of a channel partner link.
- Values:
- CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED (0):
Not used.
- INVITED (1):
An invitation has been sent to the reseller to create a channel partner link.
- ACTIVE (2):
Status when the reseller is active.
- REVOKED (3):
Status when the reseller has been revoked by the distributor.
- SUSPENDED (4):
Status when the reseller is suspended by Google or distributor.
- class google.cloud.channel_v1.types.ChannelPartnerLinkView(value)[source]¶
Bases:
proto.enums.EnumThe level of granularity the [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] will display.
- Values:
- UNSPECIFIED (0):
The default / unset value. The API will default to the BASIC view.
- BASIC (1):
Includes all fields except the [ChannelPartnerLink.channel_partner_cloud_identity_info][google.cloud.channel.v1.ChannelPartnerLink.channel_partner_cloud_identity_info].
- FULL (2):
Includes all fields.
- class google.cloud.channel_v1.types.ChannelPartnerRepricingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).
- name¶
Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.
- Type
- repricing_config¶
Required. The configuration for bill modifications made by a reseller before sending it to ChannelPartner.
- update_time¶
Output only. Timestamp of an update to the repricing rule. If
update_timeis after [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] then it indicates this was set mid-month.
- class google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].
- parent¶
Required. The reseller account’s resource name. Parent uses the format: accounts/{account_id}
- Type
- domain¶
Required. Domain to fetch for Cloud Identity account customers, including domain and team customers. For team customers, please use the domain for their emails.
- Type
- class google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].
- cloud_identity_accounts¶
The Cloud Identity accounts associated with the domain.
- Type
MutableSequence[google.cloud.channel_v1.types.CloudIdentityCustomerAccount]
- class google.cloud.channel_v1.types.CloudIdentityCustomerAccount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntity representing a Cloud Identity account that may be associated with a Channel Services API partner.
- owned¶
Returns true if the Cloud Identity account is associated with a customer of the Channel Services partner.
- Type
- customer_name¶
If owned = true, the name of the customer that owns the Cloud Identity account. Customer_name uses the format: accounts/{account_id}/customers/{customer_id}
- Type
- customer_type¶
If existing = true, the type of the customer.
- class google.cloud.channel_v1.types.CloudIdentityInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloud Identity information for the Cloud Channel Customer.
- customer_type¶
CustomerType indicates verification type needed for using services.
- is_domain_verified¶
Output only. Whether the domain is verified. This field is not returned for a Customer’s cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK’s Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
- Type
- edu_data¶
Edu information about the customer.
- class CustomerType(value)[source]¶
Bases:
proto.enums.EnumCustomerType of the customer
- Values:
- CUSTOMER_TYPE_UNSPECIFIED (0):
Not used.
- DOMAIN (1):
Domain-owning customer which needs domain verification to use services.
- TEAM (2):
Team customer which needs email verification to use services.
- class google.cloud.channel_v1.types.Column(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe definition of a report column. Specifies the data properties in the corresponding position of the report rows.
- column_id¶
The unique name of the column (for example, customer_domain, channel_partner, customer_cost). You can use column IDs in [RunReportJobRequest.filter][google.cloud.channel.v1.RunReportJobRequest.filter]. To see all reports and their columns, call [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports].
- Type
- data_type¶
The type of the values for this column.
- class DataType(value)[source]¶
Bases:
proto.enums.EnumAvailable data types for columns. Corresponds to the fields in the ReportValue
oneoffield.- Values:
- DATA_TYPE_UNSPECIFIED (0):
Not used.
- STRING (1):
ReportValues for this column will use string_value.
- INT (2):
ReportValues for this column will use int_value.
- DECIMAL (3):
ReportValues for this column will use decimal_value.
- MONEY (4):
ReportValues for this column will use money_value.
- DATE (5):
ReportValues for this column will use date_value.
- DATE_TIME (6):
ReportValues for this column will use date_time_value.
- class google.cloud.channel_v1.types.CommitmentSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCommitment settings for commitment-based offers.
- start_time¶
Output only. Commitment start timestamp.
- end_time¶
Output only. Commitment end timestamp.
- renewal_settings¶
Optional. Renewal settings applicable for a commitment-based Offer.
- class google.cloud.channel_v1.types.ConditionalOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies the override to conditionally apply.
- adjustment¶
Required. Information about the applied override’s adjustment.
- rebilling_basis¶
Required. The [RebillingBasis][google.cloud.channel.v1.RebillingBasis] to use for the applied override. Shows the relative cost based on your repricing costs.
- repricing_condition¶
Required. Specifies the condition which, if met, will apply the override.
- class google.cloud.channel_v1.types.Constraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the constraints for buying the Offer.
- customer_constraints¶
Represents constraints required to purchase the Offer for a customer.
- class google.cloud.channel_v1.types.ContactInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContact information for a customer account.
- display_name¶
Output only. The customer account contact’s display name, formatted as a combination of the customer’s first and last name.
- Type
- email¶
The customer account’s contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer’s username for those accounts. Use this email to invite Team customers.
- Type
- class google.cloud.channel_v1.types.CreateChannelPartnerLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.CreateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerLink]
- parent¶
Required. Create a channel partner link for the provided reseller account’s resource name. Parent uses the format: accounts/{account_id}
- Type
- channel_partner_link¶
Required. The channel partner link to create. Either channel_partner_link.reseller_cloud_identity_id or domain can be used to create a link.
- class google.cloud.channel_v1.types.CreateChannelPartnerRepricingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig].
- parent¶
Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}
- Type
- channel_partner_repricing_config¶
Required. The ChannelPartnerRepricingConfig object to update.
- class google.cloud.channel_v1.types.CreateCustomerRepricingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig].
- parent¶
Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}
- Type
- customer_repricing_config¶
Required. The CustomerRepricingConfig object to update.
- class google.cloud.channel_v1.types.CreateCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.CreateCustomer][google.cloud.channel.v1.CloudChannelService.CreateCustomer]
- parent¶
Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id}
- Type
- customer¶
Required. The customer to create.
- class google.cloud.channel_v1.types.CreateEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.CloudChannelService.CreateEntitlement]
- parent¶
Required. The resource name of the reseller’s customer account in which to create the entitlement. Parent uses the format: accounts/{account_id}/customers/{customer_id}
- Type
- entitlement¶
Required. The entitlement to create.
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.Customer(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntity representing a customer of a reseller or distributor.
- name¶
Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
- Type
- org_postal_address¶
Required. The organization address for the customer. To enforce US laws and embargoes, we require a region, postal code, and address lines. You must provide valid addresses for every customer. To set the customer’s language, use the Customer-level language code.
- Type
google.type.postal_address_pb2.PostalAddress
- primary_contact_info¶
Primary contact info.
- alternate_email¶
Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.
- Type
- domain¶
Required. The customer’s primary domain. Must match the primary contact email’s domain.
- Type
- create_time¶
Output only. Time when the customer was created.
- update_time¶
Output only. Time when the customer was updated.
- cloud_identity_id¶
Output only. The customer’s Cloud Identity ID if the customer has a Cloud Identity resource.
- Type
- language_code¶
Optional. The BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- Type
- cloud_identity_info¶
Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.
- channel_partner_id¶
Cloud Identity ID of the customer’s channel partner. Populated only if a channel partner exists for this customer.
- Type
- class google.cloud.channel_v1.types.CustomerConstraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents constraints required to purchase the Offer for a customer.
- allowed_customer_types¶
Allowed Customer Type.
- Type
MutableSequence[google.cloud.channel_v1.types.CloudIdentityInfo.CustomerType]
- promotional_order_types¶
Allowed Promotional Order Type. Present for Promotional offers.
- Type
MutableSequence[google.cloud.channel_v1.types.PromotionalOrderType]
- class google.cloud.channel_v1.types.CustomerEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents Pub/Sub message content describing customer update.
- customer¶
Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
- Type
- event_type¶
Type of event which happened on the customer.
- class Type(value)[source]¶
Bases:
proto.enums.EnumType of customer event.
- Values:
- TYPE_UNSPECIFIED (0):
Not used.
- PRIMARY_DOMAIN_CHANGED (1):
Primary domain for customer was changed.
- PRIMARY_DOMAIN_VERIFIED (2):
Primary domain of the customer has been verified.
- class google.cloud.channel_v1.types.CustomerRepricingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for how a reseller will reprice a Customer.
- name¶
Output only. Resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.
- Type
- repricing_config¶
Required. The configuration for bill modifications made by a reseller before sending it to customers.
- update_time¶
Output only. Timestamp of an update to the repricing rule. If
update_timeis after [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] then it indicates this was set mid-month.
- class google.cloud.channel_v1.types.DateRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA representation of usage or invoice date ranges.
- usage_start_date_time¶
The earliest usage date time (inclusive).
If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage start date is rounded down to include all usage from the specified date. We recommend that clients pass
usage_start_date_timein Pacific time.- Type
google.type.datetime_pb2.DateTime
- usage_end_date_time¶
The latest usage date time (exclusive).
If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage end date is rounded down to include all usage from the specified date. We recommend that clients pass
usage_start_date_timein Pacific time.- Type
google.type.datetime_pb2.DateTime
- invoice_start_date¶
The earliest invoice date (inclusive).
If this value is not the first day of a month, this will move it back to the first day of the given month.
- Type
google.type.date_pb2.Date
- invoice_end_date¶
The latest invoice date (inclusive).
If this value is not the last day of a month, this will move it forward to the last day of the given month.
- Type
google.type.date_pb2.Date
- class google.cloud.channel_v1.types.DeleteChannelPartnerRepricingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteChannelPartnerRepricingConfig.
- class google.cloud.channel_v1.types.DeleteCustomerRepricingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.DeleteCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.DeleteCustomerRepricingConfig].
- class google.cloud.channel_v1.types.DeleteCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.DeleteCustomer][google.cloud.channel.v1.CloudChannelService.DeleteCustomer].
- class google.cloud.channel_v1.types.EduData(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequired Edu Attributes
- institute_type¶
Designated institute type of customer.
- institute_size¶
Size of the institute.
- class InstituteSize(value)[source]¶
Bases:
proto.enums.EnumNumber of students and staff the institute has.
- Values:
- INSTITUTE_SIZE_UNSPECIFIED (0):
Not used.
- SIZE_1_100 (1):
1 - 100
- SIZE_101_500 (2):
101 - 500
- SIZE_501_1000 (3):
501 - 1,000
- SIZE_1001_2000 (4):
1,001 - 2,000
- SIZE_2001_5000 (5):
2,001 - 5,000
- SIZE_5001_10000 (6):
5,001 - 10,000
- SIZE_10001_OR_MORE (7):
10,001 +
- class InstituteType(value)[source]¶
Bases:
proto.enums.EnumEnum to specify the institute type.
- Values:
- INSTITUTE_TYPE_UNSPECIFIED (0):
Not used.
- K12 (1):
Elementary/Secondary Schools & Districts
- UNIVERSITY (2):
Higher Education Universities & Colleges
- class google.cloud.channel_v1.types.Entitlement(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn entitlement is a representation of a customer’s ability to use a service.
- name¶
Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
- Type
- create_time¶
Output only. The time at which the entitlement is created.
- update_time¶
Output only. The time at which the entitlement is updated.
- offer¶
Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.
- Type
- commitment_settings¶
Commitment settings for a commitment-based Offer. Required for commitment based offers.
- provisioning_state¶
Output only. Current provisioning state of the entitlement.
- provisioned_service¶
Output only. Service provisioning details for the entitlement.
- suspension_reasons¶
Output only. Enumerable of all current suspension reasons for an entitlement.
- Type
MutableSequence[google.cloud.channel_v1.types.Entitlement.SuspensionReason]
- purchase_order_id¶
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.
- Type
- trial_settings¶
Output only. Settings for trial offers.
- association_info¶
Association information to other entitlements.
- parameters¶
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 Google Cloud billing subaccounts, the following Parameter may be accepted as input:
display_name: The display name of the billing subaccount.
- Type
MutableSequence[google.cloud.channel_v1.types.Parameter]
- billing_account¶
Optional. The billing account resource name that is used to pay for this entitlement.
- Type
- class ProvisioningState(value)[source]¶
Bases:
proto.enums.EnumIndicates the current provisioning state of the entitlement.
- Values:
- PROVISIONING_STATE_UNSPECIFIED (0):
Not used.
- ACTIVE (1):
The entitlement is currently active.
- SUSPENDED (5):
The entitlement is currently suspended.
- class SuspensionReason(value)[source]¶
Bases:
proto.enums.EnumSuspension reason for an entitlement if [provisioning_state][google.cloud.channel.v1.Entitlement.provisioning_state] = SUSPENDED.
- Values:
- SUSPENSION_REASON_UNSPECIFIED (0):
Not used.
- RESELLER_INITIATED (1):
Entitlement was manually suspended by the Reseller.
- TRIAL_ENDED (2):
Trial ended.
- RENEWAL_WITH_TYPE_CANCEL (3):
Entitlement renewal was canceled.
- PENDING_TOS_ACCEPTANCE (4):
Entitlement was automatically suspended on creation for pending ToS acceptance on customer.
- OTHER (100):
Other reasons (internal reasons, abuse, etc.).
- class google.cloud.channel_v1.types.EntitlementChange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageChange event entry for Entitlement order history
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- suspension_reason¶
Suspension reason for the Entitlement.
This field is a member of oneof
change_reason.
- cancellation_reason¶
Cancellation reason for the Entitlement.
This field is a member of oneof
change_reason.
- activation_reason¶
The Entitlement’s activation reason
This field is a member of oneof
change_reason.
- other_change_reason¶
e.g. purchase_number change reason, entered by CRS.
This field is a member of oneof
change_reason.- Type
- entitlement¶
Required. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- offer¶
Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}.
- Type
- provisioned_service¶
Service provisioned for an Entitlement.
- change_type¶
The change action type.
- create_time¶
The submitted time of the change.
- operator_type¶
Operator type responsible for the change.
- parameters¶
Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc.
- Type
MutableSequence[google.cloud.channel_v1.types.Parameter]
- operator¶
Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user’s email address. For all other operator types, this is empty.
- Type
- class ActivationReason(value)[source]¶
Bases:
proto.enums.EnumThe Entitlement’s activation reason
- Values:
- ACTIVATION_REASON_UNSPECIFIED (0):
Not used.
- RESELLER_REVOKED_SUSPENSION (1):
Reseller reactivated a suspended Entitlement.
- CUSTOMER_ACCEPTED_PENDING_TOS (2):
Customer accepted pending terms of service.
- RENEWAL_SETTINGS_CHANGED (3):
Reseller updated the renewal settings on an entitlement that was suspended due to cancellation, and this update reactivated the entitlement.
- OTHER_ACTIVATION_REASON (100):
Other reasons (Activated temporarily for cancellation, added a payment plan to a trial entitlement, etc.)
- class CancellationReason(value)[source]¶
Bases:
proto.enums.EnumCancellation reason for the entitlement
- Values:
- CANCELLATION_REASON_UNSPECIFIED (0):
Not used.
- SERVICE_TERMINATED (1):
Reseller triggered a cancellation of the service.
- RELATIONSHIP_ENDED (2):
Relationship between the reseller and customer has ended due to a transfer.
- PARTIAL_TRANSFER (3):
Entitlement transferred away from reseller while still keeping other entitlement(s) with the reseller.
- class ChangeType(value)[source]¶
Bases:
proto.enums.EnumSpecifies the type of change action
- Values:
- CHANGE_TYPE_UNSPECIFIED (0):
Not used.
- CREATED (1):
New Entitlement was created.
- PRICE_PLAN_SWITCHED (3):
Price plan associated with an Entitlement was changed.
- COMMITMENT_CHANGED (4):
Number of seats committed for a commitment Entitlement was changed.
- RENEWED (5):
An annual Entitlement was renewed.
- SUSPENDED (6):
Entitlement was suspended.
- ACTIVATED (7):
Entitlement was activated.
- CANCELLED (8):
Entitlement was cancelled.
- SKU_CHANGED (9):
Entitlement was upgraded or downgraded for ex. from Google Workspace Business Standard to Google Workspace Business Plus.
- RENEWAL_SETTING_CHANGED (10):
The settings for renewal of an Entitlement have changed.
- PAID_SUBSCRIPTION_STARTED (11):
Use for Google Workspace subscription. Either a trial was converted to a paid subscription or a new subscription with no trial is created.
- LICENSE_CAP_CHANGED (12):
License cap was changed for the entitlement.
- SUSPENSION_DETAILS_CHANGED (13):
The suspension details have changed (but it is still suspended).
- TRIAL_END_DATE_EXTENDED (14):
The trial end date was extended.
- TRIAL_STARTED (15):
Entitlement started trial.
- class OperatorType(value)[source]¶
Bases:
proto.enums.EnumSpecifies the type of operator responsible for the change
- Values:
- OPERATOR_TYPE_UNSPECIFIED (0):
Not used.
- CUSTOMER_SERVICE_REPRESENTATIVE (1):
Customer service representative.
- SYSTEM (2):
System auto job.
- CUSTOMER (3):
Customer user.
- RESELLER (4):
Reseller user.
- class google.cloud.channel_v1.types.EntitlementEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents Pub/Sub message content describing entitlement update.
- entitlement¶
Resource name of an entitlement of the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- event_type¶
Type of event which happened on the entitlement.
- class Type(value)[source]¶
Bases:
proto.enums.EnumType of entitlement event.
- Values:
- TYPE_UNSPECIFIED (0):
Not used.
- CREATED (1):
A new entitlement was created.
- PRICE_PLAN_SWITCHED (3):
The offer type associated with an entitlement was changed. This is not triggered if an entitlement converts from a commit offer to a flexible offer as part of a renewal.
- COMMITMENT_CHANGED (4):
Annual commitment for a commit plan was changed.
- RENEWED (5):
An annual entitlement was renewed.
- SUSPENDED (6):
Entitlement was suspended.
- ACTIVATED (7):
Entitlement was unsuspended.
- CANCELLED (8):
Entitlement was cancelled.
- SKU_CHANGED (9):
Entitlement was upgraded or downgraded (e.g. from Google Workspace Business Standard to Google Workspace Business Plus).
- RENEWAL_SETTING_CHANGED (10):
The renewal settings of an entitlement has changed.
- PAID_SERVICE_STARTED (11):
Paid service has started on trial entitlement.
- LICENSE_ASSIGNMENT_CHANGED (12):
License was assigned to or revoked from a user.
- LICENSE_CAP_CHANGED (13):
License cap was changed for the entitlement.
- class google.cloud.channel_v1.types.FetchReportResultsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults].
- report_job¶
Required. The report job created by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob]. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
- Type
- page_size¶
Optional. Requested page size of the report. The server may return fewer results than requested. If you don’t specify a page size, the server uses a sensible default (may change over time).
The maximum value is 30,000; the server will change larger values to 30,000.
- Type
- page_token¶
Optional. A token that specifies a page of results beyond the first page. Obtained through [FetchReportResultsResponse.next_page_token][google.cloud.channel.v1.FetchReportResultsResponse.next_page_token] of the previous [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults] call.
- Type
- class google.cloud.channel_v1.types.FetchReportResultsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]. Contains a tabular representation of the report results.
- report_metadata¶
The metadata for the report results (display name, columns, row count, and date ranges).
- rows¶
The report’s lists of values. Each row follows the settings and ordering of the columns from
report_metadata.- Type
MutableSequence[google.cloud.channel_v1.types.Row]
- class google.cloud.channel_v1.types.GetChannelPartnerLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.GetChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerLink].
- name¶
Required. The resource name of the channel partner link to retrieve. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner.
- Type
- view¶
Optional. The level of granularity the ChannelPartnerLink will display.
- class google.cloud.channel_v1.types.GetChannelPartnerRepricingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.GetChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerRepricingConfig]
- class google.cloud.channel_v1.types.GetCustomerRepricingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.GetCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetCustomerRepricingConfig].
- class google.cloud.channel_v1.types.GetCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.GetCustomer][google.cloud.channel.v1.CloudChannelService.GetCustomer].
- class google.cloud.channel_v1.types.GetEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.GetEntitlement][google.cloud.channel.v1.CloudChannelService.GetEntitlement].
- class google.cloud.channel_v1.types.ImportCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ImportCustomer][google.cloud.channel.v1.CloudChannelService.ImportCustomer]
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- cloud_identity_id¶
Required. Customer’s Cloud Identity ID
This field is a member of oneof
customer_identity.- Type
- primary_admin_email¶
Required. Customer’s primary admin email.
This field is a member of oneof
customer_identity.- Type
- parent¶
Required. The resource name of the reseller’s account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}
- Type
- auth_token¶
Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.
- Type
- overwrite_if_exists¶
Required. Choose to overwrite an existing customer if found. This must be set to true if there is an existing customer with a conflicting region code or domain.
- Type
- channel_partner_id¶
Optional. Cloud Identity ID of a channel partner who will be the direct reseller for the customer’s order. This field is required for 2-tier transfer scenarios and can be provided via the request Parent binding as well.
- Type
- class google.cloud.channel_v1.types.ListChannelPartnerLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks]
- parent¶
Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id}
- Type
- page_size¶
Optional. Requested page size. Server might return fewer results than requested. If unspecified, server will pick a default size (25). The maximum value is 200; the server will coerce values above 200.
- Type
- page_token¶
Optional. A token for a page of results other than the first page. Obtained using [ListChannelPartnerLinksResponse.next_page_token][google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token] of the previous [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks] call.
- Type
- view¶
Optional. The level of granularity the ChannelPartnerLink will display.
- class google.cloud.channel_v1.types.ListChannelPartnerLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks].
- channel_partner_links¶
The Channel partner links for a reseller.
- Type
MutableSequence[google.cloud.channel_v1.types.ChannelPartnerLink]
- class google.cloud.channel_v1.types.ListChannelPartnerRepricingConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs].
- parent¶
Required. The resource name of the account’s [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.
- Type
- page_size¶
Optional. The maximum number of repricing configs to return. The service may return fewer than this value. If unspecified, returns a maximum of 50 rules. The maximum value is 100; values above 100 will be coerced to 100.
- Type
- page_token¶
Optional. A token identifying a page of results beyond the first page. Obtained through [ListChannelPartnerRepricingConfigsResponse.next_page_token][google.cloud.channel.v1.ListChannelPartnerRepricingConfigsResponse.next_page_token] of the previous [CloudChannelService.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs] call.
- Type
- filter¶
Optional. A filter for [CloudChannelService.ListChannelPartnerRepricingConfigs] results (channel_partner_link only). You can use this filter when you support a BatchGet-like query. To use the filter, you must set
parent=accounts/{account_id}/channelPartnerLinks/-.Example:
channel_partner_link = accounts/account_id/channelPartnerLinks/c1ORchannel_partner_link = accounts/account_id/channelPartnerLinks/c2.- Type
- class google.cloud.channel_v1.types.ListChannelPartnerRepricingConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs].
- channel_partner_repricing_configs¶
The repricing configs for this channel partner.
- Type
MutableSequence[google.cloud.channel_v1.types.ChannelPartnerRepricingConfig]
- class google.cloud.channel_v1.types.ListCustomerRepricingConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs].
- parent¶
Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.
- Type
- page_size¶
Optional. The maximum number of repricing configs to return. The service may return fewer than this value. If unspecified, returns a maximum of 50 rules. The maximum value is 100; values above 100 will be coerced to 100.
- Type
- page_token¶
Optional. A token identifying a page of results beyond the first page. Obtained through [ListCustomerRepricingConfigsResponse.next_page_token][google.cloud.channel.v1.ListCustomerRepricingConfigsResponse.next_page_token] of the previous [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs] call.
- Type
- filter¶
Optional. A filter for [CloudChannelService.ListCustomerRepricingConfigs] results (customer only). You can use this filter when you support a BatchGet-like query. To use the filter, you must set
parent=accounts/{account_id}/customers/-.Example: customer = accounts/account_id/customers/c1 OR customer = accounts/account_id/customers/c2.
- Type
- class google.cloud.channel_v1.types.ListCustomerRepricingConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs].
- customer_repricing_configs¶
The repricing configs for this channel partner.
- Type
MutableSequence[google.cloud.channel_v1.types.CustomerRepricingConfig]
- class google.cloud.channel_v1.types.ListCustomersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers]
- parent¶
Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.
- Type
- page_size¶
Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.
- Type
- page_token¶
Optional. A token identifying a page of results other than the first page. Obtained through [ListCustomersResponse.next_page_token][google.cloud.channel.v1.ListCustomersResponse.next_page_token] of the previous [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers] call.
- Type
- filter¶
Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.
- Type
- class google.cloud.channel_v1.types.ListCustomersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers].
- customers¶
The customers belonging to a reseller or distributor.
- Type
MutableSequence[google.cloud.channel_v1.types.Customer]
- class google.cloud.channel_v1.types.ListEntitlementChangesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ListEntitlementChanges][google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges]
- parent¶
Required. The resource name of the entitlement for which to list entitlement changes. The
-wildcard may be used to match entitlements across a customer. Formats:accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
accounts/{account_id}/customers/{customer_id}/entitlements/-
- Type
- page_size¶
Optional. The maximum number of entitlement changes to return. The service may return fewer than this value. If unspecified, returns at most 10 entitlement changes. The maximum value is 50; the server will coerce values above 50.
- Type
- page_token¶
Optional. A page token, received from a previous [CloudChannelService.ListEntitlementChanges][google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges] call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to [CloudChannelService.ListEntitlementChanges][google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges] must match the call that provided the page token.
- Type
- class google.cloud.channel_v1.types.ListEntitlementChangesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.ListEntitlementChanges][google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges]
- entitlement_changes¶
The list of entitlement changes.
- Type
MutableSequence[google.cloud.channel_v1.types.EntitlementChange]
- class google.cloud.channel_v1.types.ListEntitlementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements]
- parent¶
Required. The resource name of the reseller’s customer account to list entitlements for. Parent uses the format: accounts/{account_id}/customers/{customer_id}
- Type
- page_size¶
Optional. Requested page size. Server might return fewer results than requested. If unspecified, return at most 50 entitlements. The maximum value is 100; the server will coerce values above 100.
- Type
- page_token¶
Optional. A token for a page of results other than the first page. Obtained using [ListEntitlementsResponse.next_page_token][google.cloud.channel.v1.ListEntitlementsResponse.next_page_token] of the previous [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements] call.
- Type
- class google.cloud.channel_v1.types.ListEntitlementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements].
- entitlements¶
The reseller customer’s entitlements.
- Type
MutableSequence[google.cloud.channel_v1.types.Entitlement]
- class google.cloud.channel_v1.types.ListOffersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListOffers.
- parent¶
Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.
- Type
- page_size¶
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.
- Type
- filter¶
Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1
- Type
- language_code¶
Optional. The BCP-47 language code. For example, “en-US”. The response will localize in the corresponding language code, if specified. The default value is “en-US”.
- Type
- class google.cloud.channel_v1.types.ListOffersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListOffers.
- offers¶
The list of Offers requested.
- Type
MutableSequence[google.cloud.channel_v1.types.Offer]
- class google.cloud.channel_v1.types.ListProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListProducts.
- account¶
Required. The resource name of the reseller account. Format: accounts/{account_id}.
- Type
- page_size¶
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Products. The maximum value is 1000; the server will coerce values above 1000.
- Type
- class google.cloud.channel_v1.types.ListProductsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListProducts.
- products¶
List of Products requested.
- Type
MutableSequence[google.cloud.channel_v1.types.Product]
- class google.cloud.channel_v1.types.ListPurchasableOffersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListPurchasableOffers.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- create_entitlement_purchase¶
List Offers for CreateEntitlement purchase.
This field is a member of oneof
purchase_option.
- change_offer_purchase¶
List Offers for ChangeOffer purchase.
This field is a member of oneof
purchase_option.
- customer¶
Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}.
- Type
- page_size¶
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Offers. The maximum value is 1000; the server will coerce values above 1000.
- Type
- language_code¶
Optional. The BCP-47 language code. For example, “en-US”. The response will localize in the corresponding language code, if specified. The default value is “en-US”.
- Type
- class ChangeOfferPurchase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList Offers for ChangeOffer purchase.
- entitlement¶
Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- new_sku¶
Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id}/skus/{sku_id}
- Type
- billing_account¶
Optional. Resource name of the new target Billing Account. Provide this Billing Account when setting up billing for a trial subscription. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.
This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.
- Type
- class CreateEntitlementPurchase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList Offers for CreateEntitlement purchase.
- sku¶
Required. SKU that the result should be restricted to. Format: products/{product_id}/skus/{sku_id}.
- Type
- class google.cloud.channel_v1.types.ListPurchasableOffersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListPurchasableOffers.
- purchasable_offers¶
The list of Offers requested.
- Type
MutableSequence[google.cloud.channel_v1.types.PurchasableOffer]
- class google.cloud.channel_v1.types.ListPurchasableSkusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListPurchasableSkus.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- create_entitlement_purchase¶
List SKUs for CreateEntitlement purchase.
This field is a member of oneof
purchase_option.
- change_offer_purchase¶
List SKUs for ChangeOffer purchase with a new SKU.
This field is a member of oneof
purchase_option.
- customer¶
Required. The resource name of the customer to list SKUs for. Format: accounts/{account_id}/customers/{customer_id}.
- Type
- page_size¶
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.
- Type
- language_code¶
Optional. The BCP-47 language code. For example, “en-US”. The response will localize in the corresponding language code, if specified. The default value is “en-US”.
- Type
- class ChangeOfferPurchase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList SKUs for upgrading or downgrading an entitlement. Make the purchase using [CloudChannelService.ChangeOffer][google.cloud.channel.v1.CloudChannelService.ChangeOffer].
- entitlement¶
Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- change_type¶
Required. Change Type for the entitlement.
- class ChangeType(value)[source]¶
Bases:
proto.enums.EnumChange Type enum.
- Values:
- CHANGE_TYPE_UNSPECIFIED (0):
Not used.
- UPGRADE (1):
SKU is an upgrade on the current entitlement.
- DOWNGRADE (2):
SKU is a downgrade on the current entitlement.
- class CreateEntitlementPurchase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList SKUs for a new entitlement. Make the purchase using [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.CloudChannelService.CreateEntitlement].
- class google.cloud.channel_v1.types.ListPurchasableSkusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListPurchasableSkus.
- purchasable_skus¶
The list of SKUs requested.
- Type
MutableSequence[google.cloud.channel_v1.types.PurchasableSku]
- class google.cloud.channel_v1.types.ListReportsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports].
- parent¶
Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}
- Type
- page_size¶
Optional. Requested page size of the report. The server might return fewer results than requested. If unspecified, returns 20 reports. The maximum value is 100.
- Type
- page_token¶
Optional. A token that specifies a page of results beyond the first page. Obtained through [ListReportsResponse.next_page_token][google.cloud.channel.v1.ListReportsResponse.next_page_token] of the previous [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports] call.
- Type
- class google.cloud.channel_v1.types.ListReportsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelReportsService.ListReports][google.cloud.channel.v1.CloudChannelReportsService.ListReports].
- reports¶
The reports available to the partner.
- Type
MutableSequence[google.cloud.channel_v1.types.Report]
- class google.cloud.channel_v1.types.ListSkuGroupBillableSkusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListSkuGroupBillableSkus.
- parent¶
Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}.
- Type
- page_size¶
Optional. The maximum number of SKUs to return. The service may return fewer than this value. If unspecified, returns a maximum of 100000 SKUs. The maximum value is 100000; values above 100000 will be coerced to 100000.
- Type
- class google.cloud.channel_v1.types.ListSkuGroupBillableSkusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListSkuGroupBillableSkus.
- billable_skus¶
The list of billable SKUs in the requested SKU group.
- Type
MutableSequence[google.cloud.channel_v1.types.BillableSku]
- class google.cloud.channel_v1.types.ListSkuGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListSkuGroups.
- parent¶
Required. The resource name of the account from which to list SKU groups. Parent uses the format: accounts/{account}.
- Type
- page_size¶
Optional. The maximum number of SKU groups to return. The service may return fewer than this value. If unspecified, returns a maximum of 1000 SKU groups. The maximum value is 1000; values above 1000 will be coerced to 1000.
- Type
- class google.cloud.channel_v1.types.ListSkuGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListSkuGroups.
- sku_groups¶
The list of SKU groups requested.
- Type
MutableSequence[google.cloud.channel_v1.types.SkuGroup]
- class google.cloud.channel_v1.types.ListSkusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListSkus.
- parent¶
Required. The resource name of the Product to list SKUs for. Parent uses the format: products/{product_id}. Supports products/- to retrieve SKUs for all products.
- Type
- page_size¶
Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.
- Type
- class google.cloud.channel_v1.types.ListSkusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListSkus.
- skus¶
The list of SKUs requested.
- Type
MutableSequence[google.cloud.channel_v1.types.Sku]
- class google.cloud.channel_v1.types.ListSubscribersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest Message for ListSubscribers.
- page_size¶
Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.
- Type
- class google.cloud.channel_v1.types.ListSubscribersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse Message for ListSubscribers.
- class google.cloud.channel_v1.types.ListTransferableOffersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers]
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- cloud_identity_id¶
Customer’s Cloud Identity ID
This field is a member of oneof
transferred_customer_identity.- Type
- customer_name¶
A reseller should create a customer and use the resource name of that customer here.
This field is a member of oneof
transferred_customer_identity.- Type
- page_size¶
Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 offers. The maximum value is 1000; the server will coerce values above 1000.
- Type
- page_token¶
A token for a page of results other than the first page. Obtained using [ListTransferableOffersResponse.next_page_token][google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token] of the previous [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers] call.
- Type
- language_code¶
Optional. The BCP-47 language code. For example, “en-US”. The response will localize in the corresponding language code, if specified. The default value is “en-US”.
- Type
- class google.cloud.channel_v1.types.ListTransferableOffersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers].
- transferable_offers¶
Information about Offers for a customer that can be used for transfer.
- Type
MutableSequence[google.cloud.channel_v1.types.TransferableOffer]
- class google.cloud.channel_v1.types.ListTransferableSkusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus]
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- cloud_identity_id¶
Customer’s Cloud Identity ID
This field is a member of oneof
transferred_customer_identity.- Type
- customer_name¶
A reseller is required to create a customer and use the resource name of the created customer here. Customer_name uses the format: accounts/{account_id}/customers/{customer_id}
This field is a member of oneof
transferred_customer_identity.- Type
- parent¶
Required. The reseller account’s resource name. Parent uses the format: accounts/{account_id}
- Type
- page_size¶
The requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000. Optional.
- Type
- page_token¶
A token for a page of results other than the first page. Obtained using [ListTransferableSkusResponse.next_page_token][google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token] of the previous [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus] call. Optional.
- Type
- auth_token¶
Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.
- Type
- class google.cloud.channel_v1.types.ListTransferableSkusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus].
- transferable_skus¶
Information about existing SKUs for a customer that needs a transfer.
- Type
MutableSequence[google.cloud.channel_v1.types.TransferableSku]
- class google.cloud.channel_v1.types.LookupOfferRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for LookupOffer.
- class google.cloud.channel_v1.types.MarketingInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the marketing information for a Product, SKU or Offer.
- default_logo¶
Default logo.
- class google.cloud.channel_v1.types.Media(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents media information.
- type_¶
Type of the media.
- class google.cloud.channel_v1.types.MediaType(value)[source]¶
Bases:
proto.enums.EnumType of media used.
- Values:
- MEDIA_TYPE_UNSPECIFIED (0):
Not used.
- MEDIA_TYPE_IMAGE (1):
Type of image.
- class google.cloud.channel_v1.types.Offer(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an offer made to resellers for purchase. An offer is associated with a [Sku][google.cloud.channel.v1.Sku], has a plan for payment, a price, and defines the constraints for buying.
- marketing_info¶
Marketing information for the Offer.
- sku¶
SKU the offer is associated with.
- plan¶
Describes the payment plan for the Offer.
- constraints¶
Constraints on transacting the Offer.
- price_by_resources¶
Price for each monetizable resource type.
- Type
MutableSequence[google.cloud.channel_v1.types.PriceByResource]
- start_time¶
Start of the Offer validity time.
- end_time¶
Output only. End of the Offer validity time.
- parameter_definitions¶
Parameters required to use current Offer to purchase.
- Type
MutableSequence[google.cloud.channel_v1.types.ParameterDefinition]
- class google.cloud.channel_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageProvides contextual information about a [google.longrunning.Operation][google.longrunning.Operation].
- operation_type¶
The RPC that initiated this Long Running Operation.
- class OperationType(value)[source]¶
Bases:
proto.enums.EnumRPCs that return a Long Running Operation.
- Values:
- OPERATION_TYPE_UNSPECIFIED (0):
Not used.
- CREATE_ENTITLEMENT (1):
Long Running Operation was triggered by CreateEntitlement.
- CHANGE_RENEWAL_SETTINGS (3):
Long Running Operation was triggered by ChangeRenewalSettings.
- START_PAID_SERVICE (5):
Long Running Operation was triggered by StartPaidService.
- ACTIVATE_ENTITLEMENT (7):
Long Running Operation was triggered by ActivateEntitlement.
- SUSPEND_ENTITLEMENT (8):
Long Running Operation was triggered by SuspendEntitlement.
- CANCEL_ENTITLEMENT (9):
Long Running Operation was triggered by CancelEntitlement.
- TRANSFER_ENTITLEMENTS (10):
Long Running Operation was triggered by TransferEntitlements.
- TRANSFER_ENTITLEMENTS_TO_GOOGLE (11):
Long Running Operation was triggered by TransferEntitlementsToGoogle.
- CHANGE_OFFER (14):
Long Running Operation was triggered by ChangeOffer.
- CHANGE_PARAMETERS (15):
Long Running Operation was triggered by ChangeParameters.
- PROVISION_CLOUD_IDENTITY (16):
Long Running Operation was triggered by ProvisionCloudIdentity.
- class google.cloud.channel_v1.types.Parameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefinition for extended entitlement parameters.
- value¶
Value of the parameter.
- class google.cloud.channel_v1.types.ParameterDefinition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageParameter’s definition. Specifies what parameter is required to use the current Offer to purchase.
- parameter_type¶
Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.
- min_value¶
Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types.
- max_value¶
Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types.
- allowed_values¶
If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, …] Applicable to STRING parameter type.
- Type
MutableSequence[google.cloud.channel_v1.types.Value]
- class ParameterType(value)[source]¶
Bases:
proto.enums.EnumData type of the parameter.
- Values:
- PARAMETER_TYPE_UNSPECIFIED (0):
Not used.
- INT64 (1):
Int64 type.
- STRING (2):
String type.
- DOUBLE (3):
Double type.
- BOOLEAN (4):
Boolean type.
- class google.cloud.channel_v1.types.PaymentPlan(value)[source]¶
Bases:
proto.enums.EnumDescribes how the reseller will be billed.
- Values:
- PAYMENT_PLAN_UNSPECIFIED (0):
Not used.
- COMMITMENT (1):
Commitment.
- FLEXIBLE (2):
No commitment.
- FREE (3):
Free.
- TRIAL (4):
Trial.
- OFFLINE (5):
Price and ordering not available through API.
- class google.cloud.channel_v1.types.PaymentType(value)[source]¶
Bases:
proto.enums.EnumSpecifies when the payment needs to happen.
- Values:
- PAYMENT_TYPE_UNSPECIFIED (0):
Not used.
- PREPAY (1):
Prepay. Amount has to be paid before service is rendered.
- POSTPAY (2):
Postpay. Reseller is charged at the end of the Payment cycle.
- class google.cloud.channel_v1.types.PercentageAdjustment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn adjustment that applies a flat markup or markdown to an entire bill.
- percentage¶
The percentage of the bill to adjust. For example:
Mark down by 1% => “-1.00” Mark up by 1% => “1.00” Pass-Through => “0.00”.
- Type
google.type.decimal_pb2.Decimal
- class google.cloud.channel_v1.types.Period(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents period in days/months/years.
- period_type¶
Period Type.
- class google.cloud.channel_v1.types.PeriodType(value)[source]¶
Bases:
proto.enums.EnumPeriod Type.
- Values:
- PERIOD_TYPE_UNSPECIFIED (0):
Not used.
- DAY (1):
Day.
- MONTH (2):
Month.
- YEAR (3):
Year.
- class google.cloud.channel_v1.types.Plan(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe payment plan for the Offer. Describes how to make a payment.
- payment_plan¶
Describes how a reseller will be billed.
- payment_type¶
Specifies when the payment needs to happen.
- payment_cycle¶
Describes how frequently the reseller will be billed, such as once per month.
- trial_period¶
Present for Offers with a trial period. For trial-only Offers, a paid service needs to start before the trial period ends for continued service. For Regular Offers with a trial period, the regular pricing goes into effect when trial period ends, or if paid service is started before the end of the trial period.
- class google.cloud.channel_v1.types.Price(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the price of the Offer.
- base_price¶
Base price.
- Type
google.type.money_pb2.Money
- discount¶
Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.
- Type
- effective_price¶
Effective Price after applying the discounts.
- Type
google.type.money_pb2.Money
- class google.cloud.channel_v1.types.PriceByResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents price by resource type.
- resource_type¶
Resource Type. Example: SEAT
- price¶
Price of the Offer. Present if there are no price phases.
- price_phases¶
Specifies the price by time range.
- Type
MutableSequence[google.cloud.channel_v1.types.PricePhase]
- class google.cloud.channel_v1.types.PricePhase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies the price by the duration of months. For example, a 20% discount for the first six months, then a 10% discount starting on the seventh month.
- period_type¶
Defines the phase period type.
- price¶
Price of the phase. Present if there are no price tiers.
- price_tiers¶
Price by the resource tiers.
- Type
MutableSequence[google.cloud.channel_v1.types.PriceTier]
- class google.cloud.channel_v1.types.PriceTier(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines price at resource tier level. For example, an offer with following definition :
Tier 1: Provide 25% discount for all seats between 1 and 25.
Tier 2: Provide 10% discount for all seats between 26 and 100.
Tier 3: Provide flat 15% discount for all seats above 100.
Each of these tiers is represented as a PriceTier.
- price¶
Price of the tier.
- class google.cloud.channel_v1.types.Product(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Product is the entity a customer uses when placing an order. For example, Google Workspace, Google Voice, etc.
- marketing_info¶
Marketing information for the product.
- class google.cloud.channel_v1.types.PromotionalOrderType(value)[source]¶
Bases:
proto.enums.EnumConstraints type for Promotional offers.
- Values:
- PROMOTIONAL_TYPE_UNSPECIFIED (0):
Not used.
- NEW_UPGRADE (1):
Order used for new customers, trial conversions and upgrades.
- TRANSFER (2):
All orders for transferring an existing customer.
- PROMOTION_SWITCH (3):
Orders for modifying an existing customer’s promotion on the same SKU.
- class google.cloud.channel_v1.types.ProvisionCloudIdentityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.ProvisionCloudIdentity][google.cloud.channel.v1.CloudChannelService.ProvisionCloudIdentity]
- customer¶
Required. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
- Type
- cloud_identity_info¶
CloudIdentity-specific customer information.
- user¶
Admin user information.
- class google.cloud.channel_v1.types.ProvisionedService(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageService provisioned for an entitlement.
- provisioning_id¶
Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.
- Type
- product_id¶
Output only. The product pertaining to the provisioning resource as specified in the Offer.
- Type
- class google.cloud.channel_v1.types.PurchasableOffer(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOffer that you can purchase for a customer. This is used in the ListPurchasableOffer API response.
- offer¶
Offer.
- class google.cloud.channel_v1.types.PurchasableSku(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSKU that you can purchase. This is used in ListPurchasableSku API response.
- sku¶
SKU
- class google.cloud.channel_v1.types.QueryEligibleBillingAccountsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for QueryEligibleBillingAccounts.
- customer¶
Required. The resource name of the customer to list eligible billing accounts for. Format: accounts/{account_id}/customers/{customer_id}.
- Type
- class google.cloud.channel_v1.types.QueryEligibleBillingAccountsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for QueryEligibleBillingAccounts.
- sku_purchase_groups¶
List of SKU purchase groups where each group represents a set of SKUs that must be purchased using the same billing account. Each SKU from [QueryEligibleBillingAccountsRequest.skus] will appear in exactly one SKU group.
- Type
MutableSequence[google.cloud.channel_v1.types.SkuPurchaseGroup]
- class google.cloud.channel_v1.types.RebillingBasis(value)[source]¶
Bases:
proto.enums.EnumSpecifies the different costs that the modified bill can be based on.
- Values:
- REBILLING_BASIS_UNSPECIFIED (0):
Not used.
- COST_AT_LIST (1):
Use the list cost, also known as the MSRP.
- DIRECT_CUSTOMER_COST (2):
Pass through all discounts except the Reseller Program Discount. If this is the default cost base and no adjustments are specified, the output cost will be exactly what the customer would see if they viewed the bill in the Google Cloud Console.
- class google.cloud.channel_v1.types.RegisterSubscriberRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest Message for RegisterSubscriber.
- class google.cloud.channel_v1.types.RegisterSubscriberResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse Message for RegisterSubscriber.
- class google.cloud.channel_v1.types.RenewalSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRenewal settings for renewable Offers.
- resize_unit_count¶
If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.
- Type
- payment_plan¶
Describes how a reseller will be billed.
- payment_cycle¶
Describes how frequently the reseller will be billed, such as once per month.
- class google.cloud.channel_v1.types.Report(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe ID and description of a report that was used to generate report data. For example, “Google Cloud Daily Spend”, “Google Workspace License Activity”, etc.
- name¶
Required. The report’s resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example,
613bf59q).Name uses the format: accounts/{account_id}/reports/{report_id}
- Type
- columns¶
The list of columns included in the report. This defines the schema of the report results.
- Type
MutableSequence[google.cloud.channel_v1.types.Column]
- class google.cloud.channel_v1.types.ReportJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe result of a [RunReportJob][] operation. Contains the name to use in [FetchReportResultsRequest.report_job][google.cloud.channel.v1.FetchReportResultsRequest.report_job] and the status of the operation.
- name¶
Required. The resource name of a report job. Name uses the format:
accounts/{account_id}/reportJobs/{report_job_id}- Type
- report_status¶
The current status of report generation.
- class google.cloud.channel_v1.types.ReportResultsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe features describing the data. Returned by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob] and [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults].
- report¶
Details of the completed report.
- date_range¶
The date range of reported usage.
- preceding_date_range¶
The usage dates immediately preceding
date_rangewith the same duration. Use this to calculate trending usage and costs. This is only populated if you request trending data.For example, if
date_rangeis July 1-15,preceding_date_rangewill be June 16-30.
- class google.cloud.channel_v1.types.ReportStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatus of a report generation process.
- state¶
The current state of the report generation process.
- start_time¶
The report generation’s start time.
- end_time¶
The report generation’s completion time.
- class State(value)[source]¶
Bases:
proto.enums.EnumAvailable states of report generation.
- Values:
- STATE_UNSPECIFIED (0):
Not used.
- STARTED (1):
Report processing started.
- WRITING (2):
Data generated from the report is being staged.
- AVAILABLE (3):
Report data is available for access.
- FAILED (4):
Report failed.
- class google.cloud.channel_v1.types.ReportValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA single report value.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- decimal_value¶
A value of type
google.type.Decimal, representing non-integer numeric values.This field is a member of oneof
value.- Type
google.type.decimal_pb2.Decimal
- money_value¶
A value of type
google.type.Money(currency code, whole units, decimal units).This field is a member of oneof
value.- Type
google.type.money_pb2.Money
- class google.cloud.channel_v1.types.RepricingAdjustment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA type that represents the various adjustments you can apply to a bill.
- class google.cloud.channel_v1.types.RepricingCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the various repricing conditions you can use for a conditional override.
- class google.cloud.channel_v1.types.RepricingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for repricing a Google bill over a period of time.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- entitlement_granularity¶
Applies the repricing configuration at the entitlement level.
Note: If a [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] using [RepricingConfig.EntitlementGranularity][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity] becomes effective, then no existing or future [RepricingConfig.ChannelPartnerGranularity][google.cloud.channel.v1.RepricingConfig.ChannelPartnerGranularity] will apply to the [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]. This is the recommended value for both [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] and [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig].
This field is a member of oneof
granularity.
- channel_partner_granularity¶
Applies the repricing configuration at the channel partner level. Only [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] supports this value. Deprecated: This is no longer supported. Use [RepricingConfig.entitlement_granularity][google.cloud.channel.v1.RepricingConfig.entitlement_granularity] instead.
This field is a member of oneof
granularity.
- effective_invoice_month¶
Required. The YearMonth when these adjustments activate. The Day field needs to be “0” since we only accept YearMonth repricing boundaries.
- Type
google.type.date_pb2.Date
- adjustment¶
Required. Information about the adjustment.
- rebilling_basis¶
Required. The [RebillingBasis][google.cloud.channel.v1.RebillingBasis] to use for this bill. Specifies the relative cost based on repricing costs you will apply.
- conditional_overrides¶
The conditional overrides to apply for this configuration. If you list multiple overrides, only the first valid override is used. If you don’t list any overrides, the API uses the normal adjustment and rebilling basis.
- Type
MutableSequence[google.cloud.channel_v1.types.ConditionalOverride]
- class ChannelPartnerGranularity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageApplies the repricing configuration at the channel partner level. The channel partner value is derived from the resource name. Takes an empty json object. Deprecated: This is no longer supported. Use [RepricingConfig.EntitlementGranularity][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity] instead.
- class EntitlementGranularity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageApplies the repricing configuration at the entitlement level.
- class google.cloud.channel_v1.types.ResourceType(value)[source]¶
Bases:
proto.enums.EnumRepresents the type for a monetizable resource(any entity on which billing happens). For example, this could be MINUTES for Google Voice and GB for Google Drive. One SKU can map to multiple monetizable resources.
- Values:
- RESOURCE_TYPE_UNSPECIFIED (0):
Not used.
- SEAT (1):
Seat.
- MAU (2):
Monthly active user.
- GB (3):
GB (used for storage SKUs).
- LICENSED_USER (4):
Active licensed users(for Voice SKUs).
- MINUTES (5):
Voice usage.
- IAAS_USAGE (6):
For IaaS SKUs like Google Cloud, monetization is based on usage accrued on your billing account irrespective of the type of monetizable resource. This enum represents an aggregated resource/container for all usage SKUs on a billing account. Currently, only applicable to Google Cloud.
- SUBSCRIPTION (7):
For Google Cloud subscriptions like Anthos or SAP.
- class google.cloud.channel_v1.types.Row(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA row of report values.
- values¶
The list of values in the row.
- Type
MutableSequence[google.cloud.channel_v1.types.ReportValue]
- class google.cloud.channel_v1.types.RunReportJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
- name¶
Required. The report’s resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example,
613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}- Type
- date_range¶
Optional. The range of usage or invoice dates to include in the result.
- filter¶
Optional. A structured string that defines conditions on dimension columns to restrict the report output.
Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using
column_idas keys.For example:
(customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022- Type
- class google.cloud.channel_v1.types.RunReportJobResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
- report_job¶
Pass
report_job.nameto [FetchReportResultsRequest.report_job][google.cloud.channel.v1.FetchReportResultsRequest.report_job] to retrieve the report’s results.
- report_metadata¶
The metadata for the report’s results (display name, columns, row count, and date range). If you view this before the operation finishes, you may see incomplete data.
- class google.cloud.channel_v1.types.Sku(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a product’s purchasable Stock Keeping Unit (SKU). SKUs represent the different variations of the product. For example, Google Workspace Business Standard and Google Workspace Business Plus are Google Workspace product SKUs.
- marketing_info¶
Marketing information for the SKU.
- product¶
Product the SKU is associated with.
- class google.cloud.channel_v1.types.SkuGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the SKU group information.
- name¶
Resource name of SKU group. Format: accounts/{account}/skuGroups/{sku_group}. Example: “accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041”.
- Type
- class google.cloud.channel_v1.types.SkuGroupCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA condition that applies the override if a line item SKU is found in the SKU group.
- sku_group¶
Specifies a SKU group (https://cloud.google.com/skus/sku-groups). Resource name of SKU group. Format: accounts/{account}/skuGroups/{sku_group}. Example: “accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041”.
- Type
- class google.cloud.channel_v1.types.SkuPurchaseGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a set of SKUs that must be purchased using the same billing account.
- skus¶
Resource names of the SKUs included in this group. Format: products/{product_id}/skus/{sku_id}.
- Type
MutableSequence[str]
- billing_account_purchase_infos¶
List of billing accounts that are eligible to purhcase these SKUs.
- Type
MutableSequence[google.cloud.channel_v1.types.BillingAccountPurchaseInfo]
- class google.cloud.channel_v1.types.StartPaidServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.StartPaidService][google.cloud.channel.v1.CloudChannelService.StartPaidService].
- name¶
Required. The name of the entitlement to start a paid service for. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.SubscriberEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents information which resellers will get as part of notification from Pub/Sub.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- customer_event¶
Customer event sent as part of Pub/Sub event to partners.
This field is a member of oneof
event.
- class google.cloud.channel_v1.types.SuspendEntitlementRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.SuspendEntitlement][google.cloud.channel.v1.CloudChannelService.SuspendEntitlement].
- name¶
Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
- Type
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.TransferEligibility(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies transfer eligibility of a SKU.
- ineligibility_reason¶
Specified the reason for ineligibility.
- class Reason(value)[source]¶
Bases:
proto.enums.EnumReason of ineligibility.
- Values:
- REASON_UNSPECIFIED (0):
Not used.
- PENDING_TOS_ACCEPTANCE (1):
Reseller needs to accept TOS before transferring the SKU.
- SKU_NOT_ELIGIBLE (2):
Reseller not eligible to sell the SKU.
- SKU_SUSPENDED (3):
SKU subscription is suspended
- CHANNEL_PARTNER_NOT_AUTHORIZED_FOR_SKU (4):
The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- class google.cloud.channel_v1.types.TransferEntitlementsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements].
- parent¶
Required. The resource name of the reseller’s customer account that will receive transferred entitlements. Parent uses the format: accounts/{account_id}/customers/{customer_id}
- Type
- entitlements¶
Required. The new entitlements to create or transfer.
- Type
MutableSequence[google.cloud.channel_v1.types.Entitlement]
- auth_token¶
The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.
- Type
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.TransferEntitlementsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements]. This is put in the response field of google.longrunning.Operation.
- entitlements¶
The transferred entitlements.
- Type
MutableSequence[google.cloud.channel_v1.types.Entitlement]
- class google.cloud.channel_v1.types.TransferEntitlementsToGoogleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.TransferEntitlementsToGoogle][google.cloud.channel.v1.CloudChannelService.TransferEntitlementsToGoogle].
- parent¶
Required. The resource name of the reseller’s customer account where the entitlements transfer from. Parent uses the format: accounts/{account_id}/customers/{customer_id}
- Type
- entitlements¶
Required. The entitlements to transfer to Google.
- Type
MutableSequence[google.cloud.channel_v1.types.Entitlement]
- request_id¶
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it’s complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).- Type
- class google.cloud.channel_v1.types.TransferableOffer(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTransferableOffer represents an Offer that can be used in Transfer. Read-only.
- offer¶
Offer with parameter constraints updated to allow the Transfer.
- class google.cloud.channel_v1.types.TransferableSku(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTransferableSku represents information a reseller needs to view existing provisioned services for a customer that they do not own. Read-only.
- transfer_eligibility¶
Describes the transfer eligibility of a SKU.
- sku¶
The SKU pertaining to the provisioning resource as specified in the Offer.
- legacy_sku¶
Optional. The customer to transfer has an entitlement with the populated legacy SKU.
- class google.cloud.channel_v1.types.TrialSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSettings for trial offers.
- trial¶
Determines if the entitlement is in a trial or not:
true- The entitlement is in trial.false- The entitlement is not in trial.
- Type
- end_time¶
Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.
- class google.cloud.channel_v1.types.UnregisterSubscriberRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest Message for UnregisterSubscriber.
- class google.cloud.channel_v1.types.UnregisterSubscriberResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse Message for UnregisterSubscriber.
- class google.cloud.channel_v1.types.UpdateChannelPartnerLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.UpdateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerLink]
- name¶
Required. The resource name of the channel partner link to cancel. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner.
- Type
- channel_partner_link¶
Required. The channel partner link to update. Only channel_partner_link.link_state is allowed for updates.
- update_mask¶
Required. The update mask that applies to the resource. The only allowable value for an update mask is channel_partner_link.link_state.
- class google.cloud.channel_v1.types.UpdateChannelPartnerRepricingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.UpdateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerRepricingConfig].
- channel_partner_repricing_config¶
Required. The ChannelPartnerRepricingConfig object to update.
- class google.cloud.channel_v1.types.UpdateCustomerRepricingConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.UpdateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.UpdateCustomerRepricingConfig].
- customer_repricing_config¶
Required. The CustomerRepricingConfig object to update.
- class google.cloud.channel_v1.types.UpdateCustomerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CloudChannelService.UpdateCustomer][google.cloud.channel.v1.CloudChannelService.UpdateCustomer].
- customer¶
Required. New contents of the customer.
- update_mask¶
The update mask that applies to the resource. Optional.
- class google.cloud.channel_v1.types.Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageData type and value of a parameter.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
