Cloud Commerce Producer v1beta API - Class CommerceTransactionClientImpl (1.0.0-beta01)

public sealed class CommerceTransactionClientImpl : CommerceTransactionClient

Reference documentation and code samples for the Cloud Commerce Producer v1beta API class CommerceTransactionClientImpl.

CommerceTransaction client wrapper implementation, for convenient use.

Inheritance

object > CommerceTransactionClient > CommerceTransactionClientImpl

Namespace

Google.Cloud.CommerceProducer.V1Beta

Assembly

Google.Cloud.CommerceProducer.V1Beta.dll

Remarks

APIs related to managing resources that model commercial transactions.

Constructors

CommerceTransactionClientImpl(CommerceTransactionClient, CommerceTransactionSettings, ILogger)

public CommerceTransactionClientImpl(CommerceTransaction.CommerceTransactionClient grpcClient, CommerceTransactionSettings settings, ILogger logger)

Constructs a client wrapper for the CommerceTransaction service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient CommerceTransactionCommerceTransactionClient

The underlying gRPC client.

settings CommerceTransactionSettings

The base CommerceTransactionSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override CommerceTransaction.CommerceTransactionClient GrpcClient { get; }

The underlying gRPC CommerceTransaction client

Property Value
Type Description
CommerceTransactionCommerceTransactionClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CancelPrivateOffer(CancelPrivateOfferRequest, CallSettings)

public override PrivateOffer CancelPrivateOffer(CancelPrivateOfferRequest request, CallSettings callSettings = null)

Cancels the target PrivateOffer.

Parameters
Name Description
request CancelPrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateOffer

The RPC response.

Overrides

CancelPrivateOfferAsync(CancelPrivateOfferRequest, CallSettings)

public override Task<PrivateOffer> CancelPrivateOfferAsync(CancelPrivateOfferRequest request, CallSettings callSettings = null)

Cancels the target PrivateOffer.

Parameters
Name Description
request CancelPrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPrivateOffer

A Task containing the RPC response.

Overrides

CreatePrivateOffer(CreatePrivateOfferRequest, CallSettings)

public override PrivateOffer CreatePrivateOffer(CreatePrivateOfferRequest request, CallSettings callSettings = null)

Creates a new PrivateOffer in a given project and location.

Parameters
Name Description
request CreatePrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateOffer

The RPC response.

Overrides

CreatePrivateOfferAsync(CreatePrivateOfferRequest, CallSettings)

public override Task<PrivateOffer> CreatePrivateOfferAsync(CreatePrivateOfferRequest request, CallSettings callSettings = null)

Creates a new PrivateOffer in a given project and location.

Parameters
Name Description
request CreatePrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPrivateOffer

A Task containing the RPC response.

Overrides

CreatePrivateOfferDocument(CreatePrivateOfferDocumentRequest, CallSettings)

public override PrivateOfferDocument CreatePrivateOfferDocument(CreatePrivateOfferDocumentRequest request, CallSettings callSettings = null)

Creates a new PrivateOfferDocument in a given project and location.

Parameters
Name Description
request CreatePrivateOfferDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateOfferDocument

The RPC response.

Overrides

CreatePrivateOfferDocumentAsync(CreatePrivateOfferDocumentRequest, CallSettings)

public override Task<PrivateOfferDocument> CreatePrivateOfferDocumentAsync(CreatePrivateOfferDocumentRequest request, CallSettings callSettings = null)

Creates a new PrivateOfferDocument in a given project and location.

Parameters
Name Description
request CreatePrivateOfferDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPrivateOfferDocument

A Task containing the RPC response.

Overrides

DeletePrivateOffer(DeletePrivateOfferRequest, CallSettings)

public override void DeletePrivateOffer(DeletePrivateOfferRequest request, CallSettings callSettings = null)

Deletes the target PrivateOffer.

Parameters
Name Description
request DeletePrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Overrides

DeletePrivateOfferAsync(DeletePrivateOfferRequest, CallSettings)

public override Task DeletePrivateOfferAsync(DeletePrivateOfferRequest request, CallSettings callSettings = null)

Deletes the target PrivateOffer.

Parameters
Name Description
request DeletePrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Overrides

DeletePrivateOfferDocument(DeletePrivateOfferDocumentRequest, CallSettings)

