procurementpb

package
v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 23, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	LineItemChangeType_name = map[int32]string{
		0: "LINE_ITEM_CHANGE_TYPE_UNSPECIFIED",
		1: "LINE_ITEM_CHANGE_TYPE_CREATE",
		2: "LINE_ITEM_CHANGE_TYPE_UPDATE",
		3: "LINE_ITEM_CHANGE_TYPE_CANCEL",
		4: "LINE_ITEM_CHANGE_TYPE_REVERT_CANCELLATION",
	}
	LineItemChangeType_value = map[string]int32{
		"LINE_ITEM_CHANGE_TYPE_UNSPECIFIED":         0,
		"LINE_ITEM_CHANGE_TYPE_CREATE":              1,
		"LINE_ITEM_CHANGE_TYPE_UPDATE":              2,
		"LINE_ITEM_CHANGE_TYPE_CANCEL":              3,
		"LINE_ITEM_CHANGE_TYPE_REVERT_CANCELLATION": 4,
	}
)

Enum value maps for LineItemChangeType.

View Source
var (
	LineItemChangeState_name = map[int32]string{
		0: "LINE_ITEM_CHANGE_STATE_UNSPECIFIED",
		1: "LINE_ITEM_CHANGE_STATE_PENDING_APPROVAL",
		2: "LINE_ITEM_CHANGE_STATE_APPROVED",
		3: "LINE_ITEM_CHANGE_STATE_COMPLETED",
		4: "LINE_ITEM_CHANGE_STATE_REJECTED",
		5: "LINE_ITEM_CHANGE_STATE_ABANDONED",
		6: "LINE_ITEM_CHANGE_STATE_ACTIVATING",
	}
	LineItemChangeState_value = map[string]int32{
		"LINE_ITEM_CHANGE_STATE_UNSPECIFIED":      0,
		"LINE_ITEM_CHANGE_STATE_PENDING_APPROVAL": 1,
		"LINE_ITEM_CHANGE_STATE_APPROVED":         2,
		"LINE_ITEM_CHANGE_STATE_COMPLETED":        3,
		"LINE_ITEM_CHANGE_STATE_REJECTED":         4,
		"LINE_ITEM_CHANGE_STATE_ABANDONED":        5,
		"LINE_ITEM_CHANGE_STATE_ACTIVATING":       6,
	}
)

Enum value maps for LineItemChangeState.

View Source
var (
	LineItemChangeStateReasonType_name = map[int32]string{
		0: "LINE_ITEM_CHANGE_STATE_REASON_TYPE_UNSPECIFIED",
		1: "LINE_ITEM_CHANGE_STATE_REASON_TYPE_EXPIRED",
		2: "LINE_ITEM_CHANGE_STATE_REASON_TYPE_USER_CANCELLED",
		3: "LINE_ITEM_CHANGE_STATE_REASON_TYPE_SYSTEM_CANCELLED",
	}
	LineItemChangeStateReasonType_value = map[string]int32{
		"LINE_ITEM_CHANGE_STATE_REASON_TYPE_UNSPECIFIED":      0,
		"LINE_ITEM_CHANGE_STATE_REASON_TYPE_EXPIRED":          1,
		"LINE_ITEM_CHANGE_STATE_REASON_TYPE_USER_CANCELLED":   2,
		"LINE_ITEM_CHANGE_STATE_REASON_TYPE_SYSTEM_CANCELLED": 3,
	}
)

Enum value maps for LineItemChangeStateReasonType.

View Source
var (
	AutoRenewalBehavior_name = map[int32]string{
		0: "AUTO_RENEWAL_BEHAVIOR_UNSPECIFIED",
		1: "AUTO_RENEWAL_BEHAVIOR_ENABLE",
		2: "AUTO_RENEWAL_BEHAVIOR_DISABLE",
	}
	AutoRenewalBehavior_value = map[string]int32{
		"AUTO_RENEWAL_BEHAVIOR_UNSPECIFIED": 0,
		"AUTO_RENEWAL_BEHAVIOR_ENABLE":      1,
		"AUTO_RENEWAL_BEHAVIOR_DISABLE":     2,
	}
)

Enum value maps for AutoRenewalBehavior.

View Source
var (
	CancelOrderRequest_CancellationPolicy_name = map[int32]string{
		0: "CANCELLATION_POLICY_UNSPECIFIED",
		1: "CANCELLATION_POLICY_CANCEL_IMMEDIATELY",
		2: "CANCELLATION_POLICY_CANCEL_AT_TERM_END",
	}
	CancelOrderRequest_CancellationPolicy_value = map[string]int32{
		"CANCELLATION_POLICY_UNSPECIFIED":        0,
		"CANCELLATION_POLICY_CANCEL_IMMEDIATELY": 1,
		"CANCELLATION_POLICY_CANCEL_AT_TERM_END": 2,
	}
)

Enum value maps for CancelOrderRequest_CancellationPolicy.

View Source
var File_google_cloud_commerce_consumer_procurement_v1_license_management_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_commerce_consumer_procurement_v1_order_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_commerce_consumer_procurement_v1_procurement_service_proto protoreflect.FileDescriptor

Functions

func RegisterConsumerProcurementServiceServer

func RegisterConsumerProcurementServiceServer(s *grpc.Server, srv ConsumerProcurementServiceServer)

func RegisterLicenseManagementServiceServer added in v1.2.0

func RegisterLicenseManagementServiceServer(s *grpc.Server, srv LicenseManagementServiceServer)

Types

type AssignRequest added in v1.2.0

type AssignRequest struct {

	// Required. License pool name.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Username.
	// Format: `name@domain.com`.
	Usernames []string `protobuf:"bytes,2,rep,name=usernames,proto3" json:"usernames,omitempty"`
	// contains filtered or unexported fields
}

Request message for [LicenseManagementService.Assign][google.cloud.commerce.consumer.procurement.v1.LicenseManagementService.Assign].

func (*AssignRequest) Descriptor deprecated added in v1.2.0

func (*AssignRequest) Descriptor() ([]byte, []int)

Deprecated: Use AssignRequest.ProtoReflect.Descriptor instead.

func (*AssignRequest) GetParent added in v1.2.0

func (x *AssignRequest) GetParent() string

func (*AssignRequest) GetUsernames added in v1.2.0

func (x *AssignRequest) GetUsernames() []string

func (*AssignRequest) ProtoMessage added in v1.2.0

func (*AssignRequest) ProtoMessage()

func (*AssignRequest) ProtoReflect added in v1.2.0

func (x *AssignRequest) ProtoReflect() protoreflect.Message

func (*AssignRequest) Reset added in v1.2.0

func (x *AssignRequest) Reset()

func (*AssignRequest) String added in v1.2.0

func (x *AssignRequest) String() string

type AssignResponse added in v1.2.0

type AssignResponse struct {
	// contains filtered or unexported fields
}

Response message for [LicenseManagementService.Assign][google.cloud.commerce.consumer.procurement.v1.LicenseManagementService.Assign].

func (*AssignResponse) Descriptor deprecated added in v1.2.0

func (*AssignResponse) Descriptor() ([]byte, []int)

Deprecated: Use AssignResponse.ProtoReflect.Descriptor instead.

func (*AssignResponse) ProtoMessage added in v1.2.0

func (*AssignResponse) ProtoMessage()

func (*AssignResponse) ProtoReflect added in v1.2.0

func (x *AssignResponse) ProtoReflect() protoreflect.Message

func (*AssignResponse) Reset added in v1.2.0

func (x *AssignResponse) Reset()

func (*AssignResponse) String added in v1.2.0

func (x *AssignResponse) String() string

type AssignmentProtocol added in v1.2.0

type AssignmentProtocol struct {

	// The type of assignment protocol.
	//
	// Types that are assignable to AssignmentType:
	//
	//	*AssignmentProtocol_ManualAssignmentType_
	//	*AssignmentProtocol_AutoAssignmentType_
	AssignmentType isAssignmentProtocol_AssignmentType `protobuf_oneof:"assignment_type"`
	// contains filtered or unexported fields
}

Assignment protocol for a license pool.

func (*AssignmentProtocol) Descriptor deprecated added in v1.2.0

func (*AssignmentProtocol) Descriptor() ([]byte, []int)

Deprecated: Use AssignmentProtocol.ProtoReflect.Descriptor instead.

