cloudcommerceprocurement

package
v0.213.0 Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

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

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

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

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 google.golang.org/api/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 google.golang.org/api/option.WithTokenSource: 

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

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	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" - Default state of the account. It's only set
	// to this value when the account is first created and has not been
	// initialized.
	//   "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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ApproveAccountRequest: Request message for PartnerProcurementService.ApproveAccount.

func (*ApproveAccountRequest) MarshalJSON 

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

type ApproveEntitlementPlanChangeRequest 

type ApproveEntitlementPlanChangeRequest struct {
	// PendingPlanName: Required. Name of the pending plan that's being approved.
	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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*ApproveEntitlementPlanChangeRequest) MarshalJSON 

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

type ApproveEntitlementRequest 

type ApproveEntitlementRequest struct {
	// EntitlementMigrated: Optional. The resource name of the entitlement that was
	// migrated, with the format
	// `providers/{provider_id}/entitlements/{entitlement_id}`. Should only be sent
	// when resources have been migrated from entitlement_migrated to the new
	// entitlement. Optional.
	EntitlementMigrated string `json:"entitlementMigrated,omitempty"`
	// 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. "EntitlementMigrated") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EntitlementMigrated") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*ApproveEntitlementRequest) MarshalJSON 

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

type Consumer added in v0.31.0 

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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Consumer: A resource using (consuming) this entitlement.

func (*Consumer) MarshalJSON added in v0.31.0 

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); }

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"`
	// CancellationReason: Output only. The reason the entitlement was cancelled.
	// If this entitlement wasn't cancelled, this field is empty. Possible values
	// include "unknown", "expired", "user-cancelled", "account-closed",
	// "billing-disabled" (if the customer has manually disabled billing to their
	// resources), "user-aborted", and "migrated" (if the entitlement has migrated
	// across products). Values of this field are subject to change, and we
	// recommend that you don't build your technical integration to rely on these
	// fields.
	CancellationReason string `json:"cancellationReason,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"`
	// EntitlementBenefitIds: Output only. The entitlement benefit IDs associated
	// with the purchase.
	EntitlementBenefitIds []string `json:"entitlementBenefitIds,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"`
	// NewOfferEndTime: Output only. The end time of the new offer. If the offer
	// was created with a term instead of a specified end date, this field is
	// empty. This field is populated even if the entitlement isn't active yet. If
	// there's no upcoming offer, the field is be empty.
	NewOfferEndTime string `json:"newOfferEndTime,omitempty"`
	// NewOfferStartTime: Output only. The timestamp when the new offer becomes
	// effective. This field is populated even if the entitlement isn't active yet.
	// If there's no upcoming offer, the field is empty.
	NewOfferStartTime string `json:"newOfferStartTime,omitempty"`
	// NewPendingOffer: Output only. The name of the offer the entitlement is
	// switching to upon a pending plan change. Only exists if the pending plan
	// change is moving to an offer. This field isn't populated for entitlements
	// which aren't active yet. Format:
	// 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR
	// 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending
	// on whether the offer is private or public. The {service} in the name is the
	// listing service of the offer. It could be either the product service that
	// the offer is referencing, or a generic private offer parent service. We
	// recommend that you don't build your integration to rely on the meaning of
	// this {service} part.
	NewPendingOffer string `json:"newPendingOffer,omitempty"`
	// NewPendingOfferDuration: Output only. The duration of the new offer, in ISO
	// 8601 duration format. This field isn't populated for entitlements which
	// aren't active yet, only for pending offer changes. If the offer was created
	// with a specified end date instead of a duration, this field is empty.
	NewPendingOfferDuration string `json:"newPendingOfferDuration,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"`
	// Offer: Output only. The name of the offer that was procured. Field is empty
	// if order was not made using an offer. Format:
	// 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR
	// 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending
	// on whether the offer is private or public. The {service} in the name is the
	// listing service of the offer. It could be either the product service that
	// the offer is referencing, or a generic private offer parent service. We
	// recommend that you don't build your integration to rely on the meaning of
	// this {service} part.
	Offer string `json:"offer,omitempty"`
	// OfferDuration: Output only. The offer duration of the current offer in ISO
	// 8601 duration format. Field is empty if entitlement was not made using an
	// offer. If the offer was created with a specified end date instead of a
	// duration, this field is empty.
	OfferDuration string `json:"offerDuration,omitempty"`
	// OfferEndTime: Output only. End time for the Offer association corresponding
	// to this entitlement. The field is only populated if the entitlement is
	// currently associated with an Offer.
	OfferEndTime string `json:"offerEndTime,omitempty"`
	// OrderId: Output only. The order ID of this entitlement, without any
	// `orders/` resource name prefix.
	OrderId string `json:"orderId,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, quote, or offer. We strongly recommend
	// that you use the following more explicit fields: productExternalName,
	// quoteExternalName, or offer.
	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" - Default state of the entitlement. It's
	// only set to this value when the entitlement is first created and has not
	// been initialized.
	//   "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. Entitlements in this state WILL renew. The analogous state for an
	// unexpired but non-renewing entitlement is ENTITLEMENT_PENDING_CANCELLATION.
	// 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 will
	// expire at the end of its term. This could mean the customer has elected not
	// to renew this entitlement or the customer elected to cancel an entitlement
	// that only expires at term end. 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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Entitlement: Represents a procured product of a customer.

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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 

func (c *ProvidersAccountsApproveCall) Context(ctx context.Context) *ProvidersAccountsApproveCall

Context sets the context to be used in this call's Do method.

func (*ProvidersAccountsApproveCall) Do 

func (c *ProvidersAccountsApproveCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudcommerceprocurement.providers.accounts.approve" call. 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 

func (c *ProvidersAccountsApproveCall) Fields(s ...googleapi.Field) *ProvidersAccountsApproveCall

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

func (*ProvidersAccountsApproveCall) Header 

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

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

type ProvidersAccountsGetCall 

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

func (*ProvidersAccountsGetCall) Context 

func (c *ProvidersAccountsGetCall) Context(ctx context.Context) *ProvidersAccountsGetCall

Context sets the context to be used in this call's Do method.

func (*ProvidersAccountsGetCall) Do 

func (c *ProvidersAccountsGetCall) Do(opts ...googleapi.CallOption) (*Account, error)

Do executes the "cloudcommerceprocurement.providers.accounts.get" call. 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 

func (c *ProvidersAccountsGetCall) Fields(s ...googleapi.Field) *ProvidersAccountsGetCall

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

func (*ProvidersAccountsGetCall) Header 

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

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

func (*ProvidersAccountsGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type ProvidersAccountsListCall 

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

func (*ProvidersAccountsListCall) Context 

func (c *ProvidersAccountsListCall) Context(ctx context.Context) *ProvidersAccountsListCall

Context sets the context to be used in this call's Do method.

func (*ProvidersAccountsListCall) Do 

func (c *ProvidersAccountsListCall) Do(opts ...googleapi.CallOption) (*ListAccountsResponse, error)

Do executes the "cloudcommerceprocurement.providers.accounts.list" call. 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 

func (c *ProvidersAccountsListCall) Fields(s ...googleapi.Field) *ProvidersAccountsListCall

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

func (*ProvidersAccountsListCall) Header 

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

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

func (*ProvidersAccountsListCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*ProvidersAccountsListCall) PageSize 

func (c *ProvidersAccountsListCall) PageSize(pageSize int64) *ProvidersAccountsListCall

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

func (*ProvidersAccountsListCall) PageToken 

func (c *ProvidersAccountsListCall) PageToken(pageToken string) *ProvidersAccountsListCall

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

func (*ProvidersAccountsListCall) Pages 

func (c *ProvidersAccountsListCall) Pages(ctx context.Context, f func(*ListAccountsResponse) error) error

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 

func (c *ProvidersAccountsRejectCall) Context(ctx context.Context) *ProvidersAccountsRejectCall

Context sets the context to be used in this call's Do method.

func (*ProvidersAccountsRejectCall) Do 

func (c *ProvidersAccountsRejectCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudcommerceprocurement.providers.accounts.reject" call. 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 

func (c *ProvidersAccountsRejectCall) Fields(s ...googleapi.Field) *ProvidersAccountsRejectCall

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

func (*ProvidersAccountsRejectCall) Header 

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

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

type ProvidersAccountsResetCall 

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

func (*ProvidersAccountsResetCall) Context 

func (c *ProvidersAccountsResetCall) Context(ctx context.Context) *ProvidersAccountsResetCall

Context sets the context to be used in this call's Do method.

func (*ProvidersAccountsResetCall) Do 

func (c *ProvidersAccountsResetCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudcommerceprocurement.providers.accounts.reset" call. 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 

func (c *ProvidersAccountsResetCall) Fields(s ...googleapi.Field) *ProvidersAccountsResetCall

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

func (*ProvidersAccountsResetCall) Header 

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

Header returns a http.Header that can be modified by the caller to add 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: Grants an approval on an Account.

  • name: The resource name of the account, with the format `providers/{providerId}/accounts/{accountId}`.

func (*ProvidersAccountsService) Get 

func (r *ProvidersAccountsService) Get(name string) *ProvidersAccountsGetCall

Get: Gets a requested Account resource.

- name: The name of the account to retrieve.

func (*ProvidersAccountsService) List 

func (r *ProvidersAccountsService) List(parent string) *ProvidersAccountsListCall

List: Lists Accounts that the provider has access to.

- parent: The parent resource name.

func (*ProvidersAccountsService) Reject 

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

Reject: Rejects an approval on an Account.

- name: The resource name of the account.

func (*ProvidersAccountsService) Reset 

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

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

- name: The resource name of the account.

type ProvidersEntitlementsApproveCall 

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

func (*ProvidersEntitlementsApproveCall) Context 

func (c *ProvidersEntitlementsApproveCall) Context(ctx context.Context) *ProvidersEntitlementsApproveCall

Context sets the context to be used in this call's Do method.

func (*ProvidersEntitlementsApproveCall) Do 

func (c *ProvidersEntitlementsApproveCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudcommerceprocurement.providers.entitlements.approve" call. 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 

func (c *ProvidersEntitlementsApproveCall) Fields(s ...googleapi.Field) *ProvidersEntitlementsApproveCall

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

func (*ProvidersEntitlementsApproveCall) Header 

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

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

type ProvidersEntitlementsApprovePlanChangeCall 

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

func (*ProvidersEntitlementsApprovePlanChangeCall) Context 

func (c *ProvidersEntitlementsApprovePlanChangeCall) Context(ctx context.Context) *ProvidersEntitlementsApprovePlanChangeCall

Context sets the context to be used in this call's Do method.

func (*ProvidersEntitlementsApprovePlanChangeCall) Do 

func (c *ProvidersEntitlementsApprovePlanChangeCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudcommerceprocurement.providers.entitlements.approvePlanChange" call. 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 

func (c *ProvidersEntitlementsApprovePlanChangeCall) Fields(s ...googleapi.Field) *ProvidersEntitlementsApprovePlanChangeCall

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

func (*ProvidersEntitlementsApprovePlanChangeCall) Header 

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

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

type ProvidersEntitlementsGetCall 

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

func (*ProvidersEntitlementsGetCall) Context 

func (c *ProvidersEntitlementsGetCall) Context(ctx context.Context) *ProvidersEntitlementsGetCall

Context sets the context to be used in this call's Do method.

func (*ProvidersEntitlementsGetCall) Do 

func (c *ProvidersEntitlementsGetCall) Do(opts ...googleapi.CallOption) (*Entitlement, error)

Do executes the "cloudcommerceprocurement.providers.entitlements.get" call. 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 

func (c *ProvidersEntitlementsGetCall) Fields(s ...googleapi.Field) *ProvidersEntitlementsGetCall

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

func (*ProvidersEntitlementsGetCall) Header 

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

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

func (*ProvidersEntitlementsGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type ProvidersEntitlementsListCall 

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

func (*ProvidersEntitlementsListCall) Context 

func (c *ProvidersEntitlementsListCall) Context(ctx context.Context) *ProvidersEntitlementsListCall

Context sets the context to be used in this call's Do method.

func (*ProvidersEntitlementsListCall) Do 

func (c *ProvidersEntitlementsListCall) Do(opts ...googleapi.CallOption) (*ListEntitlementsResponse, error)

Do executes the "cloudcommerceprocurement.providers.entitlements.list" call. 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 

func (c *ProvidersEntitlementsListCall) Fields(s ...googleapi.Field) *ProvidersEntitlementsListCall

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

func (*ProvidersEntitlementsListCall) Filter 

func (c *ProvidersEntitlementsListCall) Filter(filter string) *ProvidersEntitlementsListCall

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` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `consumers.project` * `change_history.new_offer` Note that the consumers and change_history.new_offer 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`. `change_history.new_offer` retrieves all entitlements that were once associated or are currently active with the offer. 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 

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

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

func (*ProvidersEntitlementsListCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*ProvidersEntitlementsListCall) PageSize 

func (c *ProvidersEntitlementsListCall) PageSize(pageSize int64) *ProvidersEntitlementsListCall

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

func (*ProvidersEntitlementsListCall) PageToken 

func (c *ProvidersEntitlementsListCall) PageToken(pageToken string) *ProvidersEntitlementsListCall

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

func (*ProvidersEntitlementsListCall) Pages 

func (c *ProvidersEntitlementsListCall) Pages(ctx context.Context, f func(*ListEntitlementsResponse) error) error

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 

func (c *ProvidersEntitlementsPatchCall) Context(ctx context.Context) *ProvidersEntitlementsPatchCall

Context sets the context to be used in this call's Do method.

func (*ProvidersEntitlementsPatchCall) Do 

func (c *ProvidersEntitlementsPatchCall) Do(opts ...googleapi.CallOption) (*Entitlement, error)

Do executes the "cloudcommerceprocurement.providers.entitlements.patch" call. 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 

func (c *ProvidersEntitlementsPatchCall) Fields(s ...googleapi.Field) *ProvidersEntitlementsPatchCall

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

func (*ProvidersEntitlementsPatchCall) Header 

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

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

func (*ProvidersEntitlementsPatchCall) UpdateMask 

func (c *ProvidersEntitlementsPatchCall) UpdateMask(updateMask string) *ProvidersEntitlementsPatchCall

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 

func (c *ProvidersEntitlementsRejectCall) Context(ctx context.Context) *ProvidersEntitlementsRejectCall

Context sets the context to be used in this call's Do method.

func (*ProvidersEntitlementsRejectCall) Do 

func (c *ProvidersEntitlementsRejectCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudcommerceprocurement.providers.entitlements.reject" call. 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 

func (c *ProvidersEntitlementsRejectCall) Fields(s ...googleapi.Field) *ProvidersEntitlementsRejectCall

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

func (*ProvidersEntitlementsRejectCall) Header 

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

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

type ProvidersEntitlementsRejectPlanChangeCall 

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

func (*ProvidersEntitlementsRejectPlanChangeCall) Context 

func (c *ProvidersEntitlementsRejectPlanChangeCall) Context(ctx context.Context) *ProvidersEntitlementsRejectPlanChangeCall

Context sets the context to be used in this call's Do method.

func (*ProvidersEntitlementsRejectPlanChangeCall) Do 

func (c *ProvidersEntitlementsRejectPlanChangeCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudcommerceprocurement.providers.entitlements.rejectPlanChange" call. 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 

func (c *ProvidersEntitlementsRejectPlanChangeCall) Fields(s ...googleapi.Field) *ProvidersEntitlementsRejectPlanChangeCall

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

func (*ProvidersEntitlementsRejectPlanChangeCall) Header 

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

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

type ProvidersEntitlementsService 

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

func NewProvidersEntitlementsService 

func NewProvidersEntitlementsService(s *Service) *ProvidersEntitlementsService

func (*ProvidersEntitlementsService) Approve 

func (r *ProvidersEntitlementsService) Approve(name string, approveentitlementrequest *ApproveEntitlementRequest) *ProvidersEntitlementsApproveCall

Approve: Approves 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.

  • name: The resource name of the entitlement, with the format `providers/{providerId}/entitlements/{entitlementId}`.

func (*ProvidersEntitlementsService) ApprovePlanChange 

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

ApprovePlanChange: Approves 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.

- name: The resource name of the entitlement.

func (*ProvidersEntitlementsService) Get 

func (r *ProvidersEntitlementsService) Get(name string) *ProvidersEntitlementsGetCall

Get: Gets a requested Entitlement resource.

- name: The name of the entitlement to retrieve.

func (*ProvidersEntitlementsService) List 

func (r *ProvidersEntitlementsService) List(parent string) *ProvidersEntitlementsListCall

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

- parent: The parent resource name.

func (*ProvidersEntitlementsService) Patch 

func (r *ProvidersEntitlementsService) Patch(name string, entitlement *Entitlement) *ProvidersEntitlementsPatchCall

Patch: Updates an existing Entitlement.

- name: The name of the entitlement to update.

func (*ProvidersEntitlementsService) Reject 

func (r *ProvidersEntitlementsService) Reject(name string, rejectentitlementrequest *RejectEntitlementRequest) *ProvidersEntitlementsRejectCall

Reject: Rejects 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.

- name: The resource name of the entitlement.

func (*ProvidersEntitlementsService) RejectPlanChange 

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

RejectPlanChange: Rejects 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.

- name: The resource name of the entitlement.

func (*ProvidersEntitlementsService) Suspend 

func (r *ProvidersEntitlementsService) Suspend(name string, suspendentitlementrequest *SuspendEntitlementRequest) *ProvidersEntitlementsSuspendCall

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

- name: The name of the entitlement to suspend.

type ProvidersEntitlementsSuspendCall 

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

func (*ProvidersEntitlementsSuspendCall) Context 

func (c *ProvidersEntitlementsSuspendCall) Context(ctx context.Context) *ProvidersEntitlementsSuspendCall

Context sets the context to be used in this call's Do method.

func (*ProvidersEntitlementsSuspendCall) Do 

func (c *ProvidersEntitlementsSuspendCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudcommerceprocurement.providers.entitlements.suspend" call. 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 

func (c *ProvidersEntitlementsSuspendCall) Fields(s ...googleapi.Field) *ProvidersEntitlementsSuspendCall

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

func (*ProvidersEntitlementsSuspendCall) Header 

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

Header returns a http.Header that can be modified by the caller to add 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RejectAccountRequest: Request message for PartnerProcurementService.RejectAccount.

func (*RejectAccountRequest) MarshalJSON 

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

type RejectEntitlementPlanChangeRequest 

type RejectEntitlementPlanChangeRequest struct {
	// PendingPlanName: Required. Name of the pending plan that is being rejected.
	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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 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 deprecated 

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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*SuspendEntitlementRequest) MarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.