public override void DeletePrivateOfferDocument(DeletePrivateOfferDocumentRequest request, CallSettings callSettings = null)

Deletes the target PrivateOfferDocument.

Parameters
Name Description
request DeletePrivateOfferDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Overrides

DeletePrivateOfferDocumentAsync(DeletePrivateOfferDocumentRequest, CallSettings)

public override Task DeletePrivateOfferDocumentAsync(DeletePrivateOfferDocumentRequest request, CallSettings callSettings = null)

Deletes the target PrivateOfferDocument.

Parameters
Name Description
request DeletePrivateOfferDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Overrides

GetPrivateOffer(GetPrivateOfferRequest, CallSettings)

public override PrivateOffer GetPrivateOffer(GetPrivateOfferRequest request, CallSettings callSettings = null)

Gets details of a single PrivateOffer.

Parameters
Name Description
request GetPrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateOffer

The RPC response.

Overrides

GetPrivateOfferAsync(GetPrivateOfferRequest, CallSettings)

public override Task<PrivateOffer> GetPrivateOfferAsync(GetPrivateOfferRequest request, CallSettings callSettings = null)

Gets details of a single PrivateOffer.

Parameters
Name Description
request GetPrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPrivateOffer

A Task containing the RPC response.

Overrides

GetPrivateOfferDocument(GetPrivateOfferDocumentRequest, CallSettings)

public override PrivateOfferDocument GetPrivateOfferDocument(GetPrivateOfferDocumentRequest request, CallSettings callSettings = null)

Gets details of a single PrivateOfferDocument.

Parameters
Name Description
request GetPrivateOfferDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateOfferDocument

The RPC response.

Overrides

GetPrivateOfferDocumentAsync(GetPrivateOfferDocumentRequest, CallSettings)

public override Task<PrivateOfferDocument> GetPrivateOfferDocumentAsync(GetPrivateOfferDocumentRequest request, CallSettings callSettings = null)

Gets details of a single PrivateOfferDocument.

Parameters
Name Description
request GetPrivateOfferDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPrivateOfferDocument

A Task containing the RPC response.

Overrides

GetService(GetServiceRequest, CallSettings)

public override Service GetService(GetServiceRequest request, CallSettings callSettings = null)

Gets details of a single Service.

Parameters
Name Description
request GetServiceRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Service

The RPC response.

Overrides

GetServiceAsync(GetServiceRequest, CallSettings)

public override Task<Service> GetServiceAsync(GetServiceRequest request, CallSettings callSettings = null)

Gets details of a single Service.

Parameters
Name Description
request GetServiceRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskService

A Task containing the RPC response.

Overrides

GetSku(GetSkuRequest, CallSettings)

public override Sku GetSku(GetSkuRequest request, CallSettings callSettings = null)

Gets details of a single Sku.

Parameters
Name Description
request GetSkuRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Sku

The RPC response.

Overrides

GetSkuAsync(GetSkuRequest, CallSettings)

public override Task<Sku> GetSkuAsync(GetSkuRequest request, CallSettings callSettings = null)

Gets details of a single Sku.

Parameters
Name Description
request GetSkuRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSku

A Task containing the RPC response.

Overrides

GetSkuGroup(GetSkuGroupRequest, CallSettings)

public override SkuGroup GetSkuGroup(GetSkuGroupRequest request, CallSettings callSettings = null)

Gets details of a single SkuGroup.

Parameters
Name Description
request GetSkuGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SkuGroup

The RPC response.

Overrides

GetSkuGroupAsync(GetSkuGroupRequest, CallSettings)

public override Task<SkuGroup> GetSkuGroupAsync(GetSkuGroupRequest request, CallSettings callSettings = null)

Gets details of a single SkuGroup.

Parameters
Name Description
request GetSkuGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSkuGroup

A Task containing the RPC response.

Overrides

GetStandardOffer(GetStandardOfferRequest, CallSettings)

public override StandardOffer GetStandardOffer(GetStandardOfferRequest request, CallSettings callSettings = null)

Gets details of a single StandardOffer.

Parameters
Name Description
request GetStandardOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
StandardOffer

The RPC response.

Overrides

GetStandardOfferAsync(GetStandardOfferRequest, CallSettings)

public override Task<StandardOffer> GetStandardOfferAsync(GetStandardOfferRequest request, CallSettings callSettings = null)

Gets details of a single StandardOffer.

