Documentation

Overview

Package cloudcommerceprocurement provides access to the Cloud Commerce Partner Procurement API.

For product documentation, see: https://cloud.google.com/marketplace/docs/partners/

Creating a client

Usage example:

import "google.golang.org/api/cloudcommerceprocurement/v1"
...
ctx := context.Background()
cloudcommerceprocurementService, err := cloudcommerceprocurement.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

cloudcommerceprocurementService, err := cloudcommerceprocurement.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
cloudcommerceprocurementService, err := cloudcommerceprocurement.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {
	// Approvals: Output only. The approvals for this account. These
	// approvals are used to track actions that are permitted or have been
	// completed by a customer within the context of the provider. This
	// might include a sign up flow or a provisioning step, for example,
	// that the provider can admit to having happened.
	Approvals []*Approval `json:"approvals,omitempty"`

	// CreateTime: Output only. The creation timestamp.
	CreateTime string `json:"createTime,omitempty"`

	// InputProperties: Output only. The custom properties that were
	// collected from the user to create this account.
	InputProperties googleapi.RawMessage `json:"inputProperties,omitempty"`

	// Name: Output only. The resource name of the account. Account names
	// have the form `accounts/{account_id}`.
	Name string `json:"name,omitempty"`

	// Provider: Output only. The identifier of the service provider that
	// this account was created against. Each service provider is assigned a
	// unique provider value when they onboard with Cloud Commerce platform.
	Provider string `json:"provider,omitempty"`

	// State: Output only. The state of the account. This is used to decide
	// whether the customer is in good standing with the provider and is
	// able to make purchases. An account might not be able to make a
	// purchase if the billing account is suspended, for example.
	//
	// Possible values:
	//   "ACCOUNT_STATE_UNSPECIFIED" - Sentinel value, do not use.
	//   "ACCOUNT_ACTIVATION_REQUESTED" - The customer has requested the
	// creation of the account resource, and the provider notification
	// message is dispatched. This state has been deprecated, as accounts
	// now immediately transition to AccountState.ACCOUNT_ACTIVE.
	//   "ACCOUNT_ACTIVE" - The account is active and ready for use. The
	// next possible states are: - Account getting deleted: After the user
	// invokes delete from another API.
	State string `json:"state,omitempty"`

	// UpdateTime: Output only. The last update timestamp.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Approvals") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Approvals") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Account: Represents an account that was established by the customer on the service provider's system.

func (*Account) MarshalJSON

func (s *Account) MarshalJSON() ([]byte, error)

type Approval

type Approval struct {
	// Name: Output only. The name of the approval.
	Name string `json:"name,omitempty"`

	// Reason: Output only. An explanation for the state of the approval.
	Reason string `json:"reason,omitempty"`

	// State: Output only. The state of the approval.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Sentinel value; do not use.
	//   "PENDING" - The approval is pending response from the provider. The
	// approval state can transition to Account.Approval.State.APPROVED or
	// Account.Approval.State.REJECTED.
	//   "APPROVED" - The approval has been granted by the provider.
	//   "REJECTED" - The approval has been rejected by the provider. A
	// provider may choose to approve a previously rejected approval, so is
	// it possible to transition to Account.Approval.State.APPROVED.
	State string `json:"state,omitempty"`

	// UpdateTime: Optional. The last update timestamp of the approval.
	UpdateTime string `json:"updateTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Approval: An approval for some action on an account.

func (*Approval) MarshalJSON

func (s *Approval) MarshalJSON() ([]byte, error)

type ApproveAccountRequest

type ApproveAccountRequest struct {
	// ApprovalName: The name of the approval being approved. If absent and
	// there is only one approval possible, that approval will be granted.
	// If absent and there are many approvals possible, the request will
	// fail with a 400 Bad Request. Optional.
	ApprovalName string `json:"approvalName,omitempty"`

	// Properties: Set of properties that should be associated with the
	// account. Optional.
	Properties map[string]string `json:"properties,omitempty"`

	// Reason: Free form text string explaining the approval reason.
	// Optional. Max allowed length: 256 bytes. Longer strings will be
	// truncated.
	Reason string `json:"reason,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ApprovalName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ApprovalName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ApproveAccountRequest: Request message for PartnerProcurementService.ApproveAccount.

func (*ApproveAccountRequest) MarshalJSON

func (s *ApproveAccountRequest) MarshalJSON() ([]byte, error)

type ApproveEntitlementPlanChangeRequest

type ApproveEntitlementPlanChangeRequest struct {
	// PendingPlanName: Name of the pending plan that is being approved.
	// Required.
	PendingPlanName string `json:"pendingPlanName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PendingPlanName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PendingPlanName") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ApproveEntitlementPlanChangeRequest: Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[].

func (*ApproveEntitlementPlanChangeRequest) MarshalJSON

func (s *ApproveEntitlementPlanChangeRequest) MarshalJSON() ([]byte, error)

type ApproveEntitlementRequest

type ApproveEntitlementRequest struct {
	// Properties: Set of properties that should be associated with the
	// entitlement. Optional.
	Properties map[string]string `json:"properties,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Properties") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Properties") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ApproveEntitlementRequest: Request message for [PartnerProcurementService.ApproveEntitlement[].

func (*ApproveEntitlementRequest) MarshalJSON

func (s *ApproveEntitlementRequest) MarshalJSON() ([]byte, error)

type Consumer

type Consumer struct {
	// Project: A project name with format `projects/`.
	Project string `json:"project,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Project") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Project") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Consumer: A resource using (consuming) this entitlement.

func (*Consumer) MarshalJSON

func (s *Consumer) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

type Entitlement

type Entitlement struct {
	// Account: Output only. The resource name of the account that this
	// entitlement is based on, if any.
	Account string `json:"account,omitempty"`

	// Consumers: Output only. The resources using this entitlement, if
	// applicable.
	Consumers []*Consumer `json:"consumers,omitempty"`

	// CreateTime: Output only. The creation timestamp.
	CreateTime string `json:"createTime,omitempty"`

	// InputProperties: Output only. The custom properties that were
	// collected from the user to create this entitlement.
	InputProperties googleapi.RawMessage `json:"inputProperties,omitempty"`

	// MessageToUser: Provider-supplied message that is displayed to the end
	// user. Currently this is used to communicate progress and ETA for
	// provisioning. This field can be updated only when a user is waiting
	// for an action from the provider, i.e. entitlement state is
	// EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or
	// EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field
	// is cleared automatically when the entitlement state changes.
	MessageToUser string `json:"messageToUser,omitempty"`

	// Name: Output only. The resource name of the entitlement. Entitlement
	// names have the form
	// `providers/{provider_id}/entitlements/{entitlement_id}`.
	Name string `json:"name,omitempty"`

	// NewPendingPlan: Output only. The identifier of the pending new plan.
	// Required if the product has plans and the entitlement has a pending
	// plan change.
	NewPendingPlan string `json:"newPendingPlan,omitempty"`

	// Plan: Output only. The identifier of the plan that was procured.
	// Required if the product has plans.
	Plan string `json:"plan,omitempty"`

	// Product: Output only. The identifier of the entity that was
	// purchased. This may actually represent a product or a quote.
	Product string `json:"product,omitempty"`

	// ProductExternalName: Output only. The identifier of the product that
	// was procured.
	ProductExternalName string `json:"productExternalName,omitempty"`

	// Provider: Output only. The identifier of the service provider that
	// this entitlement was created against. Each service provider is
	// assigned a unique provider value when they onboard with Cloud
	// Commerce platform.
	Provider string `json:"provider,omitempty"`

	// QuoteExternalName: Output only. The identifier of the quote that was
	// used to procure. Empty if the order is not purchased using a quote.
	QuoteExternalName string `json:"quoteExternalName,omitempty"`

	// State: Output only. The state of the entitlement.
	//
	// Possible values:
	//   "ENTITLEMENT_STATE_UNSPECIFIED" - Sentinel value. Do not use.
	//   "ENTITLEMENT_ACTIVATION_REQUESTED" - Indicates that the entitlement
	// is being created and the backend has sent a notification to the
	// provider for the activation approval. If the provider approves, then
	// the entitlement will transition to the
	// EntitlementState.ENTITLEMENT_ACTIVE state. Otherwise, the entitlement
	// will be removed. Plan changes are not allowed in this state. Instead
	// the entitlement is cancelled and re-created with a new plan name.
	//   "ENTITLEMENT_ACTIVE" - Indicates that the entitlement is active.
	// The procured item is now usable and any associated billing events
	// will start occurring. In this state, the customer can decide to
	// cancel the entitlement, which would change the state to
	// EntitlementState.ENTITLEMENT_PENDING_CANCELLATION, and then
	// EntitlementState.ENTITLEMENT_CANCELLED. The user can also request a
	// change of plan, which will transition the state to
	// EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE, and then back to
	// EntitlementState.ENTITLEMENT_ACTIVE.
	//   "ENTITLEMENT_PENDING_CANCELLATION" - Indicates that the entitlement
	// was cancelled by the customer. The entitlement typically stays in
	// this state if the entitlement/plan allows use of the underlying
	// resource until the end of the current billing cycle. Once the billing
	// cycle completes, the resource will transition to
	// EntitlementState.ENTITLEMENT_CANCELLED state. The resource cannot be
	// modified during this state.
	//   "ENTITLEMENT_CANCELLED" - Indicates that the entitlement was
	// cancelled. The entitlement can now be deleted.
	//   "ENTITLEMENT_PENDING_PLAN_CHANGE" - Indicates that the entitlement
	// is currently active, but there is a pending plan change that is
	// requested by the customer. The entitlement typically stays in this
	// state, if the entitlement/plan requires the completion of the current
	// billing cycle before the plan can be changed. Once the billing cycle
	// completes, the resource will transition to
	// EntitlementState.ENTITLEMENT_ACTIVE, with its plan changed.
	//   "ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL" - Indicates that the
	// entitlement is currently active, but there is a plan change request
	// pending provider approval. If the provider approves the plan change,
	// then the entitlement will transition either to
	// EntitlementState.ENTITLEMENT_ACTIVE or
	// EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE depending on whether
	// current plan requires that the billing cycle completes. If the
	// provider rejects the plan change, then the pending plan change
	// request is removed and the entitlement stays in
	// EntitlementState.ENTITLEMENT_ACTIVE state with the old plan.
	//   "ENTITLEMENT_SUSPENDED" - Indicates that the entitlement is
	// suspended either by Google or provider request. This can be triggered
	// for various external reasons (e.g. expiration of credit card on the
	// billing account, violation of terms-of-service of the provider etc.).
	// As such, any remediating action needs to be taken externally, before
	// the entitlement can be activated. This is not yet supported.
	State string `json:"state,omitempty"`

	// SubscriptionEndTime: Output only. End time for the subscription
	// corresponding to this entitlement.
	SubscriptionEndTime string `json:"subscriptionEndTime,omitempty"`

	// UpdateTime: Output only. The last update timestamp.
	UpdateTime string `json:"updateTime,omitempty"`

	// UsageReportingId: Output only. The consumerId to use when reporting
	// usage through the Service Control API. See the consumerId field at
	// [Reporting
	// Metrics](https://cloud.google.com/service-control/reporting-metrics)
	// for more details. This field is present only if the product has
	// usage-based billing configured.
	UsageReportingId string `json:"usageReportingId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Account") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Account") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Entitlement: Represents a procured product of a customer. Next Id: 17

func (*Entitlement) MarshalJSON

func (s *Entitlement) MarshalJSON() ([]byte, error)

type ListAccountsResponse

type ListAccountsResponse struct {
	// Accounts: The list of accounts in this response.
	Accounts []*Account `json:"accounts,omitempty"`

	// NextPageToken: The token for fetching the next page.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Accounts") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Accounts") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListAccountsResponse: Response message for [PartnerProcurementService.ListAccounts[].

func (*ListAccountsResponse) MarshalJSON

func (s *ListAccountsResponse) MarshalJSON() ([]byte, error)

type ListEntitlementsResponse

type ListEntitlementsResponse struct {
	// Entitlements: The list of entitlements in this response.
	Entitlements []*Entitlement `json:"entitlements,omitempty"`

	// NextPageToken: The token for fetching the next page.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Entitlements") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Entitlements") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListEntitlementsResponse: Response message for PartnerProcurementService.ListEntitlements.

func (*ListEntitlementsResponse) MarshalJSON

func (s *ListEntitlementsResponse) MarshalJSON() ([]byte, error)

type ProvidersAccountsApproveCall

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

func (*ProvidersAccountsApproveCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersAccountsApproveCall) Do

Do executes the "cloudcommerceprocurement.providers.accounts.approve" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersAccountsApproveCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersAccountsApproveCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProvidersAccountsGetCall

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

func (*ProvidersAccountsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersAccountsGetCall) Do

Do executes the "cloudcommerceprocurement.providers.accounts.get" call. Exactly one of *Account or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Account.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersAccountsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersAccountsGetCall) Header

func (c *ProvidersAccountsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProvidersAccountsGetCall) IfNoneMatch

func (c *ProvidersAccountsGetCall) IfNoneMatch(entityTag string) *ProvidersAccountsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProvidersAccountsListCall

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

func (*ProvidersAccountsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersAccountsListCall) Do

Do executes the "cloudcommerceprocurement.providers.accounts.list" call. Exactly one of *ListAccountsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAccountsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersAccountsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersAccountsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProvidersAccountsListCall) IfNoneMatch

func (c *ProvidersAccountsListCall) IfNoneMatch(entityTag string) *ProvidersAccountsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProvidersAccountsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested. Default size is 200.

func (*ProvidersAccountsListCall) PageToken

PageToken sets the optional parameter "pageToken": The token for fetching the next page.

func (*ProvidersAccountsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProvidersAccountsRejectCall

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

func (*ProvidersAccountsRejectCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersAccountsRejectCall) Do

Do executes the "cloudcommerceprocurement.providers.accounts.reject" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersAccountsRejectCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersAccountsRejectCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProvidersAccountsResetCall

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

func (*ProvidersAccountsResetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersAccountsResetCall) Do

Do executes the "cloudcommerceprocurement.providers.accounts.reset" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersAccountsResetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersAccountsResetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProvidersAccountsService

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

func NewProvidersAccountsService

func NewProvidersAccountsService(s *Service) *ProvidersAccountsService

func (*ProvidersAccountsService) Approve

func (r *ProvidersAccountsService) Approve(name string, approveaccountrequest *ApproveAccountRequest) *ProvidersAccountsApproveCall

Approve: Grant an approval on an Account.

func (*ProvidersAccountsService) Get

Get: Get a requested Account resource.

func (*ProvidersAccountsService) List

List: List Accounts that the provider has access to.

func (*ProvidersAccountsService) Reject

func (r *ProvidersAccountsService) Reject(name string, rejectaccountrequest *RejectAccountRequest) *ProvidersAccountsRejectCall

Reject: Reject an approval on an Account.

func (*ProvidersAccountsService) Reset

func (r *ProvidersAccountsService) Reset(name string, resetaccountrequest *ResetAccountRequest) *ProvidersAccountsResetCall

Reset: Reset an Account and cancel all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.

type ProvidersEntitlementsApproveCall

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

func (*ProvidersEntitlementsApproveCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersEntitlementsApproveCall) Do

Do executes the "cloudcommerceprocurement.providers.entitlements.approve" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersEntitlementsApproveCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersEntitlementsApproveCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProvidersEntitlementsApprovePlanChangeCall

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

func (*ProvidersEntitlementsApprovePlanChangeCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersEntitlementsApprovePlanChangeCall) Do

Do executes the "cloudcommerceprocurement.providers.entitlements.approvePlanChange" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersEntitlementsApprovePlanChangeCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersEntitlementsApprovePlanChangeCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProvidersEntitlementsGetCall

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

func (*ProvidersEntitlementsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersEntitlementsGetCall) Do

Do executes the "cloudcommerceprocurement.providers.entitlements.get" call. Exactly one of *Entitlement or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Entitlement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersEntitlementsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersEntitlementsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProvidersEntitlementsGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProvidersEntitlementsListCall

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

func (*ProvidersEntitlementsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersEntitlementsListCall) Do

Do executes the "cloudcommerceprocurement.providers.entitlements.list" call. Exactly one of *ListEntitlementsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListEntitlementsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersEntitlementsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersEntitlementsListCall) Filter

Filter sets the optional parameter "filter": The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `product_external_name` * `quote_external_name` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `consumers.project` Note that the consumers match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. Also note that the state name match is case-insensitive and query can omit the prefix "ENTITLEMENT_". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product="providerId:productId", where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.

func (*ProvidersEntitlementsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProvidersEntitlementsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProvidersEntitlementsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*ProvidersEntitlementsListCall) PageToken

PageToken sets the optional parameter "pageToken": The token for fetching the next page.

func (*ProvidersEntitlementsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProvidersEntitlementsPatchCall

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

func (*ProvidersEntitlementsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersEntitlementsPatchCall) Do

Do executes the "cloudcommerceprocurement.providers.entitlements.patch" call. Exactly one of *Entitlement or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Entitlement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersEntitlementsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersEntitlementsPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProvidersEntitlementsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google. protobuf#fieldmask) for more details.

type ProvidersEntitlementsRejectCall

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

func (*ProvidersEntitlementsRejectCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersEntitlementsRejectCall) Do

Do executes the "cloudcommerceprocurement.providers.entitlements.reject" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersEntitlementsRejectCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersEntitlementsRejectCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProvidersEntitlementsRejectPlanChangeCall

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

func (*ProvidersEntitlementsRejectPlanChangeCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersEntitlementsRejectPlanChangeCall) Do

Do executes the "cloudcommerceprocurement.providers.entitlements.rejectPlanChange" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersEntitlementsRejectPlanChangeCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersEntitlementsRejectPlanChangeCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProvidersEntitlementsService

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

func NewProvidersEntitlementsService

func NewProvidersEntitlementsService(s *Service) *ProvidersEntitlementsService

func (*ProvidersEntitlementsService) Approve

Approve: Approve an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.

func (*ProvidersEntitlementsService) ApprovePlanChange

func (r *ProvidersEntitlementsService) ApprovePlanChange(name string, approveentitlementplanchangerequest *ApproveEntitlementPlanChangeRequest) *ProvidersEntitlementsApprovePlanChangeCall

ApprovePlanChange: Approve an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.

func (*ProvidersEntitlementsService) Get

Get: Get a requested Entitlement resource.

func (*ProvidersEntitlementsService) List

List: List Entitlements for which the provider has read access.

func (*ProvidersEntitlementsService) Patch

Patch: Updates an existing Entitlement.

func (*ProvidersEntitlementsService) Reject

Reject: Reject an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.

func (*ProvidersEntitlementsService) RejectPlanChange

func (r *ProvidersEntitlementsService) RejectPlanChange(name string, rejectentitlementplanchangerequest *RejectEntitlementPlanChangeRequest) *ProvidersEntitlementsRejectPlanChangeCall

RejectPlanChange: Reject an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.

func (*ProvidersEntitlementsService) Suspend

Suspend: Request suspension of an active Entitlement. This is not yet supported.

type ProvidersEntitlementsSuspendCall

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

func (*ProvidersEntitlementsSuspendCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProvidersEntitlementsSuspendCall) Do

Do executes the "cloudcommerceprocurement.providers.entitlements.suspend" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProvidersEntitlementsSuspendCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProvidersEntitlementsSuspendCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProvidersService

type ProvidersService struct {
	Accounts *ProvidersAccountsService

	Entitlements *ProvidersEntitlementsService
	// contains filtered or unexported fields
}

func NewProvidersService

func NewProvidersService(s *Service) *ProvidersService

type RejectAccountRequest

type RejectAccountRequest struct {
	// ApprovalName: The name of the approval being rejected. If absent and
	// there is only one approval possible, that approval will be rejected.
	// If absent and there are many approvals possible, the request will
	// fail with a 400 Bad Request. Optional.
	ApprovalName string `json:"approvalName,omitempty"`

	// Reason: Free form text string explaining the rejection reason. Max
	// allowed length: 256 bytes. Longer strings will be truncated.
	Reason string `json:"reason,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ApprovalName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ApprovalName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RejectAccountRequest: Request message for PartnerProcurementService.RejectAccount.

func (*RejectAccountRequest) MarshalJSON

func (s *RejectAccountRequest) MarshalJSON() ([]byte, error)

type RejectEntitlementPlanChangeRequest

type RejectEntitlementPlanChangeRequest struct {
	// PendingPlanName: Name of the pending plan that is being rejected.
	// Required.
	PendingPlanName string `json:"pendingPlanName,omitempty"`

	// Reason: Free form text string explaining the rejection reason. Max
	// allowed length: 256 bytes. Longer strings will be truncated.
	Reason string `json:"reason,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PendingPlanName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PendingPlanName") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RejectEntitlementPlanChangeRequest: Request message for PartnerProcurementService.RejectEntitlementPlanChange.

func (*RejectEntitlementPlanChangeRequest) MarshalJSON

func (s *RejectEntitlementPlanChangeRequest) MarshalJSON() ([]byte, error)

type RejectEntitlementRequest

type RejectEntitlementRequest struct {
	// Reason: Free form text string explaining the rejection reason. Max
	// allowed length: 256 bytes. Longer strings will be truncated.
	Reason string `json:"reason,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Reason") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Reason") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RejectEntitlementRequest: Request message for PartnerProcurementService.RejectEntitlement.

func (*RejectEntitlementRequest) MarshalJSON

func (s *RejectEntitlementRequest) MarshalJSON() ([]byte, error)

type ResetAccountRequest

type ResetAccountRequest struct {
}

ResetAccountRequest: Request message for for PartnerProcurementService.ResetAccount.

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Providers *ProvidersService
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SuspendEntitlementRequest

type SuspendEntitlementRequest struct {
	// Reason: A free-form reason string, explaining the reason for
	// suspension request.
	Reason string `json:"reason,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Reason") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Reason") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SuspendEntitlementRequest: Request message for ParterProcurementService.SuspendEntitlement. This is not yet supported.

func (*SuspendEntitlementRequest) MarshalJSON

func (s *SuspendEntitlementRequest) MarshalJSON() ([]byte, error)