Class AggregateProductStatusesServiceClient

AggregateProductStatusesService client wrapper, for convenient use.

Inheritance

object

AggregateProductStatusesServiceClient

AggregateProductStatusesServiceClientImpl

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Shopping.Merchant.IssueResolution.V1

Assembly: Google.Shopping.Merchant.IssueResolution.V1.dll

Syntax

public abstract class AggregateProductStatusesServiceClient

Remarks

Service to manage aggregate product statuses.

Properties

DefaultEndpoint

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

Declaration

public static string DefaultEndpoint { get; }

Property Value

Type	Description
string

DefaultScopes

The default AggregateProductStatusesService scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default AggregateProductStatusesService scopes are:

• https://www.googleapis.com/auth/content

GrpcClient

The underlying gRPC AggregateProductStatusesService client

Declaration

public virtual AggregateProductStatusesService.AggregateProductStatusesServiceClient GrpcClient { get; }

Property Value

Type	Description
AggregateProductStatusesService.AggregateProductStatusesServiceClient

ServiceMetadata

The service metadata associated with this client type.

Declaration

public static ServiceMetadata ServiceMetadata { get; }

Property Value

Type	Description
ServiceMetadata

Methods

Create()

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

Declaration

public static AggregateProductStatusesServiceClient Create()

Returns

Type	Description
AggregateProductStatusesServiceClient	The created AggregateProductStatusesServiceClient.

CreateAsync(CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The CancellationToken to use while creating the client.

Returns

Type	Description
Task<AggregateProductStatusesServiceClient>	The task representing the created AggregateProductStatusesServiceClient.

ListAggregateProductStatuses(AccountName, string, int?, CallSettings)

Lists the AggregateProductStatuses resources for your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

Declaration

public virtual PagedEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> ListAggregateProductStatuses(AccountName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
AccountName	parent	Required. The account to list aggregate product statuses for. Format: accounts/{account}
string	pageToken	The token returned from the previous request. A value of null or an empty string retrieves the first page.
int?	pageSize	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<ListAggregateProductStatusesResponse, AggregateProductStatus>	A pageable sequence of AggregateProductStatus resources.

Sample code

// Create client
AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient = AggregateProductStatusesServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
// Make the request
PagedEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> response = aggregateProductStatusesServiceClient.ListAggregateProductStatuses(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AggregateProductStatus 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 (ListAggregateProductStatusesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AggregateProductStatus 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<AggregateProductStatus> 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 (AggregateProductStatus 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;

ListAggregateProductStatuses(ListAggregateProductStatusesRequest, CallSettings)

Lists the AggregateProductStatuses resources for your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

Declaration

public virtual PagedEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> ListAggregateProductStatuses(ListAggregateProductStatusesRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListAggregateProductStatusesRequest	request	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<ListAggregateProductStatusesResponse, AggregateProductStatus>	A pageable sequence of AggregateProductStatus resources.

Sample code

// Create client
AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient = AggregateProductStatusesServiceClient.Create();
// Initialize request argument(s)
ListAggregateProductStatusesRequest request = new ListAggregateProductStatusesRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> response = aggregateProductStatusesServiceClient.ListAggregateProductStatuses(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (AggregateProductStatus 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 (ListAggregateProductStatusesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AggregateProductStatus 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<AggregateProductStatus> 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 (AggregateProductStatus 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;

ListAggregateProductStatuses(string, string, int?, CallSettings)

Lists the AggregateProductStatuses resources for your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

Declaration

public virtual PagedEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> ListAggregateProductStatuses(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The account to list aggregate product statuses for. Format: accounts/{account}
string	pageToken	The token returned from the previous request. A value of null or an empty string retrieves the first page.
int?	pageSize	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<ListAggregateProductStatusesResponse, AggregateProductStatus>	A pageable sequence of AggregateProductStatus resources.

Sample code

// Create client
AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient = AggregateProductStatusesServiceClient.Create();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
// Make the request
PagedEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> response = aggregateProductStatusesServiceClient.ListAggregateProductStatuses(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AggregateProductStatus 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 (ListAggregateProductStatusesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AggregateProductStatus 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<AggregateProductStatus> 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 (AggregateProductStatus 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;

ListAggregateProductStatusesAsync(AccountName, string, int?, CallSettings)

Lists the AggregateProductStatuses resources for your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

Declaration

public virtual PagedAsyncEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> ListAggregateProductStatusesAsync(AccountName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
AccountName	parent	Required. The account to list aggregate product statuses for. Format: accounts/{account}
string	pageToken	The token returned from the previous request. A value of null or an empty string retrieves the first page.
int?	pageSize	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<ListAggregateProductStatusesResponse, AggregateProductStatus>	A pageable asynchronous sequence of AggregateProductStatus resources.

Sample code

// Create client
AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient = await AggregateProductStatusesServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
// Make the request
PagedAsyncEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> response = aggregateProductStatusesServiceClient.ListAggregateProductStatusesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AggregateProductStatus 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((ListAggregateProductStatusesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AggregateProductStatus 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<AggregateProductStatus> 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 (AggregateProductStatus 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;

ListAggregateProductStatusesAsync(ListAggregateProductStatusesRequest, CallSettings)

Lists the AggregateProductStatuses resources for your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

Declaration

public virtual PagedAsyncEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> ListAggregateProductStatusesAsync(ListAggregateProductStatusesRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListAggregateProductStatusesRequest	request	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<ListAggregateProductStatusesResponse, AggregateProductStatus>	A pageable asynchronous sequence of AggregateProductStatus resources.

Sample code

// Create client
AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient = await AggregateProductStatusesServiceClient.CreateAsync();
// Initialize request argument(s)
ListAggregateProductStatusesRequest request = new ListAggregateProductStatusesRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> response = aggregateProductStatusesServiceClient.ListAggregateProductStatusesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AggregateProductStatus 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((ListAggregateProductStatusesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AggregateProductStatus 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<AggregateProductStatus> 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 (AggregateProductStatus 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;

ListAggregateProductStatusesAsync(string, string, int?, CallSettings)

Lists the AggregateProductStatuses resources for your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

Declaration

public virtual PagedAsyncEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> ListAggregateProductStatusesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The account to list aggregate product statuses for. Format: accounts/{account}
string	pageToken	The token returned from the previous request. A value of null or an empty string retrieves the first page.
int?	pageSize	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<ListAggregateProductStatusesResponse, AggregateProductStatus>	A pageable asynchronous sequence of AggregateProductStatus resources.

Sample code

// Create client
AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient = await AggregateProductStatusesServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
// Make the request
PagedAsyncEnumerable<ListAggregateProductStatusesResponse, AggregateProductStatus> response = aggregateProductStatusesServiceClient.ListAggregateProductStatusesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AggregateProductStatus 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((ListAggregateProductStatusesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AggregateProductStatus 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<AggregateProductStatus> 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 (AggregateProductStatus 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;

ShutdownDefaultChannelsAsync()

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

Declaration

public static Task ShutdownDefaultChannelsAsync()

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.