func (*AssignmentProtocol) GetAssignmentType added in v1.2.0

func (m *AssignmentProtocol) GetAssignmentType() isAssignmentProtocol_AssignmentType

func (*AssignmentProtocol) GetAutoAssignmentType added in v1.2.0

func (x *AssignmentProtocol) GetAutoAssignmentType() *AssignmentProtocol_AutoAssignmentType

func (*AssignmentProtocol) GetManualAssignmentType added in v1.2.0

func (x *AssignmentProtocol) GetManualAssignmentType() *AssignmentProtocol_ManualAssignmentType

func (*AssignmentProtocol) ProtoMessage added in v1.2.0

func (*AssignmentProtocol) ProtoMessage()

func (*AssignmentProtocol) ProtoReflect added in v1.2.0

func (x *AssignmentProtocol) ProtoReflect() protoreflect.Message

func (*AssignmentProtocol) Reset added in v1.2.0

func (x *AssignmentProtocol) Reset()

func (*AssignmentProtocol) String added in v1.2.0

func (x *AssignmentProtocol) String() string

type AssignmentProtocol_AutoAssignmentType added in v1.2.0

type AssignmentProtocol_AutoAssignmentType struct {

	// Optional. The time to live for an inactive license. After this time has
	// passed, the license will be automatically unassigned from the user. Must
	// be at least 7 days, if set. If unset, the license will never expire.
	InactiveLicenseTtl *durationpb.Duration `protobuf:"bytes,1,opt,name=inactive_license_ttl,json=inactiveLicenseTtl,proto3" json:"inactive_license_ttl,omitempty"`
	// contains filtered or unexported fields
}

Configuration for automatic assignments handled by data plane operations.

func (*AssignmentProtocol_AutoAssignmentType) Descriptor deprecated added in v1.2.0

func (*AssignmentProtocol_AutoAssignmentType) Descriptor() ([]byte, []int)

Deprecated: Use AssignmentProtocol_AutoAssignmentType.ProtoReflect.Descriptor instead.

func (*AssignmentProtocol_AutoAssignmentType) GetInactiveLicenseTtl added in v1.2.0

func (x *AssignmentProtocol_AutoAssignmentType) GetInactiveLicenseTtl() *durationpb.Duration

func (*AssignmentProtocol_AutoAssignmentType) ProtoMessage added in v1.2.0

func (*AssignmentProtocol_AutoAssignmentType) ProtoMessage()

func (*AssignmentProtocol_AutoAssignmentType) ProtoReflect added in v1.2.0

func (*AssignmentProtocol_AutoAssignmentType) Reset added in v1.2.0

func (*AssignmentProtocol_AutoAssignmentType) String added in v1.2.0

type AssignmentProtocol_AutoAssignmentType_ added in v1.2.0

type AssignmentProtocol_AutoAssignmentType_ struct {
	// Allow automatic assignments triggered by data plane operations.
	AutoAssignmentType *AssignmentProtocol_AutoAssignmentType `protobuf:"bytes,3,opt,name=auto_assignment_type,json=autoAssignmentType,proto3,oneof"`
}

type AssignmentProtocol_ManualAssignmentType added in v1.2.0

type AssignmentProtocol_ManualAssignmentType struct {
	// contains filtered or unexported fields
}

Allow manual assignments triggered by administrative operations only.

func (*AssignmentProtocol_ManualAssignmentType) Descriptor deprecated added in v1.2.0

func (*AssignmentProtocol_ManualAssignmentType) Descriptor() ([]byte, []int)

Deprecated: Use AssignmentProtocol_ManualAssignmentType.ProtoReflect.Descriptor instead.

func (*AssignmentProtocol_ManualAssignmentType) ProtoMessage added in v1.2.0

func (*AssignmentProtocol_ManualAssignmentType) ProtoReflect added in v1.2.0

func (*AssignmentProtocol_ManualAssignmentType) Reset added in v1.2.0

func (*AssignmentProtocol_ManualAssignmentType) String added in v1.2.0

type AssignmentProtocol_ManualAssignmentType_ added in v1.2.0

type AssignmentProtocol_ManualAssignmentType_ struct {
	// Allow manual assignments triggered by administrative operations only.
	ManualAssignmentType *AssignmentProtocol_ManualAssignmentType `protobuf:"bytes,2,opt,name=manual_assignment_type,json=manualAssignmentType,proto3,oneof"`
}

type AutoRenewalBehavior added in v1.2.0

type AutoRenewalBehavior int32

Indicates the auto renewal behavior customer specifies on subscription.

const (
	// If unspecified, the auto renewal behavior will follow the default config.
	AutoRenewalBehavior_AUTO_RENEWAL_BEHAVIOR_UNSPECIFIED AutoRenewalBehavior = 0
	// Auto Renewal will be enabled on subscription.
	AutoRenewalBehavior_AUTO_RENEWAL_BEHAVIOR_ENABLE AutoRenewalBehavior = 1
	// Auto Renewal will be disabled on subscription.
	AutoRenewalBehavior_AUTO_RENEWAL_BEHAVIOR_DISABLE AutoRenewalBehavior = 2
)

func (AutoRenewalBehavior) Descriptor added in v1.2.0

func (AutoRenewalBehavior) Enum added in v1.2.0

func (AutoRenewalBehavior) EnumDescriptor deprecated added in v1.2.0

func (AutoRenewalBehavior) EnumDescriptor() ([]byte, []int)

Deprecated: Use AutoRenewalBehavior.Descriptor instead.

func (AutoRenewalBehavior) Number added in v1.2.0

func (AutoRenewalBehavior) String added in v1.2.0

func (x AutoRenewalBehavior) String() string

func (AutoRenewalBehavior) Type added in v1.2.0

type CancelOrderMetadata added in v1.2.0

type CancelOrderMetadata struct {
	// contains filtered or unexported fields
}

Message stored in the metadata field of the Operation returned by [ConsumerProcurementService.CancelOrder][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService.CancelOrder].

func (*CancelOrderMetadata) Descriptor deprecated added in v1.2.0

