Package Classes (0.1.8)

Summary of entries of Classes for procurement.

Classes

ConsumerProcurementServiceAsyncClient

ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform.

When purchases are made, the ConsumerProcurementService programs the appropriate backends, including both Google's own infrastructure, as well as third-party systems, and to enable billing setup for charging for the procured item.

ConsumerProcurementServiceClient

ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform.

When purchases are made, the ConsumerProcurementService programs the appropriate backends, including both Google's own infrastructure, as well as third-party systems, and to enable billing setup for charging for the procured item.

ListOrdersAsyncPager

A pager for iterating through list_orders requests.

This class thinly wraps an initial ListOrdersResponse object, and provides an __aiter__ method to iterate through its orders field.

If there are more pages, the __aiter__ method will make additional ListOrders requests and continue to iterate through the orders field on the corresponding responses.

All the usual ListOrdersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListOrdersPager

A pager for iterating through list_orders requests.

This class thinly wraps an initial ListOrdersResponse object, and provides an __iter__ method to iterate through its orders field.

If there are more pages, the __iter__ method will make additional ListOrders requests and continue to iterate through the orders field on the corresponding responses.

All the usual ListOrdersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

LicenseManagementServiceAsyncClient

Service for managing licenses.

LicenseManagementServiceClient

Service for managing licenses.

EnumerateLicensedUsersAsyncPager

A pager for iterating through enumerate_licensed_users requests.

This class thinly wraps an initial EnumerateLicensedUsersResponse object, and provides an __aiter__ method to iterate through its licensed_users field.

If there are more pages, the __aiter__ method will make additional EnumerateLicensedUsers requests and continue to iterate through the licensed_users field on the corresponding responses.

All the usual EnumerateLicensedUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

EnumerateLicensedUsersPager

A pager for iterating through enumerate_licensed_users requests.

This class thinly wraps an initial EnumerateLicensedUsersResponse object, and provides an __iter__ method to iterate through its licensed_users field.

If there are more pages, the __iter__ method will make additional EnumerateLicensedUsers requests and continue to iterate through the licensed_users field on the corresponding responses.

All the usual EnumerateLicensedUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AssignRequest

Request message for LicenseManagementService.Assign.

AssignResponse

Response message for LicenseManagementService.Assign.

AssignmentProtocol

Assignment protocol for a license pool.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AutoAssignmentType

Configuration for automatic assignments handled by data plane operations.

ManualAssignmentType

Allow manual assignments triggered by administrative operations only.

AutoRenewalBehavior

Indicates the auto renewal behavior customer specifies on subscription.

CancelOrderMetadata

Message stored in the metadata field of the Operation returned by ConsumerProcurementService.CancelOrder.

CancelOrderRequest

Request message for ConsumerProcurementService.CancelOrder.

CancellationPolicy

Indicates the cancellation policy the customer uses to cancel the order.

EnumerateLicensedUsersRequest

Request message for LicenseManagementService.EnumerateLicensedUsers.

EnumerateLicensedUsersResponse

Response message for LicenseManagementService.EnumerateLicensedUsers.

GetLicensePoolRequest

Request message for getting a license pool.

GetOrderRequest

Request message for ConsumerProcurementService.GetOrder

LicensePool

A license pool represents a pool of licenses that can be assigned to users.

LicensedUser

A licensed user.

LineItem

A single item within an order.

LineItemChange

A change made on a line item.

LineItemChangeState

State of a change.

LineItemChangeStateReasonType

Predefined types for line item change state reason.

LineItemChangeType

Type of a line item change.

LineItemInfo

Line item information.

ListOrdersRequest

Request message for ConsumerProcurementService.ListOrders.

ListOrdersResponse

Response message for ConsumerProcurementService.ListOrders.

ModifyOrderMetadata

Message stored in the metadata field of the Operation returned by ConsumerProcurementService.ModifyOrder.

ModifyOrderRequest

Request message for ConsumerProcurementService.ModifyOrder.

Modification

Modifications to make on the order.

Order

Represents a purchase made by a customer on Cloud Marketplace. Creating an order makes sure that both the Google backend systems as well as external service provider's systems (if needed) allow use of purchased products and ensures the appropriate billing events occur.

An Order can be made against one Product with multiple add-ons (optional) or one Quote which might reference multiple products.

Customers typically choose a price plan for each Product purchased when they create an order and can change their plan later, if the product allows.

Parameter

User-provided Parameters.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PlaceOrderMetadata

Message stored in the metadata field of the Operation returned by ConsumerProcurementService.PlaceOrder.

PlaceOrderRequest

Request message for ConsumerProcurementService.PlaceOrder.

Subscription

Subscription information.

UnassignRequest

Request message for LicenseManagementService.Unassign.

UnassignResponse

Response message for LicenseManagementService.Unassign.

UpdateLicensePoolRequest

Request message for updating a license pool.

ConsumerProcurementServiceAsyncClient

ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform.

When purchases are made, the ConsumerProcurementService programs the appropriate backends, including both Google's own infrastructure, as well as third-party systems, and to enable billing setup for charging for the procured item.

ConsumerProcurementServiceClient

ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform.

When purchases are made, the ConsumerProcurementService programs the appropriate backends, including both Google's own infrastructure, as well as third-party systems, and to enable billing setup for charging for the procured item.

ListOrdersAsyncPager

A pager for iterating through list_orders requests.

This class thinly wraps an initial ListOrdersResponse object, and provides an __aiter__ method to iterate through its orders field.

If there are more pages, the __aiter__ method will make additional ListOrders requests and continue to iterate through the orders field on the corresponding responses.

All the usual ListOrdersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListOrdersPager

A pager for iterating through list_orders requests.

This class thinly wraps an initial ListOrdersResponse object, and provides an __iter__ method to iterate through its orders field.

If there are more pages, the __iter__ method will make additional ListOrders requests and continue to iterate through the orders field on the corresponding responses.

All the usual ListOrdersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

GetOrderRequest

Request message for ConsumerProcurementService.GetOrder

LineItem

A single item within an order.

LineItemChange

A change made on a line item.

LineItemChangeState

State of a change.

LineItemChangeStateReasonType

Predefined types for line item change state reason.

LineItemChangeType

Type of a line item change.

LineItemInfo

Line item information.

ListOrdersRequest

Request message for ConsumerProcurementService.ListOrders.

ListOrdersResponse

Response message for ConsumerProcurementService.ListOrders.

Order

Represents a purchase made by a customer on Cloud Marketplace. Creating an order makes sure that both the Google backend systems as well as external service provider's systems (if needed) allow use of purchased products and ensures the appropriate billing events occur.

An Order can be made against one Product with multiple add-ons (optional) or one Quote which might reference multiple products.

Customers typically choose a price plan for each Product purchased when they create an order and can change their plan later, if the product allows.

Parameter

User-provided Parameters.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PlaceOrderMetadata

Message stored in the metadata field of the Operation returned by ConsumerProcurementService.PlaceOrder.

PlaceOrderRequest

Request message for ConsumerProcurementService.PlaceOrder.

Subscription

Subscription information.

Modules

pagers

API documentation for commerce_consumer_procurement_v1.services.consumer_procurement_service.pagers module.

pagers

API documentation for commerce_consumer_procurement_v1.services.license_management_service.pagers module.

pagers

API documentation for commerce_consumer_procurement_v1alpha1.services.consumer_procurement_service.pagers module.