Parameters
Name Description
request GetStandardOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskStandardOffer

A Task containing the RPC response.

Overrides

ListPrivateOfferDocuments(ListPrivateOfferDocumentsRequest, CallSettings)

public override PagedEnumerable<ListPrivateOfferDocumentsResponse, PrivateOfferDocument> ListPrivateOfferDocuments(ListPrivateOfferDocumentsRequest request, CallSettings callSettings = null)

Lists PrivateOfferDocuments for the given parent.

Parameters
Name Description
request ListPrivateOfferDocumentsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListPrivateOfferDocumentsResponsePrivateOfferDocument

A pageable sequence of PrivateOfferDocument resources.

Overrides

ListPrivateOfferDocumentsAsync(ListPrivateOfferDocumentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPrivateOfferDocumentsResponse, PrivateOfferDocument> ListPrivateOfferDocumentsAsync(ListPrivateOfferDocumentsRequest request, CallSettings callSettings = null)

Lists PrivateOfferDocuments for the given parent.

Parameters
Name Description
request ListPrivateOfferDocumentsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListPrivateOfferDocumentsResponsePrivateOfferDocument

A pageable asynchronous sequence of PrivateOfferDocument resources.

Overrides

ListPrivateOffers(ListPrivateOffersRequest, CallSettings)

public override PagedEnumerable<ListPrivateOffersResponse, PrivateOffer> ListPrivateOffers(ListPrivateOffersRequest request, CallSettings callSettings = null)

Lists PrivateOffers for the given parent.

Parameters
Name Description
request ListPrivateOffersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListPrivateOffersResponsePrivateOffer

A pageable sequence of PrivateOffer resources.

Overrides

ListPrivateOffersAsync(ListPrivateOffersRequest, CallSettings)

public override PagedAsyncEnumerable<ListPrivateOffersResponse, PrivateOffer> ListPrivateOffersAsync(ListPrivateOffersRequest request, CallSettings callSettings = null)

Lists PrivateOffers for the given parent.

Parameters
Name Description
request ListPrivateOffersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListPrivateOffersResponsePrivateOffer

A pageable asynchronous sequence of PrivateOffer resources.

Overrides

ListServices(ListServicesRequest, CallSettings)

public override PagedEnumerable<ListServicesResponse, Service> ListServices(ListServicesRequest request, CallSettings callSettings = null)

Lists Services in a given project and location.

Parameters
Name Description
request ListServicesRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListServicesResponseService

A pageable sequence of Service resources.

Overrides

ListServicesAsync(ListServicesRequest, CallSettings)

public override PagedAsyncEnumerable<ListServicesResponse, Service> ListServicesAsync(ListServicesRequest request, CallSettings callSettings = null)

Lists Services in a given project and location.

Parameters
Name Description
request ListServicesRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListServicesResponseService

A pageable asynchronous sequence of Service resources.

Overrides

ListSkuGroups(ListSkuGroupsRequest, CallSettings)

public override PagedEnumerable<ListSkuGroupsResponse, SkuGroup> ListSkuGroups(ListSkuGroupsRequest request, CallSettings callSettings = null)

Lists SkuGroups for the given parent.

Parameters
Name Description
request ListSkuGroupsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListSkuGroupsResponseSkuGroup

A pageable sequence of SkuGroup resources.

Overrides

ListSkuGroupsAsync(ListSkuGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSkuGroupsResponse, SkuGroup> ListSkuGroupsAsync(ListSkuGroupsRequest request, CallSettings callSettings = null)

Lists SkuGroups for the given parent.

Parameters
Name Description
request ListSkuGroupsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListSkuGroupsResponseSkuGroup

A pageable asynchronous sequence of SkuGroup resources.

Overrides

ListSkus(ListSkusRequest, CallSettings)

public override PagedEnumerable<ListSkusResponse, Sku> ListSkus(ListSkusRequest request, CallSettings callSettings = null)

Lists Skus for the given parent.

Parameters
Name Description
request ListSkusRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListSkusResponseSku

A pageable sequence of Sku resources.

Overrides

ListSkusAsync(ListSkusRequest, CallSettings)

public override PagedAsyncEnumerable<ListSkusResponse, Sku> ListSkusAsync(ListSkusRequest request, CallSettings callSettings = null)

Lists Skus for the given parent.

Parameters
Name Description
request ListSkusRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListSkusResponseSku

A pageable asynchronous sequence of Sku resources.

Overrides

ListStandardOffers(ListStandardOffersRequest, CallSettings)

public override PagedEnumerable<ListStandardOffersResponse, StandardOffer> ListStandardOffers(ListStandardOffersRequest request, CallSettings callSettings = null)

Lists StandardOffers for the given parent.

Parameters
Name Description
request ListStandardOffersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListStandardOffersResponseStandardOffer

A pageable sequence of StandardOffer resources.

Overrides

ListStandardOffersAsync(ListStandardOffersRequest, CallSettings)

public override PagedAsyncEnumerable<ListStandardOffersResponse, StandardOffer> ListStandardOffersAsync(ListStandardOffersRequest request, CallSettings callSettings = null)

Lists StandardOffers for the given parent.

Parameters
Name Description
request ListStandardOffersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListStandardOffersResponseStandardOffer

A pageable asynchronous sequence of StandardOffer resources.

Overrides

PublishPrivateOffer(PublishPrivateOfferRequest, CallSettings)

public override PrivateOffer PublishPrivateOffer(PublishPrivateOfferRequest request, CallSettings callSettings = null)

Publishes the target PrivateOffer.

Parameters
Name Description
request PublishPrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateOffer

The RPC response.

Overrides

PublishPrivateOfferAsync(PublishPrivateOfferRequest, CallSettings)

public override Task<PrivateOffer> PublishPrivateOfferAsync(PublishPrivateOfferRequest request, CallSettings callSettings = null)

Publishes the target PrivateOffer.

Parameters
Name Description
request PublishPrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPrivateOffer

A Task containing the RPC response.

Overrides

ResolveAmendmentTarget(ResolveAmendmentTargetRequest, CallSettings)

public override ResolveAmendmentTargetResponse ResolveAmendmentTarget(ResolveAmendmentTargetRequest request, CallSettings callSettings = null)

Resolves the existing offer that must be amended when creating a new PrivateOffer. Use this method to determine the correct amendment target before creating or publishing an offer.

Parameters
Name Description
request ResolveAmendmentTargetRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ResolveAmendmentTargetResponse

The RPC response.

Overrides

ResolveAmendmentTargetAsync(ResolveAmendmentTargetRequest, CallSettings)

public override Task<ResolveAmendmentTargetResponse> ResolveAmendmentTargetAsync(ResolveAmendmentTargetRequest request, CallSettings callSettings = null)

Resolves the existing offer that must be amended when creating a new PrivateOffer. Use this method to determine the correct amendment target before creating or publishing an offer.

Parameters
Name Description
request ResolveAmendmentTargetRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskResolveAmendmentTargetResponse

A Task containing the RPC response.

Overrides

UpdatePrivateOffer(UpdatePrivateOfferRequest, CallSettings)

public override PrivateOffer UpdatePrivateOffer(UpdatePrivateOfferRequest request, CallSettings callSettings = null)

Updates the target PrivateOffer.

Parameters
Name Description
request UpdatePrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateOffer

The RPC response.

Overrides

UpdatePrivateOfferAsync(UpdatePrivateOfferRequest, CallSettings)

public override Task<PrivateOffer> UpdatePrivateOfferAsync(UpdatePrivateOfferRequest request, CallSettings callSettings = null)

Updates the target PrivateOffer.

Parameters
Name Description
request UpdatePrivateOfferRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPrivateOffer

A Task containing the RPC response.

Overrides

UpdatePrivateOfferDocument(UpdatePrivateOfferDocumentRequest, CallSettings)

public override PrivateOfferDocument UpdatePrivateOfferDocument(UpdatePrivateOfferDocumentRequest request, CallSettings callSettings = null)

Updates the target PrivateOfferDocument.

Parameters
Name Description
request UpdatePrivateOfferDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PrivateOfferDocument

The RPC response.

Overrides

UpdatePrivateOfferDocumentAsync(UpdatePrivateOfferDocumentRequest, CallSettings)

public override Task<PrivateOfferDocument> UpdatePrivateOfferDocumentAsync(UpdatePrivateOfferDocumentRequest request, CallSettings callSettings = null)

Updates the target PrivateOfferDocument.

Parameters
Name Description
request UpdatePrivateOfferDocumentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPrivateOfferDocument

A Task containing the RPC response.

Overrides