Class ProductServiceClientImpl (1.4.0)

public sealed class ProductServiceClientImpl : ProductServiceClient

ProductService client wrapper implementation, for convenient use.

Inheritance

Object > ProductServiceClient > ProductServiceClientImpl

Inherited Members

ProductServiceClient.DefaultEndpoint

ProductServiceClient.DefaultScopes

ProductServiceClient.CreateAsync(CancellationToken)

ProductServiceClient.Create()

ProductServiceClient.ShutdownDefaultChannelsAsync()

ProductServiceClient.CreateProductAsync(CreateProductRequest, CancellationToken)

ProductServiceClient.CreateProduct(String, Product, String, CallSettings)

ProductServiceClient.CreateProductAsync(String, Product, String, CallSettings)

ProductServiceClient.CreateProductAsync(String, Product, String, CancellationToken)

ProductServiceClient.CreateProduct(BranchName, Product, String, CallSettings)

ProductServiceClient.CreateProductAsync(BranchName, Product, String, CallSettings)

ProductServiceClient.CreateProductAsync(BranchName, Product, String, CancellationToken)

ProductServiceClient.GetProductAsync(GetProductRequest, CancellationToken)

ProductServiceClient.GetProduct(String, CallSettings)

ProductServiceClient.GetProductAsync(String, CallSettings)

ProductServiceClient.GetProductAsync(String, CancellationToken)

ProductServiceClient.GetProduct(ProductName, CallSettings)

ProductServiceClient.GetProductAsync(ProductName, CallSettings)

ProductServiceClient.GetProductAsync(ProductName, CancellationToken)

ProductServiceClient.ListProducts(String, String, Nullable<Int32>, CallSettings)

ProductServiceClient.ListProductsAsync(String, String, Nullable<Int32>, CallSettings)

ProductServiceClient.ListProducts(BranchName, String, Nullable<Int32>, CallSettings)

ProductServiceClient.ListProductsAsync(BranchName, String, Nullable<Int32>, CallSettings)

ProductServiceClient.UpdateProductAsync(UpdateProductRequest, CancellationToken)

ProductServiceClient.UpdateProduct(Product, FieldMask, CallSettings)

ProductServiceClient.UpdateProductAsync(Product, FieldMask, CallSettings)

ProductServiceClient.UpdateProductAsync(Product, FieldMask, CancellationToken)

ProductServiceClient.DeleteProductAsync(DeleteProductRequest, CancellationToken)

ProductServiceClient.DeleteProduct(String, CallSettings)

ProductServiceClient.DeleteProductAsync(String, CallSettings)

ProductServiceClient.DeleteProductAsync(String, CancellationToken)

ProductServiceClient.DeleteProduct(ProductName, CallSettings)

ProductServiceClient.DeleteProductAsync(ProductName, CallSettings)

ProductServiceClient.DeleteProductAsync(ProductName, CancellationToken)

ProductServiceClient.ImportProductsAsync(ImportProductsRequest, CancellationToken)

ProductServiceClient.PollOnceImportProducts(String, CallSettings)

ProductServiceClient.PollOnceImportProductsAsync(String, CallSettings)

ProductServiceClient.SetInventoryAsync(SetInventoryRequest, CancellationToken)

ProductServiceClient.PollOnceSetInventory(String, CallSettings)

ProductServiceClient.PollOnceSetInventoryAsync(String, CallSettings)

ProductServiceClient.SetInventory(Product, FieldMask, CallSettings)

ProductServiceClient.SetInventoryAsync(Product, FieldMask, CallSettings)

ProductServiceClient.SetInventoryAsync(Product, FieldMask, CancellationToken)

ProductServiceClient.AddFulfillmentPlacesAsync(AddFulfillmentPlacesRequest, CancellationToken)

ProductServiceClient.PollOnceAddFulfillmentPlaces(String, CallSettings)

ProductServiceClient.PollOnceAddFulfillmentPlacesAsync(String, CallSettings)

ProductServiceClient.AddFulfillmentPlaces(String, CallSettings)

ProductServiceClient.AddFulfillmentPlacesAsync(String, CallSettings)

ProductServiceClient.AddFulfillmentPlacesAsync(String, CancellationToken)

ProductServiceClient.AddFulfillmentPlaces(ProductName, CallSettings)

ProductServiceClient.AddFulfillmentPlacesAsync(ProductName, CallSettings)

ProductServiceClient.AddFulfillmentPlacesAsync(ProductName, CancellationToken)

