Class ProductServiceClient (1.0.0)

Version 1.0.0

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public abstract class ProductServiceClient

ProductService client wrapper, for convenient use.

Inheritance

System.Object > ProductServiceClient

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Derived Types

ProductServiceClientImpl

ProductServiceClientImpl

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.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ProductService service, which is a host of "retail.googleapis.com" and a port of 443.

Property Value
Type	Description
System.String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ProductService scopes.

Property Value
Type	Description
System.Collections.Generic.IReadOnlyList<System.String>

Remarks

The default ProductService scopes are:

• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual ProductService.ProductServiceClient GrpcClient { get; }

The underlying gRPC ProductService client

Property Value
Type	Description
ProductService.ProductServiceClient

ImportProductsOperationsClient

public virtual OperationsClient ImportProductsOperationsClient { get; }

The long-running operations client for ImportProducts.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Methods

Create()

public static ProductServiceClient Create()

Synchronously creates a ProductServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ProductServiceClientBuilder.

Returns
Type	Description
ProductServiceClient	The created ProductServiceClient.

CreateAsync(CancellationToken)

public static Task<ProductServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a ProductServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ProductServiceClientBuilder.

Parameter
Name	Description
cancellationToken	System.Threading.CancellationToken The System.Threading.CancellationToken to use while creating the client.

Returns
Type	Description
System.Threading.Tasks.Task<ProductServiceClient>	The task representing the created ProductServiceClient.

CreateProduct(BranchName, Product, String, CallSettings)

