Class CatalogServiceClient (2.0.0)

public abstract class CatalogServiceClient

CatalogService client wrapper, for convenient use.

Inheritance

Object > CatalogServiceClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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
`String`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default CatalogService scopes.

Property Value
Type	Description
`IReadOnlyList<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`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

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`	`CancellationToken` The CancellationToken to use while creating the client.

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

GetDefaultBranch(CatalogName, CallSettings)

public virtual GetDefaultBranchResponse GetDefaultBranch(CatalogName catalog, 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
`catalog`	`CatalogName` The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`GetDefaultBranchResponse`	The RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
CatalogName catalog = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]");
// Make the request
GetDefaultBranchResponse response = catalogServiceClient.GetDefaultBranch(catalog);

GetDefaultBranch(GetDefaultBranchRequest, CallSettings)

public virtual 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.

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
GetDefaultBranchRequest request = new GetDefaultBranchRequest
{
    CatalogAsCatalogName = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
};
// Make the request
GetDefaultBranchResponse response = catalogServiceClient.GetDefaultBranch(request);

GetDefaultBranch(String, CallSettings)

public virtual GetDefaultBranchResponse GetDefaultBranch(string catalog, 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
`catalog`	`String` The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`GetDefaultBranchResponse`	The RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
string catalog = "projects/[PROJECT]/locations/[LOCATION]/catalogs/[CATALOG]";
// Make the request
GetDefaultBranchResponse response = catalogServiceClient.GetDefaultBranch(catalog);

GetDefaultBranchAsync(CatalogName, CallSettings)

public virtual Task<GetDefaultBranchResponse> GetDefaultBranchAsync(CatalogName catalog, 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
`catalog`	`CatalogName` The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<GetDefaultBranchResponse>`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
CatalogName catalog = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]");
// Make the request
GetDefaultBranchResponse response = await catalogServiceClient.GetDefaultBranchAsync(catalog);

GetDefaultBranchAsync(CatalogName, CancellationToken)

public virtual Task<GetDefaultBranchResponse> GetDefaultBranchAsync(CatalogName catalog, CancellationToken cancellationToken)

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
`catalog`	`CatalogName` The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<GetDefaultBranchResponse>`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
CatalogName catalog = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]");
// Make the request
GetDefaultBranchResponse response = await catalogServiceClient.GetDefaultBranchAsync(catalog);

GetDefaultBranchAsync(GetDefaultBranchRequest, CallSettings)

public virtual 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
`Task<GetDefaultBranchResponse>`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
GetDefaultBranchRequest request = new GetDefaultBranchRequest
{
    CatalogAsCatalogName = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
};
// Make the request
GetDefaultBranchResponse response = await catalogServiceClient.GetDefaultBranchAsync(request);

GetDefaultBranchAsync(GetDefaultBranchRequest, CancellationToken)

public virtual Task<GetDefaultBranchResponse> GetDefaultBranchAsync(GetDefaultBranchRequest request, CancellationToken cancellationToken)

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

Returns
Type	Description
`Task<GetDefaultBranchResponse>`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
GetDefaultBranchRequest request = new GetDefaultBranchRequest
{
    CatalogAsCatalogName = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
};
// Make the request
GetDefaultBranchResponse response = await catalogServiceClient.GetDefaultBranchAsync(request);

GetDefaultBranchAsync(String, CallSettings)

public virtual Task<GetDefaultBranchResponse> GetDefaultBranchAsync(string catalog, 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
`catalog`	`String` The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<GetDefaultBranchResponse>`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
string catalog = "projects/[PROJECT]/locations/[LOCATION]/catalogs/[CATALOG]";
// Make the request
GetDefaultBranchResponse response = await catalogServiceClient.GetDefaultBranchAsync(catalog);

GetDefaultBranchAsync(String, CancellationToken)