ProductServiceClient.RemoveFulfillmentPlacesAsync(RemoveFulfillmentPlacesRequest, CancellationToken)

ProductServiceClient.PollOnceRemoveFulfillmentPlaces(String, CallSettings)

ProductServiceClient.PollOnceRemoveFulfillmentPlacesAsync(String, CallSettings)

ProductServiceClient.RemoveFulfillmentPlaces(String, CallSettings)

ProductServiceClient.RemoveFulfillmentPlacesAsync(String, CallSettings)

ProductServiceClient.RemoveFulfillmentPlacesAsync(String, CancellationToken)

ProductServiceClient.RemoveFulfillmentPlaces(ProductName, CallSettings)

ProductServiceClient.RemoveFulfillmentPlacesAsync(ProductName, CallSettings)

ProductServiceClient.RemoveFulfillmentPlacesAsync(ProductName, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

Service for ingesting [Product][google.cloud.retail.v2.Product] information of the customer's website.

Constructors

ProductServiceClientImpl(ProductService.ProductServiceClient, ProductServiceSettings)

public ProductServiceClientImpl(ProductService.ProductServiceClient grpcClient, ProductServiceSettings settings)

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

Parameters
Name	Description
`grpcClient`	`ProductService.ProductServiceClient` The underlying gRPC client.
`settings`	`ProductServiceSettings` The base ProductServiceSettings used within this client.

Properties

AddFulfillmentPlacesOperationsClient

public override OperationsClient AddFulfillmentPlacesOperationsClient { get; }

The long-running operations client for AddFulfillmentPlaces.

Property Value
Type	Description
`OperationsClient`

Overrides

ProductServiceClient.AddFulfillmentPlacesOperationsClient

GrpcClient

public override ProductService.ProductServiceClient GrpcClient { get; }

The underlying gRPC ProductService client

Property Value
Type	Description
`ProductService.ProductServiceClient`

Overrides

ProductServiceClient.GrpcClient

ImportProductsOperationsClient

public override OperationsClient ImportProductsOperationsClient { get; }

The long-running operations client for ImportProducts.

Property Value
Type	Description
`OperationsClient`

Overrides

ProductServiceClient.ImportProductsOperationsClient

RemoveFulfillmentPlacesOperationsClient

public override OperationsClient RemoveFulfillmentPlacesOperationsClient { get; }

The long-running operations client for RemoveFulfillmentPlaces.

Property Value
Type	Description
`OperationsClient`

Overrides

ProductServiceClient.RemoveFulfillmentPlacesOperationsClient

SetInventoryOperationsClient

public override OperationsClient SetInventoryOperationsClient { get; }

The long-running operations client for SetInventory.

Property Value
Type	Description
`OperationsClient`

Overrides

ProductServiceClient.SetInventoryOperationsClient

Methods

AddFulfillmentPlaces(AddFulfillmentPlacesRequest, CallSettings)

public override Operation<AddFulfillmentPlacesResponse, AddFulfillmentPlacesMetadata> AddFulfillmentPlaces(AddFulfillmentPlacesRequest request, CallSettings callSettings = null)

Incrementally adds place IDs to [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`AddFulfillmentPlacesRequest` 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
`Operation<AddFulfillmentPlacesResponse, AddFulfillmentPlacesMetadata>`	The RPC response.

Overrides

ProductServiceClient.AddFulfillmentPlaces(AddFulfillmentPlacesRequest, CallSettings)

AddFulfillmentPlacesAsync(AddFulfillmentPlacesRequest, CallSettings)

public override Task<Operation<AddFulfillmentPlacesResponse, AddFulfillmentPlacesMetadata>> AddFulfillmentPlacesAsync(AddFulfillmentPlacesRequest request, CallSettings callSettings = null)

Incrementally adds place IDs to [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`AddFulfillmentPlacesRequest` 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<Operation<AddFulfillmentPlacesResponse, AddFulfillmentPlacesMetadata>>`	A Task containing the RPC response.

Overrides

ProductServiceClient.AddFulfillmentPlacesAsync(AddFulfillmentPlacesRequest, CallSettings)

CreateProduct(CreateProductRequest, CallSettings)

public override Product CreateProduct(CreateProductRequest request, CallSettings callSettings = null)

Creates a [Product][google.cloud.retail.v2.Product].

Parameters
Name	Description
`request`	`CreateProductRequest` 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
`Product`	The RPC response.

Overrides

ProductServiceClient.CreateProduct(CreateProductRequest, CallSettings)

CreateProductAsync(CreateProductRequest, CallSettings)

public override Task<Product> CreateProductAsync(CreateProductRequest request, CallSettings callSettings = null)

Creates a [Product][google.cloud.retail.v2.Product].

Parameters
Name	Description
`request`	`CreateProductRequest` 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<Product>`	A Task containing the RPC response.

Overrides

ProductServiceClient.CreateProductAsync(CreateProductRequest, CallSettings)

DeleteProduct(DeleteProductRequest, CallSettings)

public override void DeleteProduct(DeleteProductRequest request, CallSettings callSettings = null)

Deletes a [Product][google.cloud.retail.v2.Product].

Parameters
Name	Description
`request`	`DeleteProductRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

ProductServiceClient.DeleteProduct(DeleteProductRequest, CallSettings)

DeleteProductAsync(DeleteProductRequest, CallSettings)

public override Task DeleteProductAsync(DeleteProductRequest request, CallSettings callSettings = null)

Deletes a [Product][google.cloud.retail.v2.Product].

Parameters
Name	Description
`request`	`DeleteProductRequest` 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

ProductServiceClient.DeleteProductAsync(DeleteProductRequest, CallSettings)

GetProduct(GetProductRequest, CallSettings)

public override Product GetProduct(GetProductRequest request, CallSettings callSettings = null)

Gets a [Product][google.cloud.retail.v2.Product].

Parameters
Name	Description
`request`	`GetProductRequest` 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
`Product`	The RPC response.

Overrides

ProductServiceClient.GetProduct(GetProductRequest, CallSettings)

GetProductAsync(GetProductRequest, CallSettings)

public override Task<Product> GetProductAsync(GetProductRequest request, CallSettings callSettings = null)

Gets a [Product][google.cloud.retail.v2.Product].

Parameters
Name	Description
`request`	`GetProductRequest` 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<Product>`	A Task containing the RPC response.

Overrides

ProductServiceClient.GetProductAsync(GetProductRequest, CallSettings)

ImportProducts(ImportProductsRequest, CallSettings)

public override Operation<ImportProductsResponse, ImportMetadata> ImportProducts(ImportProductsRequest request, CallSettings callSettings = null)

Bulk import of multiple [Product][google.cloud.retail.v2.Product]s.

Request processing may be synchronous. No partial updating is supported. Non-existing items are created.

Note that it is possible for a subset of the [Product][google.cloud.retail.v2.Product]s to be successfully updated.

Parameters
Name	Description
`request`	`ImportProductsRequest` 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
`Operation<ImportProductsResponse, ImportMetadata>`	The RPC response.

Overrides

ProductServiceClient.ImportProducts(ImportProductsRequest, CallSettings)

ImportProductsAsync(ImportProductsRequest, CallSettings)

public override Task<Operation<ImportProductsResponse, ImportMetadata>> ImportProductsAsync(ImportProductsRequest request, CallSettings callSettings = null)

Bulk import of multiple [Product][google.cloud.retail.v2.Product]s.

Request processing may be synchronous. No partial updating is supported. Non-existing items are created.

Note that it is possible for a subset of the [Product][google.cloud.retail.v2.Product]s to be successfully updated.

Parameters
Name	Description
`request`	`ImportProductsRequest` 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<Operation<ImportProductsResponse, ImportMetadata>>`	A Task containing the RPC response.

Overrides

ProductServiceClient.ImportProductsAsync(ImportProductsRequest, CallSettings)

ListProducts(ListProductsRequest, CallSettings)

public override PagedEnumerable<ListProductsResponse, Product> ListProducts(ListProductsRequest request, CallSettings callSettings = null)

Gets a list of [Product][google.cloud.retail.v2.Product]s.

Parameters
Name	Description
`request`	`ListProductsRequest` 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
`PagedEnumerable<ListProductsResponse, Product>`	A pageable sequence of Product resources.

Overrides

ProductServiceClient.ListProducts(ListProductsRequest, CallSettings)

ListProductsAsync(ListProductsRequest, CallSettings)

public override PagedAsyncEnumerable<ListProductsResponse, Product> ListProductsAsync(ListProductsRequest request, CallSettings callSettings = null)

Gets a list of [Product][google.cloud.retail.v2.Product]s.

Parameters
Name	Description
`request`	`ListProductsRequest` 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
`PagedAsyncEnumerable<ListProductsResponse, Product>`	A pageable asynchronous sequence of Product resources.

Overrides

ProductServiceClient.ListProductsAsync(ListProductsRequest, CallSettings)

RemoveFulfillmentPlaces(RemoveFulfillmentPlacesRequest, CallSettings)

public override Operation<RemoveFulfillmentPlacesResponse, RemoveFulfillmentPlacesMetadata> RemoveFulfillmentPlaces(RemoveFulfillmentPlacesRequest request, CallSettings callSettings = null)

Incrementally removes place IDs from a [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`RemoveFulfillmentPlacesRequest` 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
`Operation<RemoveFulfillmentPlacesResponse, RemoveFulfillmentPlacesMetadata>`	The RPC response.

Overrides

ProductServiceClient.RemoveFulfillmentPlaces(RemoveFulfillmentPlacesRequest, CallSettings)

RemoveFulfillmentPlacesAsync(RemoveFulfillmentPlacesRequest, CallSettings)

public override Task<Operation<RemoveFulfillmentPlacesResponse, RemoveFulfillmentPlacesMetadata>> RemoveFulfillmentPlacesAsync(RemoveFulfillmentPlacesRequest request, CallSettings callSettings = null)

Incrementally removes place IDs from a [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`RemoveFulfillmentPlacesRequest` 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<Operation<RemoveFulfillmentPlacesResponse, RemoveFulfillmentPlacesMetadata>>`	A Task containing the RPC response.

Overrides

ProductServiceClient.RemoveFulfillmentPlacesAsync(RemoveFulfillmentPlacesRequest, CallSettings)

SetInventory(SetInventoryRequest, CallSettings)

public override Operation<SetInventoryResponse, SetInventoryMetadata> SetInventory(SetInventoryRequest request, CallSettings callSettings = null)

Updates inventory information for a [Product][google.cloud.retail.v2.Product] while respecting the last update timestamps of each inventory field.

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

When inventory is updated with [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct], the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] or [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] request.

If no inventory fields are set in [CreateProductRequest.product][google.cloud.retail.v2.CreateProductRequest.product], then any pre-existing inventory information for this product will be used.

If no inventory fields are set in [UpdateProductRequest.set_mask][], then any existing inventory information will be preserved.

Pre-existing inventory information can only be updated with [SetInventory][google.cloud.retail.v2.ProductService.SetInventory], [AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces], and [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`SetInventoryRequest` 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
`Operation<SetInventoryResponse, SetInventoryMetadata>`	The RPC response.

Overrides

ProductServiceClient.SetInventory(SetInventoryRequest, CallSettings)

SetInventoryAsync(SetInventoryRequest, CallSettings)

public override Task<Operation<SetInventoryResponse, SetInventoryMetadata>> SetInventoryAsync(SetInventoryRequest request, CallSettings callSettings = null)

Updates inventory information for a [Product][google.cloud.retail.v2.Product] while respecting the last update timestamps of each inventory field.

This process is asynchronous and does not require the [Product][google.cloud.retail.v2.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

If no inventory fields are set in [CreateProductRequest.product][google.cloud.retail.v2.CreateProductRequest.product], then any pre-existing inventory information for this product will be used.

If no inventory fields are set in [UpdateProductRequest.set_mask][], then any existing inventory information will be preserved.

This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.

Parameters
Name	Description
`request`	`SetInventoryRequest` 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<Operation<SetInventoryResponse, SetInventoryMetadata>>`	A Task containing the RPC response.

Overrides

ProductServiceClient.SetInventoryAsync(SetInventoryRequest, CallSettings)

UpdateProduct(UpdateProductRequest, CallSettings)

public override Product UpdateProduct(UpdateProductRequest request, CallSettings callSettings = null)

Updates a [Product][google.cloud.retail.v2.Product].

Parameters
Name	Description
`request`	`UpdateProductRequest` 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
`Product`	The RPC response.

Overrides

ProductServiceClient.UpdateProduct(UpdateProductRequest, CallSettings)

UpdateProductAsync(UpdateProductRequest, CallSettings)

public override Task<Product> UpdateProductAsync(UpdateProductRequest request, CallSettings callSettings = null)

Updates a [Product][google.cloud.retail.v2.Product].

Parameters
Name	Description
`request`	`UpdateProductRequest` 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<Product>`	A Task containing the RPC response.

Overrides

ProductServiceClient.UpdateProductAsync(UpdateProductRequest, CallSettings)