public virtual Product CreateProduct(BranchName parent, Product product, string productId, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	BranchName Required. The parent catalog resource name, such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch".
product	Product Required. The [Product][google.cloud.retail.v2.Product] to create.
productId	System.String Required. The ID to use for the [Product][google.cloud.retail.v2.Product], which will become the final component of the [Product.name][google.cloud.retail.v2.Product.name]. If the caller does not have permission to create the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all [Product][google.cloud.retail.v2.Product]s with the same [parent][google.cloud.retail.v2.CreateProductRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Product	The RPC response.

CreateProduct(CreateProductRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Product	The RPC response.

CreateProduct(String, Product, String, CallSettings)

public virtual Product CreateProduct(string parent, Product product, string productId, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	System.String Required. The parent catalog resource name, such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch".
product	Product Required. The [Product][google.cloud.retail.v2.Product] to create.
productId	System.String Required. The ID to use for the [Product][google.cloud.retail.v2.Product], which will become the final component of the [Product.name][google.cloud.retail.v2.Product.name]. If the caller does not have permission to create the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all [Product][google.cloud.retail.v2.Product]s with the same [parent][google.cloud.retail.v2.CreateProductRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Product	The RPC response.

CreateProductAsync(BranchName, Product, String, CallSettings)

public virtual Task<Product> CreateProductAsync(BranchName parent, Product product, string productId, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	BranchName Required. The parent catalog resource name, such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch".
product	Product Required. The [Product][google.cloud.retail.v2.Product] to create.
productId	System.String Required. The ID to use for the [Product][google.cloud.retail.v2.Product], which will become the final component of the [Product.name][google.cloud.retail.v2.Product.name]. If the caller does not have permission to create the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all [Product][google.cloud.retail.v2.Product]s with the same [parent][google.cloud.retail.v2.CreateProductRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

CreateProductAsync(BranchName, Product, String, CancellationToken)

public virtual Task<Product> CreateProductAsync(BranchName parent, Product product, string productId, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	BranchName Required. The parent catalog resource name, such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch".
product	Product Required. The [Product][google.cloud.retail.v2.Product] to create.
productId	System.String Required. The ID to use for the [Product][google.cloud.retail.v2.Product], which will become the final component of the [Product.name][google.cloud.retail.v2.Product.name]. If the caller does not have permission to create the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all [Product][google.cloud.retail.v2.Product]s with the same [parent][google.cloud.retail.v2.CreateProductRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

CreateProductAsync(CreateProductRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

CreateProductAsync(CreateProductRequest, CancellationToken)

public virtual Task<Product> CreateProductAsync(CreateProductRequest request, CancellationToken cancellationToken)

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.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

CreateProductAsync(String, Product, String, CallSettings)

public virtual Task<Product> CreateProductAsync(string parent, Product product, string productId, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	System.String Required. The parent catalog resource name, such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch".
product	Product Required. The [Product][google.cloud.retail.v2.Product] to create.
productId	System.String Required. The ID to use for the [Product][google.cloud.retail.v2.Product], which will become the final component of the [Product.name][google.cloud.retail.v2.Product.name]. If the caller does not have permission to create the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all [Product][google.cloud.retail.v2.Product]s with the same [parent][google.cloud.retail.v2.CreateProductRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

CreateProductAsync(String, Product, String, CancellationToken)

public virtual Task<Product> CreateProductAsync(string parent, Product product, string productId, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	System.String Required. The parent catalog resource name, such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch".
product	Product Required. The [Product][google.cloud.retail.v2.Product] to create.
productId	System.String Required. The ID to use for the [Product][google.cloud.retail.v2.Product], which will become the final component of the [Product.name][google.cloud.retail.v2.Product.name]. If the caller does not have permission to create the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all [Product][google.cloud.retail.v2.Product]s with the same [parent][google.cloud.retail.v2.CreateProductRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

DeleteProduct(DeleteProductRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

DeleteProduct(ProductName, CallSettings)

public virtual void DeleteProduct(ProductName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ProductName Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to delete the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Product][google.cloud.retail.v2.Product] to delete does not exist, a NOT_FOUND error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

DeleteProduct(String, CallSettings)

public virtual void DeleteProduct(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	System.String Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to delete the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Product][google.cloud.retail.v2.Product] to delete does not exist, a NOT_FOUND error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

DeleteProductAsync(DeleteProductRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteProductAsync(DeleteProductRequest, CancellationToken)

public virtual Task DeleteProductAsync(DeleteProductRequest request, CancellationToken cancellationToken)

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.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteProductAsync(ProductName, CallSettings)

public virtual Task DeleteProductAsync(ProductName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ProductName Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to delete the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Product][google.cloud.retail.v2.Product] to delete does not exist, a NOT_FOUND error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteProductAsync(ProductName, CancellationToken)

public virtual Task DeleteProductAsync(ProductName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	ProductName Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to delete the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Product][google.cloud.retail.v2.Product] to delete does not exist, a NOT_FOUND error is returned.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteProductAsync(String, CallSettings)

public virtual Task DeleteProductAsync(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	System.String Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to delete the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Product][google.cloud.retail.v2.Product] to delete does not exist, a NOT_FOUND error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

DeleteProductAsync(String, CancellationToken)

public virtual Task DeleteProductAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	System.String Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to delete the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Product][google.cloud.retail.v2.Product] to delete does not exist, a NOT_FOUND error is returned.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task	A Task containing the RPC response.

GetProduct(GetProductRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Product	The RPC response.

GetProduct(ProductName, CallSettings)

public virtual Product GetProduct(ProductName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ProductName Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to access the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Product	The RPC response.

GetProduct(String, CallSettings)

public virtual Product GetProduct(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	System.String Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to access the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Product	The RPC response.

GetProductAsync(GetProductRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

GetProductAsync(GetProductRequest, CancellationToken)

public virtual Task<Product> GetProductAsync(GetProductRequest request, CancellationToken cancellationToken)

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.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

GetProductAsync(ProductName, CallSettings)

public virtual Task<Product> GetProductAsync(ProductName name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	ProductName Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to access the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

GetProductAsync(ProductName, CancellationToken)

public virtual Task<Product> GetProductAsync(ProductName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	ProductName Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to access the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error is returned.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

GetProductAsync(String, CallSettings)

public virtual Task<Product> GetProductAsync(string name, CallSettings callSettings = null)

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

Parameters
Name	Description
name	System.String Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to access the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

GetProductAsync(String, CancellationToken)

public virtual Task<Product> GetProductAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	System.String Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". If the caller does not have permission to access the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested [Product][google.cloud.retail.v2.Product] does not exist, a NOT_FOUND error is returned.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

ImportProducts(ImportProductsRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<ImportProductsResponse, ImportMetadata>	The RPC response.

ImportProductsAsync(ImportProductsRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<ImportProductsResponse, ImportMetadata>>	A Task containing the RPC response.

ImportProductsAsync(ImportProductsRequest, CancellationToken)

public virtual Task<Operation<ImportProductsResponse, ImportMetadata>> ImportProductsAsync(ImportProductsRequest request, CancellationToken cancellationToken)

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.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<ImportProductsResponse, ImportMetadata>>	A Task containing the RPC response.

PollOnceImportProducts(String, CallSettings)

public virtual Operation<ImportProductsResponse, ImportMetadata> PollOnceImportProducts(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ImportProducts.

Parameters
Name	Description
operationName	System.String The name of a previously invoked operation. Must not be null or empty.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<ImportProductsResponse, ImportMetadata>	The result of polling the operation.

PollOnceImportProductsAsync(String, CallSettings)

public virtual Task<Operation<ImportProductsResponse, ImportMetadata>> PollOnceImportProductsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ImportProducts.

Parameters
Name	Description
operationName	System.String The name of a previously invoked operation. Must not be null or empty.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<ImportProductsResponse, ImportMetadata>>	A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
System.Threading.Tasks.Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateProduct(Product, FieldMask, CallSettings)

public virtual Product UpdateProduct(Product product, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name	Description
product	Product Required. The product to update/create. If the caller does not have permission to update the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Product][google.cloud.retail.v2.Product] to update does not exist, a NOT_FOUND error is returned.
updateMask	Google.Protobuf.WellKnownTypes.FieldMask Indicates which fields in the provided [Product][google.cloud.retail.v2.Product] to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Product	The RPC response.

UpdateProduct(UpdateProductRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Product	The RPC response.

UpdateProductAsync(Product, FieldMask, CallSettings)

public virtual Task<Product> UpdateProductAsync(Product product, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name	Description
product	Product Required. The product to update/create. If the caller does not have permission to update the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Product][google.cloud.retail.v2.Product] to update does not exist, a NOT_FOUND error is returned.
updateMask	Google.Protobuf.WellKnownTypes.FieldMask Indicates which fields in the provided [Product][google.cloud.retail.v2.Product] to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

UpdateProductAsync(Product, FieldMask, CancellationToken)

public virtual Task<Product> UpdateProductAsync(Product product, FieldMask updateMask, CancellationToken cancellationToken)

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

Parameters
Name	Description
product	Product Required. The product to update/create. If the caller does not have permission to update the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Product][google.cloud.retail.v2.Product] to update does not exist, a NOT_FOUND error is returned.
updateMask	Google.Protobuf.WellKnownTypes.FieldMask Indicates which fields in the provided [Product][google.cloud.retail.v2.Product] to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

UpdateProductAsync(UpdateProductRequest, CallSettings)

public virtual 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	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.

UpdateProductAsync(UpdateProductRequest, CancellationToken)

public virtual Task<Product> UpdateProductAsync(UpdateProductRequest request, CancellationToken cancellationToken)

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.
cancellationToken	System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
System.Threading.Tasks.Task<Product>	A Task containing the RPC response.