public virtual Task<GetDefaultBranchResponse> GetDefaultBranchAsync(string catalog, CancellationToken cancellationToken)

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
`catalog`	`String` The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<GetDefaultBranchResponse>`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
string catalog = "projects/[PROJECT]/locations/[LOCATION]/catalogs/[CATALOG]";
// Make the request
GetDefaultBranchResponse response = await catalogServiceClient.GetDefaultBranchAsync(catalog);

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

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

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

Parameters
Name	Description
`parent`	`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`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<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`	`CallSettings` If not null, applies overrides to this RPC call.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListCatalogsResponse, Catalog> response = catalogServiceClient.ListCatalogs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Catalog item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCatalogsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Catalog item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Catalog> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Catalog item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`CallSettings` If not null, applies overrides to this RPC call.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
ListCatalogsRequest request = new ListCatalogsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListCatalogsResponse, Catalog> response = catalogServiceClient.ListCatalogs(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Catalog item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCatalogsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Catalog item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Catalog> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Catalog item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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

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

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

Parameters
Name	Description
`parent`	`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`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<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`	`CallSettings` If not null, applies overrides to this RPC call.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListCatalogsResponse, Catalog> response = catalogServiceClient.ListCatalogs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Catalog item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCatalogsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Catalog item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Catalog> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Catalog item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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

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

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

Parameters
Name	Description
`parent`	`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`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<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`	`CallSettings` If not null, applies overrides to this RPC call.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListCatalogsResponse, Catalog> response = catalogServiceClient.ListCatalogsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Catalog item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCatalogsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Catalog item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Catalog> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Catalog item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`CallSettings` If not null, applies overrides to this RPC call.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
ListCatalogsRequest request = new ListCatalogsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListCatalogsResponse, Catalog> response = catalogServiceClient.ListCatalogsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Catalog item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCatalogsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Catalog item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Catalog> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Catalog item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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

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

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

Parameters
Name	Description
`parent`	`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`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<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`	`CallSettings` If not null, applies overrides to this RPC call.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListCatalogsResponse, Catalog> response = catalogServiceClient.ListCatalogsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Catalog item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCatalogsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Catalog item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Catalog> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Catalog item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SetDefaultBranch(CatalogName, CallSettings)

public virtual void SetDefaultBranch(CatalogName catalog, CallSettings callSettings = null)

Set a specified branch id as default branch. API methods such as [SearchService.Search][google.cloud.retail.v2.SearchService.Search], [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct], [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] will treat requests using "default_branch" to the actual branch id set as default.

For example, if projects/*/locations/*/catalogs/*/branches/1 is set as default, setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to projects/*/locations/*/catalogs/*/branches/default_branch is equivalent to setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to projects/*/locations/*/catalogs/*/branches/1.

Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using projects/*/locations/*/catalogs/*/branches/default_branch as [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to route the traffic to this staging branch.

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

Parameters
Name	Description
`catalog`	`CatalogName` Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
CatalogName catalog = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]");
// Make the request
catalogServiceClient.SetDefaultBranch(catalog);

SetDefaultBranch(SetDefaultBranchRequest, CallSettings)

public virtual void SetDefaultBranch(SetDefaultBranchRequest request, CallSettings callSettings = null)

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
SetDefaultBranchRequest request = new SetDefaultBranchRequest
{
    CatalogAsCatalogName = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
    BranchIdAsBranchName = BranchName.FromProjectLocationCatalogBranch("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]"),
    Note = "",
    Force = false,
};
// Make the request
catalogServiceClient.SetDefaultBranch(request);

SetDefaultBranch(String, CallSettings)

public virtual void SetDefaultBranch(string catalog, CallSettings callSettings = null)

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

Parameters
Name	Description
`catalog`	`String` Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
string catalog = "projects/[PROJECT]/locations/[LOCATION]/catalogs/[CATALOG]";
// Make the request
catalogServiceClient.SetDefaultBranch(catalog);

SetDefaultBranchAsync(CatalogName, CallSettings)

public virtual Task SetDefaultBranchAsync(CatalogName catalog, CallSettings callSettings = null)

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

Parameters
Name	Description
`catalog`	`CatalogName` Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
CatalogName catalog = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]");
// Make the request
await catalogServiceClient.SetDefaultBranchAsync(catalog);

SetDefaultBranchAsync(CatalogName, CancellationToken)

public virtual Task SetDefaultBranchAsync(CatalogName catalog, CancellationToken cancellationToken)

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

Parameters
Name	Description
`catalog`	`CatalogName` Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
CatalogName catalog = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]");
// Make the request
await catalogServiceClient.SetDefaultBranchAsync(catalog);

SetDefaultBranchAsync(SetDefaultBranchRequest, CallSettings)

public virtual Task SetDefaultBranchAsync(SetDefaultBranchRequest request, CallSettings callSettings = null)

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
SetDefaultBranchRequest request = new SetDefaultBranchRequest
{
    CatalogAsCatalogName = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
    BranchIdAsBranchName = BranchName.FromProjectLocationCatalogBranch("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]"),
    Note = "",
    Force = false,
};
// Make the request
await catalogServiceClient.SetDefaultBranchAsync(request);

SetDefaultBranchAsync(SetDefaultBranchRequest, CancellationToken)

public virtual Task SetDefaultBranchAsync(SetDefaultBranchRequest request, CancellationToken cancellationToken)

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

Parameters
Name	Description
`request`	`SetDefaultBranchRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
SetDefaultBranchRequest request = new SetDefaultBranchRequest
{
    CatalogAsCatalogName = CatalogName.FromProjectLocationCatalog("[PROJECT]", "[LOCATION]", "[CATALOG]"),
    BranchIdAsBranchName = BranchName.FromProjectLocationCatalogBranch("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]"),
    Note = "",
    Force = false,
};
// Make the request
await catalogServiceClient.SetDefaultBranchAsync(request);

SetDefaultBranchAsync(String, CallSettings)

public virtual Task SetDefaultBranchAsync(string catalog, CallSettings callSettings = null)

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

Parameters
Name	Description
`catalog`	`String` Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
string catalog = "projects/[PROJECT]/locations/[LOCATION]/catalogs/[CATALOG]";
// Make the request
await catalogServiceClient.SetDefaultBranchAsync(catalog);

SetDefaultBranchAsync(String, CancellationToken)

public virtual Task SetDefaultBranchAsync(string catalog, CancellationToken cancellationToken)

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

PredictionService will only return product IDs from branch {newBranch}.
SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
UserEventService will only join events with products from branch {newBranch}.

Parameters
Name	Description
`catalog`	`String` Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
string catalog = "projects/[PROJECT]/locations/[LOCATION]/catalogs/[CATALOG]";
// Make the request
await catalogServiceClient.SetDefaultBranchAsync(catalog);

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
`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.

UpdateCatalog(Catalog, FieldMask, CallSettings)

public virtual Catalog UpdateCatalog(Catalog catalog, FieldMask updateMask, CallSettings callSettings = null)

Updates the [Catalog][google.cloud.retail.v2.Catalog]s.

Parameters
Name	Description
`catalog`	`Catalog` Required. The [Catalog][google.cloud.retail.v2.Catalog] to update. If the caller does not have permission to update the [Catalog][google.cloud.retail.v2.Catalog], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Catalog][google.cloud.retail.v2.Catalog] to update does not exist, a NOT_FOUND error is returned.
`updateMask`	`FieldMask` Indicates which fields in the provided [Catalog][google.cloud.retail.v2.Catalog] to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Catalog`	The RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
Catalog catalog = new Catalog();
FieldMask updateMask = new FieldMask();
// Make the request
Catalog response = catalogServiceClient.UpdateCatalog(catalog, updateMask);

UpdateCatalog(UpdateCatalogRequest, CallSettings)

public virtual Catalog UpdateCatalog(UpdateCatalogRequest request, CallSettings callSettings = null)

Updates the [Catalog][google.cloud.retail.v2.Catalog]s.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
// Initialize request argument(s)
UpdateCatalogRequest request = new UpdateCatalogRequest
{
    Catalog = new Catalog(),
    UpdateMask = new FieldMask(),
};
// Make the request
Catalog response = catalogServiceClient.UpdateCatalog(request);

UpdateCatalogAsync(Catalog, FieldMask, CallSettings)

public virtual Task<Catalog> UpdateCatalogAsync(Catalog catalog, FieldMask updateMask, CallSettings callSettings = null)

Updates the [Catalog][google.cloud.retail.v2.Catalog]s.

Parameters
Name	Description
`catalog`	`Catalog` Required. The [Catalog][google.cloud.retail.v2.Catalog] to update. If the caller does not have permission to update the [Catalog][google.cloud.retail.v2.Catalog], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Catalog][google.cloud.retail.v2.Catalog] to update does not exist, a NOT_FOUND error is returned.
`updateMask`	`FieldMask` Indicates which fields in the provided [Catalog][google.cloud.retail.v2.Catalog] to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Catalog>`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
Catalog catalog = new Catalog();
FieldMask updateMask = new FieldMask();
// Make the request
Catalog response = await catalogServiceClient.UpdateCatalogAsync(catalog, updateMask);

UpdateCatalogAsync(Catalog, FieldMask, CancellationToken)

public virtual Task<Catalog> UpdateCatalogAsync(Catalog catalog, FieldMask updateMask, CancellationToken cancellationToken)

Updates the [Catalog][google.cloud.retail.v2.Catalog]s.

Parameters
Name	Description
`catalog`	`Catalog` Required. The [Catalog][google.cloud.retail.v2.Catalog] to update. If the caller does not have permission to update the [Catalog][google.cloud.retail.v2.Catalog], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the [Catalog][google.cloud.retail.v2.Catalog] to update does not exist, a NOT_FOUND error is returned.
`updateMask`	`FieldMask` Indicates which fields in the provided [Catalog][google.cloud.retail.v2.Catalog] to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Catalog>`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
Catalog catalog = new Catalog();
FieldMask updateMask = new FieldMask();
// Make the request
Catalog response = await catalogServiceClient.UpdateCatalogAsync(catalog, updateMask);

UpdateCatalogAsync(UpdateCatalogRequest, CallSettings)

public virtual Task<Catalog> UpdateCatalogAsync(UpdateCatalogRequest request, CallSettings callSettings = null)

Updates the [Catalog][google.cloud.retail.v2.Catalog]s.

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

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCatalogRequest request = new UpdateCatalogRequest
{
    Catalog = new Catalog(),
    UpdateMask = new FieldMask(),
};
// Make the request
Catalog response = await catalogServiceClient.UpdateCatalogAsync(request);

UpdateCatalogAsync(UpdateCatalogRequest, CancellationToken)

public virtual Task<Catalog> UpdateCatalogAsync(UpdateCatalogRequest request, CancellationToken cancellationToken)

Updates the [Catalog][google.cloud.retail.v2.Catalog]s.

Parameters
Name	Description
`request`	`UpdateCatalogRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Catalog>`	A Task containing the RPC response.

Example

// Create client
CatalogServiceClient catalogServiceClient = await CatalogServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCatalogRequest request = new UpdateCatalogRequest
{
    Catalog = new Catalog(),
    UpdateMask = new FieldMask(),
};
// Make the request
Catalog response = await catalogServiceClient.UpdateCatalogAsync(request);