Retail v2 API - Class CatalogServiceClientImpl (2.5.0)

public sealed class CatalogServiceClientImpl : CatalogServiceClient

Reference documentation and code samples for the Retail v2 API class CatalogServiceClientImpl.

CatalogService client wrapper implementation, for convenient use.

Inheritance

object > CatalogServiceClient > CatalogServiceClientImpl

Inherited Members

CatalogServiceClient.DefaultEndpoint

CatalogServiceClient.DefaultScopes

CatalogServiceClient.ServiceMetadata

CatalogServiceClient.CreateAsync(CancellationToken)

CatalogServiceClient.Create()

CatalogServiceClient.ShutdownDefaultChannelsAsync()

CatalogServiceClient.ListCatalogs(string, string, int?, CallSettings)

CatalogServiceClient.ListCatalogsAsync(string, string, int?, CallSettings)

CatalogServiceClient.ListCatalogs(LocationName, string, int?, CallSettings)

CatalogServiceClient.ListCatalogsAsync(LocationName, string, int?, CallSettings)

CatalogServiceClient.UpdateCatalogAsync(UpdateCatalogRequest, CancellationToken)

CatalogServiceClient.UpdateCatalog(Catalog, FieldMask, CallSettings)

CatalogServiceClient.UpdateCatalogAsync(Catalog, FieldMask, CallSettings)

CatalogServiceClient.UpdateCatalogAsync(Catalog, FieldMask, CancellationToken)

CatalogServiceClient.SetDefaultBranchAsync(SetDefaultBranchRequest, CancellationToken)

CatalogServiceClient.SetDefaultBranch(string, CallSettings)

CatalogServiceClient.SetDefaultBranchAsync(string, CallSettings)

CatalogServiceClient.SetDefaultBranchAsync(string, CancellationToken)

CatalogServiceClient.SetDefaultBranch(CatalogName, CallSettings)

CatalogServiceClient.SetDefaultBranchAsync(CatalogName, CallSettings)

CatalogServiceClient.SetDefaultBranchAsync(CatalogName, CancellationToken)

CatalogServiceClient.GetDefaultBranchAsync(GetDefaultBranchRequest, CancellationToken)

CatalogServiceClient.GetDefaultBranch(string, CallSettings)

CatalogServiceClient.GetDefaultBranchAsync(string, CallSettings)

CatalogServiceClient.GetDefaultBranchAsync(string, CancellationToken)

CatalogServiceClient.GetDefaultBranch(CatalogName, CallSettings)

CatalogServiceClient.GetDefaultBranchAsync(CatalogName, CallSettings)

CatalogServiceClient.GetDefaultBranchAsync(CatalogName, CancellationToken)

CatalogServiceClient.GetCompletionConfigAsync(GetCompletionConfigRequest, CancellationToken)

CatalogServiceClient.GetCompletionConfig(string, CallSettings)

CatalogServiceClient.GetCompletionConfigAsync(string, CallSettings)

CatalogServiceClient.GetCompletionConfigAsync(string, CancellationToken)

CatalogServiceClient.GetCompletionConfig(CompletionConfigName, CallSettings)

CatalogServiceClient.GetCompletionConfigAsync(CompletionConfigName, CallSettings)

CatalogServiceClient.GetCompletionConfigAsync(CompletionConfigName, CancellationToken)

CatalogServiceClient.UpdateCompletionConfigAsync(UpdateCompletionConfigRequest, CancellationToken)

CatalogServiceClient.UpdateCompletionConfig(CompletionConfig, FieldMask, CallSettings)

CatalogServiceClient.UpdateCompletionConfigAsync(CompletionConfig, FieldMask, CallSettings)

CatalogServiceClient.UpdateCompletionConfigAsync(CompletionConfig, FieldMask, CancellationToken)

CatalogServiceClient.GetAttributesConfigAsync(GetAttributesConfigRequest, CancellationToken)

CatalogServiceClient.GetAttributesConfig(string, CallSettings)

CatalogServiceClient.GetAttributesConfigAsync(string, CallSettings)

CatalogServiceClient.GetAttributesConfigAsync(string, CancellationToken)

CatalogServiceClient.GetAttributesConfig(AttributesConfigName, CallSettings)

CatalogServiceClient.GetAttributesConfigAsync(AttributesConfigName, CallSettings)

CatalogServiceClient.GetAttributesConfigAsync(AttributesConfigName, CancellationToken)

CatalogServiceClient.UpdateAttributesConfigAsync(UpdateAttributesConfigRequest, CancellationToken)

CatalogServiceClient.UpdateAttributesConfig(AttributesConfig, FieldMask, CallSettings)

CatalogServiceClient.UpdateAttributesConfigAsync(AttributesConfig, FieldMask, CallSettings)

CatalogServiceClient.UpdateAttributesConfigAsync(AttributesConfig, FieldMask, CancellationToken)

CatalogServiceClient.AddCatalogAttributeAsync(AddCatalogAttributeRequest, CancellationToken)

CatalogServiceClient.RemoveCatalogAttributeAsync(RemoveCatalogAttributeRequest, CancellationToken)

CatalogServiceClient.ReplaceCatalogAttributeAsync(ReplaceCatalogAttributeRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.RetailV2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

Service for managing catalog configuration.

Constructors

CatalogServiceClientImpl(CatalogServiceClient, CatalogServiceSettings, ILogger)

public CatalogServiceClientImpl(CatalogService.CatalogServiceClient grpcClient, CatalogServiceSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	CatalogServiceCatalogServiceClient The underlying gRPC client.
settings	CatalogServiceSettings The base CatalogServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override CatalogService.CatalogServiceClient GrpcClient { get; }

The underlying gRPC CatalogService client

Property Value
Type	Description
CatalogServiceCatalogServiceClient

Overrides

CatalogServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

CatalogServiceClient.LocationsClient

Methods

AddCatalogAttribute(AddCatalogAttributeRequest, CallSettings)

public override AttributesConfig AddCatalogAttribute(AddCatalogAttributeRequest request, CallSettings callSettings = null)

Adds the specified [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to the [AttributesConfig][google.cloud.retail.v2.AttributesConfig].

If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to add already exists, an ALREADY_EXISTS error is returned.

Parameters
Name	Description
request	AddCatalogAttributeRequest 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
AttributesConfig	The RPC response.

Overrides

CatalogServiceClient.AddCatalogAttribute(AddCatalogAttributeRequest, CallSettings)

AddCatalogAttributeAsync(AddCatalogAttributeRequest, CallSettings)

public override Task<AttributesConfig> AddCatalogAttributeAsync(AddCatalogAttributeRequest request, CallSettings callSettings = null)

Adds the specified [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to the [AttributesConfig][google.cloud.retail.v2.AttributesConfig].

If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to add already exists, an ALREADY_EXISTS error is returned.

Parameters
Name	Description
request	AddCatalogAttributeRequest 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
TaskAttributesConfig	A Task containing the RPC response.

Overrides

CatalogServiceClient.AddCatalogAttributeAsync(AddCatalogAttributeRequest, CallSettings)

GetAttributesConfig(GetAttributesConfigRequest, CallSettings)

public override AttributesConfig GetAttributesConfig(GetAttributesConfigRequest request, CallSettings callSettings = null)

Gets an [AttributesConfig][google.cloud.retail.v2.AttributesConfig].

Parameters
Name	Description
request	GetAttributesConfigRequest 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
AttributesConfig	The RPC response.

Overrides

CatalogServiceClient.GetAttributesConfig(GetAttributesConfigRequest, CallSettings)

GetAttributesConfigAsync(GetAttributesConfigRequest, CallSettings)

public override Task<AttributesConfig> GetAttributesConfigAsync(GetAttributesConfigRequest request, CallSettings callSettings = null)

Gets an [AttributesConfig][google.cloud.retail.v2.AttributesConfig].

Parameters
Name	Description
request	GetAttributesConfigRequest 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
TaskAttributesConfig	A Task containing the RPC response.

Overrides

CatalogServiceClient.GetAttributesConfigAsync(GetAttributesConfigRequest, CallSettings)

GetCompletionConfig(GetCompletionConfigRequest, CallSettings)

public override CompletionConfig GetCompletionConfig(GetCompletionConfigRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetCompletionConfigRequest 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
CompletionConfig	The RPC response.

Overrides

CatalogServiceClient.GetCompletionConfig(GetCompletionConfigRequest, CallSettings)

GetCompletionConfigAsync(GetCompletionConfigRequest, CallSettings)

public override Task<CompletionConfig> GetCompletionConfigAsync(GetCompletionConfigRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetCompletionConfigRequest 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
TaskCompletionConfig	A Task containing the RPC response.

Overrides

CatalogServiceClient.GetCompletionConfigAsync(GetCompletionConfigRequest, CallSettings)

GetDefaultBranch(GetDefaultBranchRequest, CallSettings)

public override GetDefaultBranchResponse GetDefaultBranch(GetDefaultBranchRequest request, CallSettings callSettings = null)

Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch] method under a specified parent catalog.

Parameters
Name	Description
request	GetDefaultBranchRequest 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
GetDefaultBranchResponse	The RPC response.

Overrides

CatalogServiceClient.GetDefaultBranch(GetDefaultBranchRequest, CallSettings)

GetDefaultBranchAsync(GetDefaultBranchRequest, CallSettings)

public override Task<GetDefaultBranchResponse> GetDefaultBranchAsync(GetDefaultBranchRequest request, CallSettings callSettings = null)

Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch] method under a specified parent catalog.

Parameters
Name	Description
request	GetDefaultBranchRequest 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
TaskGetDefaultBranchResponse	A Task containing the RPC response.

Overrides

CatalogServiceClient.GetDefaultBranchAsync(GetDefaultBranchRequest, CallSettings)

ListCatalogs(ListCatalogsRequest, CallSettings)

public override PagedEnumerable<ListCatalogsResponse, Catalog> ListCatalogs(ListCatalogsRequest request, CallSettings callSettings = null)

Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.

Parameters
Name	Description
request	ListCatalogsRequest 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
PagedEnumerableListCatalogsResponseCatalog	A pageable sequence of Catalog resources.

Overrides

CatalogServiceClient.ListCatalogs(ListCatalogsRequest, CallSettings)

ListCatalogsAsync(ListCatalogsRequest, CallSettings)

public override PagedAsyncEnumerable<ListCatalogsResponse, Catalog> ListCatalogsAsync(ListCatalogsRequest request, CallSettings callSettings = null)

Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.

Parameters
Name	Description
request	ListCatalogsRequest 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
PagedAsyncEnumerableListCatalogsResponseCatalog	A pageable asynchronous sequence of Catalog resources.

Overrides

CatalogServiceClient.ListCatalogsAsync(ListCatalogsRequest, CallSettings)

RemoveCatalogAttribute(RemoveCatalogAttributeRequest, CallSettings)

public override AttributesConfig RemoveCatalogAttribute(RemoveCatalogAttributeRequest request, CallSettings callSettings = null)

Removes the specified [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] from the [AttributesConfig][google.cloud.retail.v2.AttributesConfig].

If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to remove does not exist, a NOT_FOUND error is returned.

Parameters
Name	Description
request	RemoveCatalogAttributeRequest 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
AttributesConfig	The RPC response.

Overrides

CatalogServiceClient.RemoveCatalogAttribute(RemoveCatalogAttributeRequest, CallSettings)

RemoveCatalogAttributeAsync(RemoveCatalogAttributeRequest, CallSettings)

public override Task<AttributesConfig> RemoveCatalogAttributeAsync(RemoveCatalogAttributeRequest request, CallSettings callSettings = null)

Removes the specified [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] from the [AttributesConfig][google.cloud.retail.v2.AttributesConfig].

If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to remove does not exi