Class CatalogServiceClient (1.0.0)

public abstract class CatalogServiceClient

CatalogService client wrapper, for convenient use.

Inheritance

System.Object > CatalogServiceClient

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Derived Types

CatalogServiceClientImpl

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
Type	Description
`System.String`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default CatalogService scopes.

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

Remarks

The default CatalogService scopes are:

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

GrpcClient

public virtual CatalogService.CatalogServiceClient GrpcClient { get; }

The underlying gRPC CatalogService client

Property Value
Type	Description
`CatalogService.CatalogServiceClient`

Methods

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
Type	Description
`CatalogServiceClient`	The created CatalogServiceClient.

CreateAsync(CancellationToken)

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

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

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

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

ListCatalogs(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListCatalogsResponse, Catalog> ListCatalogs(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name	Description
`parent`	`Google.Api.Gax.ResourceNames.LocationName` Required. The account resource name with an associated location. If the caller does not have permission to list [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
`pageToken`	`System.String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`System.Nullable<System.Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedEnumerable<ListCatalogsResponse, Catalog>`	A pageable sequence of Catalog resources.

ListCatalogs(ListCatalogsRequest, CallSettings)

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

Returns
Type	Description
`Google.Api.Gax.PagedEnumerable<ListCatalogsResponse, Catalog>`	A pageable sequence of Catalog resources.

ListCatalogs(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListCatalogsResponse, Catalog> ListCatalogs(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name	Description
`parent`	`System.String` Required. The account resource name with an associated location. If the caller does not have permission to list [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
`pageToken`	`System.String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`System.Nullable<System.Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedEnumerable<ListCatalogsResponse, Catalog>`	A pageable sequence of Catalog resources.

ListCatalogsAsync(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListCatalogsResponse, Catalog> ListCatalogsAsync(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name	Description
`parent`	`Google.Api.Gax.ResourceNames.LocationName` Required. The account resource name with an associated location. If the caller does not have permission to list [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
`pageToken`	`System.String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`System.Nullable<System.Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedAsyncEnumerable<ListCatalogsResponse, Catalog>`	A pageable asynchronous sequence of Catalog resources.

ListCatalogsAsync(ListCatalogsRequest, CallSettings)

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

Returns
Type	Description
`Google.Api.Gax.PagedAsyncEnumerable<ListCatalogsResponse, Catalog>`	A pageable asynchronous sequence of Catalog resources.

ListCatalogsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListCatalogsResponse, Catalog> ListCatalogsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name	Description
`parent`	`System.String` Required. The account resource name with an associated location. If the caller does not have permission to list [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
`pageToken`	`System.String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`System.Nullable<System.Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedAsyncEnumerable<ListCatalogsResponse, Catalog>`	A pageable asynchronous sequence of Catalog resources.

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.