Retail v2 API - Class CatalogServiceClient (2.6.0)

public abstract class CatalogServiceClient

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

CatalogService client wrapper, for convenient use.

Inheritance

object > CatalogServiceClient

Derived Types

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

Service for managing catalog configuration.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default CatalogService scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

The default CatalogService scopes are:

GrpcClient

public virtual CatalogService.CatalogServiceClient GrpcClient { get; }

The underlying gRPC CatalogService client

Property Value
TypeDescription
CatalogServiceCatalogServiceClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

AddCatalogAttribute(AddCatalogAttributeRequest, CallSettings)

public virtual 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
NameDescription
requestAddCatalogAttributeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttributesConfig

The RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
AddCatalogAttributeRequest request = new AddCatalogAttributeRequest
{
    AttributesConfigAsAttributesConfigName = AttributesConfigName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
    CatalogAttribute = new CatalogAttribute(),
};
// Make the request
AttributesConfig response = catalogServiceClient.AddCatalogAttribute(request);

AddCatalogAttributeAsync(AddCatalogAttributeRequest, CallSettings)

public virtual 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
NameDescription
requestAddCatalogAttributeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAttributesConfig

A Task containing the RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
AddCatalogAttributeRequest request = new AddCatalogAttributeRequest
{
    AttributesConfigAsAttributesConfigName = AttributesConfigName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
    CatalogAttribute = new CatalogAttribute(),
};
// Make the request
AttributesConfig response = await catalogServiceClient.AddCatalogAttributeAsync(request);

AddCatalogAttributeAsync(AddCatalogAttributeRequest, CancellationToken)

public virtual Task<AttributesConfig> AddCatalogAttributeAsync(AddCatalogAttributeRequest request, CancellationToken cancellationToken)

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
NameDescription
requestAddCatalogAttributeRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAttributesConfig

A Task containing the RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
AddCatalogAttributeRequest request = new AddCatalogAttributeRequest
{
    AttributesConfigAsAttributesConfigName = AttributesConfigName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
    CatalogAttribute = new CatalogAttribute(),
};
// Make the request
AttributesConfig response = await catalogServiceClient.AddCatalogAttributeAsync(request);

Create()

public static CatalogServiceClient Create()

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

Returns
TypeDescription
CatalogServiceClient

The created CatalogServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskCatalogServiceClient

The task representing the created CatalogServiceClient.

GetAttributesConfig(AttributesConfigName, CallSettings)

public virtual AttributesConfig GetAttributesConfig(AttributesConfigName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameAttributesConfigName

Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttributesConfig

The RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
AttributesConfigName name = AttributesConfigName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]");
// Make the request
AttributesConfig response = catalogServiceClient.GetAttributesConfig(name);

GetAttributesConfig(GetAttributesConfigRequest, CallSettings)

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

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

Parameters
NameDescription
requestGetAttributesConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttributesConfig

The RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
GetAttributesConfigRequest request = new GetAttributesConfigRequest
{
    AttributesConfigName = AttributesConfigName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
};
// Make the request
AttributesConfig response = catalogServiceClient.GetAttributesConfig(request);

GetAttributesConfig(string, CallSettings)

public virtual AttributesConfig GetAttributesConfig(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
namestring

Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttributesConfig

The RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/catalogs/[CATALOG]/attributesConfig";
// Make the request
AttributesConfig response = catalogServiceClient.GetAttributesConfig(name);

GetAttributesConfigAsync(AttributesConfigName, CallSettings)

public virtual Task<AttributesConfig> GetAttributesConfigAsync(AttributesConfigName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameAttributesConfigName

Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAttributesConfig

A Task containing the RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
AttributesConfigName name = AttributesConfigName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]");
// Make the request
AttributesConfig response = await catalogServiceClient.GetAttributesConfigAsync(name);

GetAttributesConfigAsync(AttributesConfigName, CancellationToken)

public virtual Task<AttributesConfig> GetAttributesConfigAsync(AttributesConfigName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameAttributesConfigName

Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAttributesConfig

A Task containing the RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
AttributesConfigName name = AttributesConfigName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]");
// Make the request
AttributesConfig response = await catalogServiceClient.GetAttributesConfigAsync(name);

GetAttributesConfigAsync(GetAttributesConfigRequest, CallSettings)

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

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

Parameters
NameDescription
requestGetAttributesConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAttributesConfig

A Task containing the RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
GetAttributesConfigRequest request = new GetAttributesConfigRequest
{
    AttributesConfigName = AttributesConfigName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
};
// Make the request
AttributesConfig response = await catalogServiceClient.GetAttributesConfigAsync(request);

GetAttributesConfigAsync(GetAttributesConfigRequest, CancellationToken)

public virtual Task<AttributesConfig> GetAttributesConfigAsync(GetAttributesConfigRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestGetAttributesConfigRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAttributesConfig

A Task containing the RPC response.

Example
// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
GetAttributesConfigRequest request = new GetAttributesConfigRequest
{
    AttributesConfigName = AttributesConfigName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
};
// Make the request
AttributesConfig response = await catalogServiceClient.GetAttributesConfigAsync(request);

GetAttributesConfigAsync(string, CallSettings)

public virtual Task<AttributesConfig> GetAttributesConfigAsync(string name, CallSettings callSettings = null)