func (*CancelOrderMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CancelOrderMetadata.ProtoReflect.Descriptor instead.

func (*CancelOrderMetadata) ProtoMessage added in v1.2.0

func (*CancelOrderMetadata) ProtoMessage()

func (*CancelOrderMetadata) ProtoReflect added in v1.2.0

func (x *CancelOrderMetadata) ProtoReflect() protoreflect.Message

func (*CancelOrderMetadata) Reset added in v1.2.0

func (x *CancelOrderMetadata) Reset()

func (*CancelOrderMetadata) String added in v1.2.0

func (x *CancelOrderMetadata) String() string

type CancelOrderRequest added in v1.2.0

type CancelOrderRequest struct {

	// Required. The resource name of the order.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The weak etag, which can be optionally populated, of the order
	// that this cancel request is based on. Validation checking will only happen
	// if the invoker supplies this field.
	Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
	// Optional. Cancellation policy of this request.
	CancellationPolicy CancelOrderRequest_CancellationPolicy `` /* 205-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for [ConsumerProcurementService.CancelOrder][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService.CancelOrder].

func (*CancelOrderRequest) Descriptor deprecated added in v1.2.0

func (*CancelOrderRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelOrderRequest.ProtoReflect.Descriptor instead.

func (*CancelOrderRequest) GetCancellationPolicy added in v1.2.0

func (x *CancelOrderRequest) GetCancellationPolicy() CancelOrderRequest_CancellationPolicy

func (*CancelOrderRequest) GetEtag added in v1.2.0

func (x *CancelOrderRequest) GetEtag() string

func (*CancelOrderRequest) GetName added in v1.2.0

func (x *CancelOrderRequest) GetName() string

func (*CancelOrderRequest) ProtoMessage added in v1.2.0

func (*CancelOrderRequest) ProtoMessage()

func (*CancelOrderRequest) ProtoReflect added in v1.2.0

func (x *CancelOrderRequest) ProtoReflect() protoreflect.Message

func (*CancelOrderRequest) Reset added in v1.2.0

func (x *CancelOrderRequest) Reset()

func (*CancelOrderRequest) String added in v1.2.0

func (x *CancelOrderRequest) String() string

type CancelOrderRequest_CancellationPolicy added in v1.2.0

type CancelOrderRequest_CancellationPolicy int32

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

const (
	// If unspecified, cancellation will try to cancel the order, if order
	// cannot be immediately cancelled, auto renewal will be turned off.
	// However, caller should avoid using the value as it will yield a
	// non-deterministic result. This is still supported mainly to maintain
	// existing integrated usages and ensure backwards compatibility.
	CancelOrderRequest_CANCELLATION_POLICY_UNSPECIFIED CancelOrderRequest_CancellationPolicy = 0
	// Request will cancel the whole order immediately, if order cannot be
	// immediately cancelled, the request will fail.
	CancelOrderRequest_CANCELLATION_POLICY_CANCEL_IMMEDIATELY CancelOrderRequest_CancellationPolicy = 1
	// Request will cancel the auto renewal, if order is not subscription based,
	// the request will fail.
	CancelOrderRequest_CANCELLATION_POLICY_CANCEL_AT_TERM_END CancelOrderRequest_CancellationPolicy = 2
)

func (CancelOrderRequest_CancellationPolicy) Descriptor added in v1.2.0

func (CancelOrderRequest_CancellationPolicy) Enum added in v1.2.0

func (CancelOrderRequest_CancellationPolicy) EnumDescriptor deprecated added in v1.2.0

func (CancelOrderRequest_CancellationPolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use CancelOrderRequest_CancellationPolicy.Descriptor instead.

func (CancelOrderRequest_CancellationPolicy) Number added in v1.2.0

func (CancelOrderRequest_CancellationPolicy) String added in v1.2.0

func (CancelOrderRequest_CancellationPolicy) Type added in v1.2.0

type ConsumerProcurementServiceClient

type ConsumerProcurementServiceClient interface {
	// Creates a new [Order][google.cloud.commerce.consumer.procurement.v1.Order].
	//
	// This API only supports GCP spend-based committed use
	// discounts specified by GCP documentation.
	//
	// The returned long-running operation is in-progress until the backend
	// completes the creation of the resource. Once completed, the order is
	// in
	// [OrderState.ORDER_STATE_ACTIVE][google.cloud.commerce.consumer.procurement.v1.OrderState.ORDER_STATE_ACTIVE].
	// In case of failure, the order resource will be removed.
	PlaceOrder(ctx context.Context, in *PlaceOrderRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Returns the requested
	// [Order][google.cloud.commerce.consumer.procurement.v1.Order] resource.
	GetOrder(ctx context.Context, in *GetOrderRequest, opts ...grpc.CallOption) (*Order, error)
	// Lists [Order][google.cloud.commerce.consumer.procurement.v1.Order]
	// resources that the user has access to, within the scope of the parent
	// resource.
	ListOrders(ctx context.Context, in *ListOrdersRequest, opts ...grpc.CallOption) (*ListOrdersResponse, error)
	// Modifies an existing
	// [Order][google.cloud.commerce.consumer.procurement.v1.Order] resource.
	ModifyOrder(ctx context.Context, in *ModifyOrderRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Cancels an existing
	// [Order][google.cloud.commerce.consumer.procurement.v1.Order]. Every product
	// procured in the Order will be cancelled.
	CancelOrder(ctx context.Context, in *CancelOrderRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

ConsumerProcurementServiceClient is the client API for ConsumerProcurementService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type ConsumerProcurementServiceServer

type ConsumerProcurementServiceServer interface {
	// Creates a new [Order][google.cloud.commerce.consumer.procurement.v1.Order].
	//
	// This API only supports GCP spend-based committed use
	// discounts specified by GCP documentation.
	//
	// The returned long-running operation is in-progress until the backend
	// completes the creation of the resource. Once completed, the order is
	// in
	// [OrderState.ORDER_STATE_ACTIVE][google.cloud.commerce.consumer.procurement.v1.OrderState.ORDER_STATE_ACTIVE].
	// In case of failure, the order resource will be removed.
	PlaceOrder(context.Context, *PlaceOrderRequest) (*longrunningpb.Operation, error)
	// Returns the requested
	// [Order][google.cloud.commerce.consumer.procurement.v1.Order] resource.
	GetOrder(context.Context, *GetOrderRequest) (*Order, error)
	// Lists [Order][google.cloud.commerce.consumer.procurement.v1.Order]
	// resources that the user has access to, within the scope of the parent
	// resource.
	ListOrders(context.Context, *ListOrdersRequest) (*ListOrdersResponse, error)
	// Modifies an existing
	// [Order][google.cloud.commerce.consumer.procurement.v1.Order] resource.
	ModifyOrder(context.Context, *ModifyOrderRequest) (*longrunningpb.Operation, error)
	// Cancels an existing
	// [Order][google.cloud.commerce.consumer.procurement.v1.Order]. Every product
	// procured in the Order will be cancelled.
	CancelOrder(context.Context, *CancelOrderRequest) (*longrunningpb.Operation, error)
}

ConsumerProcurementServiceServer is the server API for ConsumerProcurementService service.

type EnumerateLicensedUsersRequest added in v1.2.0

type EnumerateLicensedUsersRequest struct {

	// Required. License pool name.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of users to return. The service may return
	// fewer than this value.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `EnumerateLicensedUsers`
	// call. Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [LicenseManagementService.EnumerateLicensedUsers][google.cloud.commerce.consumer.procurement.v1.LicenseManagementService.EnumerateLicensedUsers].

func (*EnumerateLicensedUsersRequest) Descriptor deprecated added in v1.2.0

func (*EnumerateLicensedUsersRequest) Descriptor() ([]byte, []int)

Deprecated: Use EnumerateLicensedUsersRequest.ProtoReflect.Descriptor instead.

func (*EnumerateLicensedUsersRequest) GetPageSize added in v1.2.0

func (x *EnumerateLicensedUsersRequest) GetPageSize() int32

func (*EnumerateLicensedUsersRequest) GetPageToken added in v1.2.0

func (x *EnumerateLicensedUsersRequest) GetPageToken() string

func (*EnumerateLicensedUsersRequest) GetParent added in v1.2.0

func (x *EnumerateLicensedUsersRequest) GetParent() string

func (*EnumerateLicensedUsersRequest) ProtoMessage added in v1.2.0

func (*EnumerateLicensedUsersRequest) ProtoMessage()

func (*EnumerateLicensedUsersRequest) ProtoReflect added in v1.2.0

func (*EnumerateLicensedUsersRequest) Reset added in v1.2.0

func (x *EnumerateLicensedUsersRequest) Reset()

func (*EnumerateLicensedUsersRequest) String added in v1.2.0

type EnumerateLicensedUsersResponse added in v1.2.0

type EnumerateLicensedUsersResponse struct {

	// The list of licensed users.
	LicensedUsers []*LicensedUser `protobuf:"bytes,1,rep,name=licensed_users,json=licensedUsers,proto3" json:"licensed_users,omitempty"`
	// A token that can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [LicenseManagementService.EnumerateLicensedUsers][google.cloud.commerce.consumer.procurement.v1.LicenseManagementService.EnumerateLicensedUsers].

func (*EnumerateLicensedUsersResponse) Descriptor deprecated added in v1.2.0

func (*EnumerateLicensedUsersResponse) Descriptor() ([]byte, []int)

Deprecated: Use EnumerateLicensedUsersResponse.ProtoReflect.Descriptor instead.

func (*EnumerateLicensedUsersResponse) GetLicensedUsers added in v1.2.0

func (x *EnumerateLicensedUsersResponse) GetLicensedUsers() []*LicensedUser

func (*EnumerateLicensedUsersResponse) GetNextPageToken added in v1.2.0

func (x *EnumerateLicensedUsersResponse) GetNextPageToken() string

func (*EnumerateLicensedUsersResponse) ProtoMessage added in v1.2.0

func (*EnumerateLicensedUsersResponse) ProtoMessage()

func (*EnumerateLicensedUsersResponse) ProtoReflect added in v1.2.0

func (*EnumerateLicensedUsersResponse) Reset added in v1.2.0

func (x *EnumerateLicensedUsersResponse) Reset()

func (*EnumerateLicensedUsersResponse) String added in v1.2.0

type GetLicensePoolRequest added in v1.2.0

type GetLicensePoolRequest struct {

	// Required. The name of the license pool to get.
	// Format: `billingAccounts/{billing_account}/orders/{order}/licensePool`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for getting a license pool.

func (*GetLicensePoolRequest) Descriptor deprecated added in v1.2.0

func (*GetLicensePoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetLicensePoolRequest.ProtoReflect.Descriptor instead.

func (*GetLicensePoolRequest) GetName added in v1.2.0

func (x *GetLicensePoolRequest) GetName() string

func (*GetLicensePoolRequest) ProtoMessage added in v1.2.0

func (*GetLicensePoolRequest) ProtoMessage()

func (*GetLicensePoolRequest) ProtoReflect added in v1.2.0

func (x *GetLicensePoolRequest) ProtoReflect() protoreflect.Message

func (*GetLicensePoolRequest) Reset added in v1.2.0

func (x *GetLicensePoolRequest) Reset()

func (*GetLicensePoolRequest) String added in v1.2.0

func (x *GetLicensePoolRequest) String() string

type GetOrderRequest

type GetOrderRequest struct {

	// Required. The name of the order to retrieve.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ConsumerProcurementService.GetOrder][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService.GetOrder]

func (*GetOrderRequest) Descriptor deprecated

func (*GetOrderRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetOrderRequest.ProtoReflect.Descriptor instead.

func (*GetOrderRequest) GetName

func (x *GetOrderRequest) GetName() string

func (*GetOrderRequest) ProtoMessage

func (*GetOrderRequest) ProtoMessage()

func (*GetOrderRequest) ProtoReflect

func (x *GetOrderRequest) ProtoReflect() protoreflect.Message

func (*GetOrderRequest) Reset

func (x *GetOrderRequest) Reset()

func (*GetOrderRequest) String

func (x *GetOrderRequest) String() string

type LicenseManagementServiceClient added in v1.2.0

type LicenseManagementServiceClient interface {
	// Gets the license pool.
	GetLicensePool(ctx context.Context, in *GetLicensePoolRequest, opts ...grpc.CallOption) (*LicensePool, error)
	// Updates the license pool if one exists for this Order.
	UpdateLicensePool(ctx context.Context, in *UpdateLicensePoolRequest, opts ...grpc.CallOption) (*LicensePool, error)
	// Assigns a license to a user.
	Assign(ctx context.Context, in *AssignRequest, opts ...grpc.CallOption) (*AssignResponse, error)
	// Unassigns a license from a user.
	Unassign(ctx context.Context, in *UnassignRequest, opts ...grpc.CallOption) (*UnassignResponse, error)
	// Enumerates all users assigned a license.
	EnumerateLicensedUsers(ctx context.Context, in *EnumerateLicensedUsersRequest, opts ...grpc.CallOption) (*EnumerateLicensedUsersResponse, error)
}

LicenseManagementServiceClient is the client API for LicenseManagementService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewLicenseManagementServiceClient added in v1.2.0

func NewLicenseManagementServiceClient(cc grpc.ClientConnInterface) LicenseManagementServiceClient

type LicenseManagementServiceServer added in v1.2.0

type LicenseManagementServiceServer interface {
	// Gets the license pool.
	GetLicensePool(context.Context, *GetLicensePoolRequest) (*LicensePool, error)
	// Updates the license pool if one exists for this Order.
	UpdateLicensePool(context.Context, *UpdateLicensePoolRequest) (*LicensePool, error)
	// Assigns a license to a user.
	Assign(context.Context, *AssignRequest) (*AssignResponse, error)
	// Unassigns a license from a user.
	Unassign(context.Context, *UnassignRequest) (*UnassignResponse, error)
	// Enumerates all users assigned a license.
	EnumerateLicensedUsers(context.Context, *EnumerateLicensedUsersRequest) (*EnumerateLicensedUsersResponse, error)
}

LicenseManagementServiceServer is the server API for LicenseManagementService service.

type LicensePool added in v1.2.0

type LicensePool struct {

	// Identifier. Format:
	// `billingAccounts/{billing_account}/orders/{order}/licensePool`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Assignment protocol for the license pool.
	LicenseAssignmentProtocol *AssignmentProtocol `` /* 138-byte string literal not displayed */
	// Output only. Licenses count that are available to be assigned.
	AvailableLicenseCount int32 `` /* 127-byte string literal not displayed */
	// Output only. Total number of licenses in the pool.
	TotalLicenseCount int32 `protobuf:"varint,4,opt,name=total_license_count,json=totalLicenseCount,proto3" json:"total_license_count,omitempty"`
	// contains filtered or unexported fields
}

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

func (*LicensePool) Descriptor deprecated added in v1.2.0

func (*LicensePool) Descriptor() ([]byte, []int)

Deprecated: Use LicensePool.ProtoReflect.Descriptor instead.

func (*LicensePool) GetAvailableLicenseCount added in v1.2.0

func (x *LicensePool) GetAvailableLicenseCount() int32

func (*LicensePool) GetLicenseAssignmentProtocol added in v1.2.0

func (x *LicensePool) GetLicenseAssignmentProtocol() *AssignmentProtocol

func (*LicensePool) GetName added in v1.2.0

func (x *LicensePool) GetName() string

func (*LicensePool) GetTotalLicenseCount added in v1.2.0

func (x *LicensePool) GetTotalLicenseCount() int32

func (*LicensePool) ProtoMessage added in v1.2.0

func (*LicensePool) ProtoMessage()

func (*LicensePool) ProtoReflect added in v1.2.0

func (x *LicensePool) ProtoReflect() protoreflect.Message

func (*LicensePool) Reset added in v1.2.0

func (x *LicensePool) Reset()

func (*LicensePool) String added in v1.2.0

func (x *LicensePool) String() string

type LicensedUser added in v1.2.0

type LicensedUser struct {

	// Username.
	// Format: `name@domain.com`.
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// Output only. Timestamp when the license was assigned.
	AssignTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=assign_time,json=assignTime,proto3" json:"assign_time,omitempty"`
	// Output only. Timestamp when the license was recently used. This may not be
	// the most recent usage time, and will be updated regularly (within 24
	// hours).
	RecentUsageTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=recent_usage_time,json=recentUsageTime,proto3" json:"recent_usage_time,omitempty"`
	// contains filtered or unexported fields
}

A licensed user.

func (*LicensedUser) Descriptor deprecated added in v1.2.0

func (*LicensedUser) Descriptor() ([]byte, []int)

Deprecated: Use LicensedUser.ProtoReflect.Descriptor instead.

func (*LicensedUser) GetAssignTime added in v1.2.0

func (x *LicensedUser) GetAssignTime() *timestamppb.Timestamp

func (*LicensedUser) GetRecentUsageTime added in v1.2.0

func (x *LicensedUser) GetRecentUsageTime() *timestamppb.Timestamp

func (*LicensedUser) GetUsername added in v1.2.0

func (x *LicensedUser) GetUsername() string

func (*LicensedUser) ProtoMessage added in v1.2.0

func (*LicensedUser) ProtoMessage()

func (*LicensedUser) ProtoReflect added in v1.2.0

func (x *LicensedUser) ProtoReflect() protoreflect.Message

func (*LicensedUser) Reset added in v1.2.0

func (x *LicensedUser) Reset()

func (*LicensedUser) String added in v1.2.0

func (x *LicensedUser) String() string

type LineItem

type LineItem struct {

	// Output only. Line item ID.
	LineItemId string `protobuf:"bytes,1,opt,name=line_item_id,json=lineItemId,proto3" json:"line_item_id,omitempty"`
	// Output only. Current state and information of this item. It tells what,
	// e.g. which offer, is currently effective.
	LineItemInfo *LineItemInfo `protobuf:"bytes,2,opt,name=line_item_info,json=lineItemInfo,proto3" json:"line_item_info,omitempty"`
	// Output only. A change made on the item which is pending and not yet
	// effective. Absence of this field indicates the line item is not undergoing
	// a change.
	PendingChange *LineItemChange `protobuf:"bytes,3,opt,name=pending_change,json=pendingChange,proto3" json:"pending_change,omitempty"`
	// Output only. Changes made on the item that are not pending anymore which
	// might be because they already took effect, were reverted by the customer,
	// or were rejected by the partner. No more operations are allowed on these
	// changes.
	ChangeHistory []*LineItemChange `protobuf:"bytes,4,rep,name=change_history,json=changeHistory,proto3" json:"change_history,omitempty"`
	// contains filtered or unexported fields
}

A single item within an order.

func (*LineItem) Descriptor deprecated

func (*LineItem) Descriptor() ([]byte, []int)

Deprecated: Use LineItem.ProtoReflect.Descriptor instead.

func (*LineItem) GetChangeHistory

func (x *LineItem) GetChangeHistory() []*LineItemChange

func (*LineItem) GetLineItemId

func (x *LineItem) GetLineItemId() string

func (*LineItem) GetLineItemInfo

func (x *LineItem) GetLineItemInfo() *LineItemInfo

func (*LineItem) GetPendingChange

func (x *LineItem) GetPendingChange() *LineItemChange

func (*LineItem) ProtoMessage

func (*LineItem) ProtoMessage()

func (*LineItem) ProtoReflect

func (x *LineItem) ProtoReflect() protoreflect.Message

func (*LineItem) Reset

func (x *LineItem) Reset()

func (*LineItem) String

func (x *LineItem) String() string

type LineItemChange

type LineItemChange struct {

	// Output only. Change ID.
	// All changes made within one order update operation have the same change_id.
	ChangeId string `protobuf:"bytes,1,opt,name=change_id,json=changeId,proto3" json:"change_id,omitempty"`
	// Required. Type of the change to make.
	ChangeType LineItemChangeType `` /* 162-byte string literal not displayed */
	// Output only. Line item info before the change.
	OldLineItemInfo *LineItemInfo `protobuf:"bytes,3,opt,name=old_line_item_info,json=oldLineItemInfo,proto3" json:"old_line_item_info,omitempty"`
	// Line item info after the change.
	NewLineItemInfo *LineItemInfo `protobuf:"bytes,4,opt,name=new_line_item_info,json=newLineItemInfo,proto3" json:"new_line_item_info,omitempty"`
	// Output only. State of the change.
	ChangeState LineItemChangeState `` /* 166-byte string literal not displayed */
	// Output only. Provider-supplied message explaining the LineItemChange's
	// state. Mainly used to communicate progress and ETA for provisioning in the
	// case of `PENDING_APPROVAL`, and to explain why the change request was
	// denied or canceled in the case of `REJECTED` and `CANCELED` states.
	StateReason string `protobuf:"bytes,6,opt,name=state_reason,json=stateReason,proto3" json:"state_reason,omitempty"`
	// Output only. Predefined enum types for why this line item change is in
	// current state. For example, a line item change's state could be
	// `LINE_ITEM_CHANGE_STATE_COMPLETED` because of end-of-term expiration,
	// immediate cancellation initiated by the user, or system-initiated
	// cancellation.
	ChangeStateReasonType LineItemChangeStateReasonType `` /* 211-byte string literal not displayed */
	// Output only. A time at which the change became or will become (in case of
	// pending change) effective.
	ChangeEffectiveTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=change_effective_time,json=changeEffectiveTime,proto3" json:"change_effective_time,omitempty"`
	// Output only. The time when change was initiated.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time when change was updated, e.g. approved/rejected by
	// partners or cancelled by the user.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

A change made on a line item.

func (*LineItemChange) Descriptor deprecated

func (*LineItemChange) Descriptor() ([]byte, []int)

Deprecated: Use LineItemChange.ProtoReflect.Descriptor instead.

func (*LineItemChange) GetChangeEffectiveTime

func (x *LineItemChange) GetChangeEffectiveTime() *timestamppb.Timestamp

func (*LineItemChange) GetChangeId

func (x *LineItemChange) GetChangeId() string

func (*LineItemChange) GetChangeState

func (x *LineItemChange) GetChangeState() LineItemChangeState

func (*LineItemChange) GetChangeStateReasonType

func (x *LineItemChange) GetChangeStateReasonType() LineItemChangeStateReasonType

func (*LineItemChange) GetChangeType

func (x *LineItemChange) GetChangeType() LineItemChangeType

func (*LineItemChange) GetCreateTime

func (x *LineItemChange) GetCreateTime() *timestamppb.Timestamp

func (*LineItemChange) GetNewLineItemInfo

func (x *LineItemChange) GetNewLineItemInfo() *LineItemInfo

func (*LineItemChange) GetOldLineItemInfo

func (x *LineItemChange) GetOldLineItemInfo() *LineItemInfo

func (*LineItemChange) GetStateReason

func (x *LineItemChange) GetStateReason() string

func (*LineItemChange) GetUpdateTime

func (x *LineItemChange) GetUpdateTime() *timestamppb.Timestamp

func (*LineItemChange) ProtoMessage

func (*LineItemChange) ProtoMessage()

func (*LineItemChange) ProtoReflect

func (x *LineItemChange) ProtoReflect() protoreflect.Message

func (*LineItemChange) Reset

func (x *LineItemChange) Reset()

func (*LineItemChange) String

func (x *LineItemChange) String() string

type LineItemChangeState

type LineItemChangeState int32

State of a change.

const (
	// Sentinel value. Do not use.
	LineItemChangeState_LINE_ITEM_CHANGE_STATE_UNSPECIFIED LineItemChangeState = 0
	// Change is in this state when a change is initiated and waiting for partner
	// approval. This state is only applicable for pending change.
	LineItemChangeState_LINE_ITEM_CHANGE_STATE_PENDING_APPROVAL LineItemChangeState = 1
	// Change is in this state after it's approved by the partner or auto-approved
	// but before it takes effect. The change can be overwritten or cancelled
	// depending on the new line item info property (pending Private Offer change
	// cannot be cancelled and can only be overwritten by another Private Offer).
	// This state is only applicable for pending change.
	LineItemChangeState_LINE_ITEM_CHANGE_STATE_APPROVED LineItemChangeState = 2
	// Change is in this state after it's been activated. This state is only
	// applicable for change in history.
	LineItemChangeState_LINE_ITEM_CHANGE_STATE_COMPLETED LineItemChangeState = 3
	// Change is in this state if it was rejected by the partner. This state is
	// only applicable for change in history.
	LineItemChangeState_LINE_ITEM_CHANGE_STATE_REJECTED LineItemChangeState = 4
	// Change is in this state if it was abandoned by the user. This state is only
	// applicable for change in history.
	LineItemChangeState_LINE_ITEM_CHANGE_STATE_ABANDONED LineItemChangeState = 5
	// Change is in this state if it's currently being provisioned downstream. The
	// change can't be overwritten or cancelled when it's in this state. This
	// state is only applicable for pending change.
	LineItemChangeState_LINE_ITEM_CHANGE_STATE_ACTIVATING LineItemChangeState = 6
)

func (LineItemChangeState) Descriptor

func (LineItemChangeState) Enum

func (LineItemChangeState) EnumDescriptor deprecated

func (LineItemChangeState) EnumDescriptor() ([]byte, []int)

Deprecated: Use LineItemChangeState.Descriptor instead.

func (LineItemChangeState) Number

func (LineItemChangeState) String

func (x LineItemChangeState) String() string

func (LineItemChangeState) Type

type LineItemChangeStateReasonType

type LineItemChangeStateReasonType int32

Predefined types for line item change state reason.

const (
	// Default value, indicating there's no predefined type for change state
	// reason.
	LineItemChangeStateReasonType_LINE_ITEM_CHANGE_STATE_REASON_TYPE_UNSPECIFIED LineItemChangeStateReasonType = 0
	// Change is in current state due to term expiration.
	LineItemChangeStateReasonType_LINE_ITEM_CHANGE_STATE_REASON_TYPE_EXPIRED LineItemChangeStateReasonType = 1
	// Change is in current state due to user-initiated cancellation.
	LineItemChangeStateReasonType_LINE_ITEM_CHANGE_STATE_REASON_TYPE_USER_CANCELLED LineItemChangeStateReasonType = 2
	// Change is in current state due to system-initiated cancellation.
	LineItemChangeStateReasonType_LINE_ITEM_CHANGE_STATE_REASON_TYPE_SYSTEM_CANCELLED LineItemChangeStateReasonType = 3
)

func (LineItemChangeStateReasonType) Descriptor

func (LineItemChangeStateReasonType) Enum

func (LineItemChangeStateReasonType) EnumDescriptor deprecated

func (LineItemChangeStateReasonType) EnumDescriptor() ([]byte, []int)

Deprecated: Use LineItemChangeStateReasonType.Descriptor instead.

func (LineItemChangeStateReasonType) Number

func (LineItemChangeStateReasonType) String

func (LineItemChangeStateReasonType) Type

type LineItemChangeType

type LineItemChangeType int32

Type of a line item change.

const (
	// Sentinel value. Do not use.
	LineItemChangeType_LINE_ITEM_CHANGE_TYPE_UNSPECIFIED LineItemChangeType = 0
	// The change is to create a new line item.
	LineItemChangeType_LINE_ITEM_CHANGE_TYPE_CREATE LineItemChangeType = 1
	// The change is to update an existing line item.
	LineItemChangeType_LINE_ITEM_CHANGE_TYPE_UPDATE LineItemChangeType = 2
	// The change is to cancel an existing line item.
	LineItemChangeType_LINE_ITEM_CHANGE_TYPE_CANCEL LineItemChangeType = 3
	// The change is to revert a cancellation.
	LineItemChangeType_LINE_ITEM_CHANGE_TYPE_REVERT_CANCELLATION LineItemChangeType = 4
)

func (LineItemChangeType) Descriptor

func (LineItemChangeType) Enum

func (LineItemChangeType) EnumDescriptor deprecated

func (LineItemChangeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use LineItemChangeType.Descriptor instead.

func (LineItemChangeType) Number

func (LineItemChangeType) String

func (x LineItemChangeType) String() string

func (LineItemChangeType) Type

type LineItemInfo

type LineItemInfo struct {

	// Optional. The name of the offer can have either of these formats:
	// 'billingAccounts/{billing_account}/offers/{offer}',
	// or 'services/{service}/standardOffers/{offer}'.
	Offer string `protobuf:"bytes,13,opt,name=offer,proto3" json:"offer,omitempty"`
	// Optional. User-provided parameters.
	Parameters []*Parameter `protobuf:"bytes,9,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// Output only. Information about the subscription created, if applicable.
	Subscription *Subscription `protobuf:"bytes,10,opt,name=subscription,proto3" json:"subscription,omitempty"`
	// contains filtered or unexported fields
}

Line item information.

func (*LineItemInfo) Descriptor deprecated

func (*LineItemInfo) Descriptor() ([]byte, []int)

Deprecated: Use LineItemInfo.ProtoReflect.Descriptor instead.

func (*LineItemInfo) GetOffer

func (x *LineItemInfo) GetOffer() string

func (*LineItemInfo) GetParameters

func (x *LineItemInfo) GetParameters() []*Parameter

func (*LineItemInfo) GetSubscription

func (x *LineItemInfo) GetSubscription() *Subscription

func (*LineItemInfo) ProtoMessage

func (*LineItemInfo) ProtoMessage()

func (*LineItemInfo) ProtoReflect

func (x *LineItemInfo) ProtoReflect() protoreflect.Message

func (*LineItemInfo) Reset

func (x *LineItemInfo) Reset()

func (*LineItemInfo) String

func (x *LineItemInfo) String() string

type ListOrdersRequest

type ListOrdersRequest struct {

	// Required. The parent resource to query for orders.
	// This field has the form `billingAccounts/{billing-account-id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of entries requested.
	// The default page size is 25 and the maximum page size is 200.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The token for fetching the next page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter that you can use to limit the list request.
	//
	// A query string that can match a selected set of attributes
	// with string values. For example, `display_name=abc`.
	// Supported query attributes are
	//
	// * `display_name`
	//
	// If the query contains special characters other than letters,
	// underscore, or digits, the phrase must be quoted with double quotes. For
	// example, `display_name="foo:bar"`, where the display name needs to be
	// quoted because it contains special character colon.
	//
	// Queries can be combined with `OR`, and `NOT` to form more complex queries.
	// You can also group them to force a desired evaluation order.
	// For example, `display_name=abc OR display_name=def`.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ConsumerProcurementService.ListOrders][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService.ListOrders].

func (*ListOrdersRequest) Descriptor deprecated

func (*ListOrdersRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListOrdersRequest.ProtoReflect.Descriptor instead.

func (*ListOrdersRequest) GetFilter

func (x *ListOrdersRequest) GetFilter() string

func (*ListOrdersRequest) GetPageSize

func (x *ListOrdersRequest) GetPageSize() int32

func (*ListOrdersRequest) GetPageToken

func (x *ListOrdersRequest) GetPageToken() string

func (*ListOrdersRequest) GetParent

func (x *ListOrdersRequest) GetParent() string

func (*ListOrdersRequest) ProtoMessage

func (*ListOrdersRequest) ProtoMessage()

func (*ListOrdersRequest) ProtoReflect

func (x *ListOrdersRequest) ProtoReflect() protoreflect.Message

func (*ListOrdersRequest) Reset

func (x *ListOrdersRequest) Reset()

func (*ListOrdersRequest) String

func (x *ListOrdersRequest) String() string

type ListOrdersResponse

type ListOrdersResponse struct {

	// The list of orders in this response.
	Orders []*Order `protobuf:"bytes,1,rep,name=orders,proto3" json:"orders,omitempty"`
	// The token for fetching the next page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ConsumerProcurementService.ListOrders][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService.ListOrders].

func (*ListOrdersResponse) Descriptor deprecated

func (*ListOrdersResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListOrdersResponse.ProtoReflect.Descriptor instead.

func (*ListOrdersResponse) GetNextPageToken

func (x *ListOrdersResponse) GetNextPageToken() string

func (*ListOrdersResponse) GetOrders

func (x *ListOrdersResponse) GetOrders() []*Order

func (*ListOrdersResponse) ProtoMessage

func (*ListOrdersResponse) ProtoMessage()

func (*ListOrdersResponse) ProtoReflect

func (x *ListOrdersResponse) ProtoReflect() protoreflect.Message

func (*ListOrdersResponse) Reset

func (x *ListOrdersResponse) Reset()

func (*ListOrdersResponse) String

func (x *ListOrdersResponse) String() string

type ModifyOrderMetadata added in v1.2.0

type ModifyOrderMetadata struct {
	// contains filtered or unexported fields
}

Message stored in the metadata field of the Operation returned by [ConsumerProcurementService.ModifyOrder][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService.ModifyOrder].

func (*ModifyOrderMetadata) Descriptor deprecated added in v1.2.0

func (*ModifyOrderMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ModifyOrderMetadata.ProtoReflect.Descriptor instead.

func (*ModifyOrderMetadata) ProtoMessage added in v1.2.0

func (*ModifyOrderMetadata) ProtoMessage()

func (*ModifyOrderMetadata) ProtoReflect added in v1.2.0

func (x *ModifyOrderMetadata) ProtoReflect() protoreflect.Message

func (*ModifyOrderMetadata) Reset added in v1.2.0

func (x *ModifyOrderMetadata) Reset()

func (*ModifyOrderMetadata) String added in v1.2.0

func (x *ModifyOrderMetadata) String() string

type ModifyOrderRequest added in v1.2.0

type ModifyOrderRequest struct {

	// Required. Name of the order to update.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Modifications for an existing Order created by an Offer.
	// Required when Offer based Order is being modified, except for when going
	// from an offer to a public plan.
	Modifications []*ModifyOrderRequest_Modification `protobuf:"bytes,6,rep,name=modifications,proto3" json:"modifications,omitempty"`
	// Optional. Updated display name of the order, leave as empty if you do not
	// want to update current display name.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. The weak etag, which can be optionally populated, of the order
	// that this modify request is based on. Validation checking will only happen
	// if the invoker supplies this field.
	Etag string `protobuf:"bytes,4,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ConsumerProcurementService.ModifyOrder][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService.ModifyOrder].

func (*ModifyOrderRequest) Descriptor deprecated added in v1.2.0

func (*ModifyOrderRequest) Descriptor() ([]byte, []int)

Deprecated: Use ModifyOrderRequest.ProtoReflect.Descriptor instead.

func (*ModifyOrderRequest) GetDisplayName added in v1.2.0

func (x *ModifyOrderRequest) GetDisplayName() string

func (*ModifyOrderRequest) GetEtag added in v1.2.0

func (x *ModifyOrderRequest) GetEtag() string

func (*ModifyOrderRequest) GetModifications added in v1.2.0

func (x *ModifyOrderRequest) GetModifications() []*ModifyOrderRequest_Modification

func (*ModifyOrderRequest) GetName added in v1.2.0

func (x *ModifyOrderRequest) GetName() string

func (*ModifyOrderRequest) ProtoMessage added in v1.2.0

func (*ModifyOrderRequest) ProtoMessage()

func (*ModifyOrderRequest) ProtoReflect added in v1.2.0

func (x *ModifyOrderRequest) ProtoReflect() protoreflect.Message

func (*ModifyOrderRequest) Reset added in v1.2.0

func (x *ModifyOrderRequest) Reset()

func (*ModifyOrderRequest) String added in v1.2.0

func (x *ModifyOrderRequest) String() string

type ModifyOrderRequest_Modification added in v1.2.0

type ModifyOrderRequest_Modification struct {

	// Required. ID of the existing line item to make change to.
	// Required when change type is
	// [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or
	// [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL].
	LineItemId string `protobuf:"bytes,1,opt,name=line_item_id,json=lineItemId,proto3" json:"line_item_id,omitempty"`
	// Required. Type of change to make.
	ChangeType LineItemChangeType `` /* 162-byte string literal not displayed */
	// Optional. The line item to update to.
	// Required when change_type is
	// [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or
	// [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE].
	NewLineItemInfo *LineItemInfo `protobuf:"bytes,3,opt,name=new_line_item_info,json=newLineItemInfo,proto3" json:"new_line_item_info,omitempty"`
	// Optional. Auto renewal behavior of the subscription for the update.
	// Applied when change_type is
	// [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default
	// config when this field is not specified.
	AutoRenewalBehavior AutoRenewalBehavior `` /* 192-byte string literal not displayed */
	// contains filtered or unexported fields
}

Modifications to make on the order.

func (*ModifyOrderRequest_Modification) Descriptor deprecated added in v1.2.0

func (*ModifyOrderRequest_Modification) Descriptor() ([]byte, []int)

Deprecated: Use ModifyOrderRequest_Modification.ProtoReflect.Descriptor instead.

func (*ModifyOrderRequest_Modification) GetAutoRenewalBehavior added in v1.2.0

func (x *ModifyOrderRequest_Modification) GetAutoRenewalBehavior() AutoRenewalBehavior

func (*ModifyOrderRequest_Modification) GetChangeType added in v1.2.0

func (*ModifyOrderRequest_Modification) GetLineItemId added in v1.2.0

func (x *ModifyOrderRequest_Modification) GetLineItemId() string

func (*ModifyOrderRequest_Modification) GetNewLineItemInfo added in v1.2.0

func (x *ModifyOrderRequest_Modification) GetNewLineItemInfo() *LineItemInfo

func (*ModifyOrderRequest_Modification) ProtoMessage added in v1.2.0

func (*ModifyOrderRequest_Modification) ProtoMessage()

func (*ModifyOrderRequest_Modification) ProtoReflect added in v1.2.0

func (*ModifyOrderRequest_Modification) Reset added in v1.2.0

func (*ModifyOrderRequest_Modification) String added in v1.2.0

type Order

type Order struct {

	// Output only. The resource name of the order.
	// Has the form
	// `billingAccounts/{billing_account}/orders/{order}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The user-specified name of the order.
	DisplayName string `protobuf:"bytes,10,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The items being purchased.
	LineItems []*LineItem `protobuf:"bytes,6,rep,name=line_items,json=lineItems,proto3" json:"line_items,omitempty"`
	// Output only. Line items that were cancelled.
	CancelledLineItems []*LineItem `protobuf:"bytes,7,rep,name=cancelled_line_items,json=cancelledLineItems,proto3" json:"cancelled_line_items,omitempty"`
	// Output only. The creation timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The last update timestamp.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The weak etag of the order.
	Etag string `protobuf:"bytes,11,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*Order) Descriptor deprecated

func (*Order) Descriptor() ([]byte, []int)

Deprecated: Use Order.ProtoReflect.Descriptor instead.

func (*Order) GetCancelledLineItems

func (x *Order) GetCancelledLineItems() []*LineItem

func (*Order) GetCreateTime

func (x *Order) GetCreateTime() *timestamppb.Timestamp

func (*Order) GetDisplayName

func (x *Order) GetDisplayName() string

func (*Order) GetEtag

func (x *Order) GetEtag() string

func (*Order) GetLineItems

func (x *Order) GetLineItems() []*LineItem

func (*Order) GetName

func (x *Order) GetName() string

func (*Order) GetUpdateTime

func (x *Order) GetUpdateTime() *timestamppb.Timestamp

func (*Order) ProtoMessage

func (*Order) ProtoMessage()

func (*Order) ProtoReflect

func (x *Order) ProtoReflect() protoreflect.Message

func (*Order) Reset

func (x *Order) Reset()

func (*Order) String

func (x *Order) String() string

type Parameter

type Parameter struct {

	// Name of the parameter.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Value of parameter.
	Value *Parameter_Value `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

User-provided Parameters.

func (*Parameter) Descriptor deprecated

func (*Parameter) Descriptor() ([]byte, []int)

Deprecated: Use Parameter.ProtoReflect.Descriptor instead.

func (*Parameter) GetName

func (x *Parameter) GetName() string

func (*Parameter) GetValue

func (x *Parameter) GetValue() *Parameter_Value

func (*Parameter) ProtoMessage

func (*Parameter) ProtoMessage()

func (*Parameter) ProtoReflect

func (x *Parameter) ProtoReflect() protoreflect.Message

func (*Parameter) Reset

func (x *Parameter) Reset()

func (*Parameter) String

func (x *Parameter) String() string

type Parameter_Value

type Parameter_Value struct {

	// The kind of value.
	//
	// Types that are assignable to Kind:
	//
	//	*Parameter_Value_Int64Value
	//	*Parameter_Value_StringValue
	//	*Parameter_Value_DoubleValue
	Kind isParameter_Value_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

func (*Parameter_Value) Descriptor deprecated

func (*Parameter_Value) Descriptor() ([]byte, []int)

Deprecated: Use Parameter_Value.ProtoReflect.Descriptor instead.

func (*Parameter_Value) GetDoubleValue

func (x *Parameter_Value) GetDoubleValue() float64

func (*Parameter_Value) GetInt64Value

func (x *Parameter_Value) GetInt64Value() int64

func (*Parameter_Value) GetKind

func (m *Parameter_Value) GetKind() isParameter_Value_Kind

func (*Parameter_Value) GetStringValue

func (x *Parameter_Value) GetStringValue() string

func (*Parameter_Value) ProtoMessage

func (*Parameter_Value) ProtoMessage()

func (*Parameter_Value) ProtoReflect

func (x *Parameter_Value) ProtoReflect() protoreflect.Message

func (*Parameter_Value) Reset

func (x *Parameter_Value) Reset()

func (*Parameter_Value) String

func (x *Parameter_Value) String() string

type Parameter_Value_DoubleValue

type Parameter_Value_DoubleValue struct {
	// Represents a double value.
	DoubleValue float64 `protobuf:"fixed64,5,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type Parameter_Value_Int64Value

type Parameter_Value_Int64Value struct {
	// Represents an int64 value.
	Int64Value int64 `protobuf:"varint,3,opt,name=int64_value,json=int64Value,proto3,oneof"`
}

type Parameter_Value_StringValue

type Parameter_Value_StringValue struct {
	// Represents a string value.
	StringValue string `protobuf:"bytes,4,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type PlaceOrderMetadata

type PlaceOrderMetadata struct {
	// contains filtered or unexported fields
}

Message stored in the metadata field of the Operation returned by [ConsumerProcurementService.PlaceOrder][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService.PlaceOrder].

func (*PlaceOrderMetadata) Descriptor deprecated

func (*PlaceOrderMetadata) Descriptor() ([]byte, []int)

Deprecated: Use PlaceOrderMetadata.ProtoReflect.Descriptor instead.

func (*PlaceOrderMetadata) ProtoMessage

func (*PlaceOrderMetadata) ProtoMessage()

func (*PlaceOrderMetadata) ProtoReflect

func (x *PlaceOrderMetadata) ProtoReflect() protoreflect.Message

func (*PlaceOrderMetadata) Reset

func (x *PlaceOrderMetadata) Reset()

func (*PlaceOrderMetadata) String

func (x *PlaceOrderMetadata) String() string

type PlaceOrderRequest

type PlaceOrderRequest struct {

	// Required. The resource name of the parent resource.
	// This field has the form  `billingAccounts/{billing-account-id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The user-specified name of the order being placed.
	DisplayName string `protobuf:"bytes,6,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. Places order for offer. Required when an offer-based order is
	// being placed.
	LineItemInfo []*LineItemInfo `protobuf:"bytes,10,rep,name=line_item_info,json=lineItemInfo,proto3" json:"line_item_info,omitempty"`
	// Optional. A unique identifier for this request.
	// The server will ignore subsequent requests that provide a duplicate request
	// ID for at least 24 hours after the first request.
	//
	// The request ID must be a valid
	// [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format).
	RequestId string `protobuf:"bytes,7,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ConsumerProcurementService.PlaceOrder][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService.PlaceOrder].

func (*PlaceOrderRequest) Descriptor deprecated

func (*PlaceOrderRequest) Descriptor() ([]byte, []int)

Deprecated: Use PlaceOrderRequest.ProtoReflect.Descriptor instead.

func (*PlaceOrderRequest) GetDisplayName

func (x *PlaceOrderRequest) GetDisplayName() string

func (*PlaceOrderRequest) GetLineItemInfo

func (x *PlaceOrderRequest) GetLineItemInfo() []*LineItemInfo

func (*PlaceOrderRequest) GetParent

func (x *PlaceOrderRequest) GetParent() string

func (*PlaceOrderRequest) GetRequestId

func (x *PlaceOrderRequest) GetRequestId() string

func (*PlaceOrderRequest) ProtoMessage

func (*PlaceOrderRequest) ProtoMessage()

func (*PlaceOrderRequest) ProtoReflect

func (x *PlaceOrderRequest) ProtoReflect() protoreflect.Message

func (*PlaceOrderRequest) Reset

func (x *PlaceOrderRequest) Reset()

func (*PlaceOrderRequest) String

func (x *PlaceOrderRequest) String() string

type Subscription

type Subscription struct {

	// The timestamp when the subscription begins, if applicable.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The timestamp when the subscription ends, if applicable.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Whether auto renewal is enabled by user choice on current subscription.
	// This field indicates order/subscription status after pending plan change is
	// cancelled or rejected.
	AutoRenewalEnabled bool `protobuf:"varint,2,opt,name=auto_renewal_enabled,json=autoRenewalEnabled,proto3" json:"auto_renewal_enabled,omitempty"`
	// contains filtered or unexported fields
}

Subscription information.

func (*Subscription) Descriptor deprecated

func (*Subscription) Descriptor() ([]byte, []int)

Deprecated: Use Subscription.ProtoReflect.Descriptor instead.

func (*Subscription) GetAutoRenewalEnabled

func (x *Subscription) GetAutoRenewalEnabled() bool

func (*Subscription) GetEndTime

func (x *Subscription) GetEndTime() *timestamppb.Timestamp

func (*Subscription) GetStartTime

func (x *Subscription) GetStartTime() *timestamppb.Timestamp

func (*Subscription) ProtoMessage

func (*Subscription) ProtoMessage()

func (*Subscription) ProtoReflect

func (x *Subscription) ProtoReflect() protoreflect.Message

func (*Subscription) Reset

func (x *Subscription) Reset()

func (*Subscription) String

func (x *Subscription) String() string

type UnassignRequest added in v1.2.0

type UnassignRequest struct {

	// Required. License pool name.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Username.
	// Format: `name@domain.com`.
	Usernames []string `protobuf:"bytes,2,rep,name=usernames,proto3" json:"usernames,omitempty"`
	// contains filtered or unexported fields
}

Request message for [LicenseManagementService.Unassign][google.cloud.commerce.consumer.procurement.v1.LicenseManagementService.Unassign].

func (*UnassignRequest) Descriptor deprecated added in v1.2.0

func (*UnassignRequest) Descriptor() ([]byte, []int)

Deprecated: Use UnassignRequest.ProtoReflect.Descriptor instead.

func (*UnassignRequest) GetParent added in v1.2.0

func (x *UnassignRequest) GetParent() string

func (*UnassignRequest) GetUsernames added in v1.2.0

func (x *UnassignRequest) GetUsernames() []string

func (*UnassignRequest) ProtoMessage added in v1.2.0

func (*UnassignRequest) ProtoMessage()

func (*UnassignRequest) ProtoReflect added in v1.2.0

func (x *UnassignRequest) ProtoReflect() protoreflect.Message

func (*UnassignRequest) Reset added in v1.2.0

func (x *UnassignRequest) Reset()

func (*UnassignRequest) String added in v1.2.0

func (x *UnassignRequest) String() string

type UnassignResponse added in v1.2.0

type UnassignResponse struct {
	// contains filtered or unexported fields
}

Response message for [LicenseManagementService.Unassign][google.cloud.commerce.consumer.procurement.v1.LicenseManagementService.Unassign].

func (*UnassignResponse) Descriptor deprecated added in v1.2.0

func (*UnassignResponse) Descriptor() ([]byte, []int)

Deprecated: Use UnassignResponse.ProtoReflect.Descriptor instead.

func (*UnassignResponse) ProtoMessage added in v1.2.0

func (*UnassignResponse) ProtoMessage()

func (*UnassignResponse) ProtoReflect added in v1.2.0

func (x *UnassignResponse) ProtoReflect() protoreflect.Message

func (*UnassignResponse) Reset added in v1.2.0

func (x *UnassignResponse) Reset()

func (*UnassignResponse) String added in v1.2.0

func (x *UnassignResponse) String() string

type UnimplementedConsumerProcurementServiceServer

type UnimplementedConsumerProcurementServiceServer struct {
}

UnimplementedConsumerProcurementServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedConsumerProcurementServiceServer) CancelOrder added in v1.2.0

func (*UnimplementedConsumerProcurementServiceServer) GetOrder

func (*UnimplementedConsumerProcurementServiceServer) ListOrders

func (*UnimplementedConsumerProcurementServiceServer) ModifyOrder added in v1.2.0

func (*UnimplementedConsumerProcurementServiceServer) PlaceOrder

type UnimplementedLicenseManagementServiceServer added in v1.2.0

type UnimplementedLicenseManagementServiceServer struct {
}

UnimplementedLicenseManagementServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedLicenseManagementServiceServer) Assign added in v1.2.0

func (*UnimplementedLicenseManagementServiceServer) EnumerateLicensedUsers added in v1.2.0

func (*UnimplementedLicenseManagementServiceServer) GetLicensePool added in v1.2.0

func (*UnimplementedLicenseManagementServiceServer) Unassign added in v1.2.0

func (*UnimplementedLicenseManagementServiceServer) UpdateLicensePool added in v1.2.0

type UpdateLicensePoolRequest added in v1.2.0

type UpdateLicensePoolRequest struct {

	// Required. The license pool to update.
	//
	// The license pool's name field is used to identify the license pool to
	// update. Format:
	// `billingAccounts/{billing_account}/orders/{order}/licensePool`.
	LicensePool *LicensePool `protobuf:"bytes,1,opt,name=license_pool,json=licensePool,proto3" json:"license_pool,omitempty"`
	// Required. The list of fields to update.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for updating a license pool.

func (*UpdateLicensePoolRequest) Descriptor deprecated added in v1.2.0

func (*UpdateLicensePoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateLicensePoolRequest.ProtoReflect.Descriptor instead.

func (*UpdateLicensePoolRequest) GetLicensePool added in v1.2.0

func (x *UpdateLicensePoolRequest) GetLicensePool() *LicensePool

func (*UpdateLicensePoolRequest) GetUpdateMask added in v1.2.0

func (x *UpdateLicensePoolRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateLicensePoolRequest) ProtoMessage added in v1.2.0

func (*UpdateLicensePoolRequest) ProtoMessage()

func (*UpdateLicensePoolRequest) ProtoReflect added in v1.2.0

func (x *UpdateLicensePoolRequest) ProtoReflect() protoreflect.Message

func (*UpdateLicensePoolRequest) Reset added in v1.2.0

func (x *UpdateLicensePoolRequest) Reset()

func (*UpdateLicensePoolRequest) String added in v1.2.0

func (x *UpdateLicensePoolRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL