Class CmsMetadataKeyServiceClient

CmsMetadataKeyService client wrapper, for convenient use.

Inheritance

object

CmsMetadataKeyServiceClient

CmsMetadataKeyServiceClientImpl

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public abstract class CmsMetadataKeyServiceClient

Remarks

Provides methods for handling CmsMetadataKey objects.

Properties

DefaultEndpoint

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

Declaration

public static string DefaultEndpoint { get; }

Property Value

Type	Description
string

DefaultScopes

The default CmsMetadataKeyService scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default CmsMetadataKeyService scopes are:

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

GrpcClient

The underlying gRPC CmsMetadataKeyService client

Declaration

public virtual CmsMetadataKeyService.CmsMetadataKeyServiceClient GrpcClient { get; }

Property Value

Type	Description
CmsMetadataKeyService.CmsMetadataKeyServiceClient

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 CmsMetadataKeyServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CmsMetadataKeyServiceClientBuilder.

Declaration

public static CmsMetadataKeyServiceClient Create()

Returns

Type	Description
CmsMetadataKeyServiceClient	The created CmsMetadataKeyServiceClient.

CreateAsync(CancellationToken)

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

Declaration

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

Parameters

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

Returns

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

GetCmsMetadataKey(CmsMetadataKeyName, CallSettings)

API to retrieve a CmsMetadataKey object.

Declaration

public virtual CmsMetadataKey GetCmsMetadataKey(CmsMetadataKeyName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
CmsMetadataKeyName	name	Required. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
CmsMetadataKey	The RPC response.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = CmsMetadataKeyServiceClient.Create();
// Initialize request argument(s)
CmsMetadataKeyName name = CmsMetadataKeyName.FromNetworkCodeCmsMetadataKey("[NETWORK_CODE]", "[CMS_METADATA_KEY]");
// Make the request
CmsMetadataKey response = cmsMetadataKeyServiceClient.GetCmsMetadataKey(name);

GetCmsMetadataKey(GetCmsMetadataKeyRequest, CallSettings)

API to retrieve a CmsMetadataKey object.

Declaration

public virtual CmsMetadataKey GetCmsMetadataKey(GetCmsMetadataKeyRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetCmsMetadataKeyRequest	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
CmsMetadataKey	The RPC response.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = CmsMetadataKeyServiceClient.Create();
// Initialize request argument(s)
GetCmsMetadataKeyRequest request = new GetCmsMetadataKeyRequest
{
    CmsMetadataKeyName = CmsMetadataKeyName.FromNetworkCodeCmsMetadataKey("[NETWORK_CODE]", "[CMS_METADATA_KEY]"),
};
// Make the request
CmsMetadataKey response = cmsMetadataKeyServiceClient.GetCmsMetadataKey(request);

GetCmsMetadataKey(string, CallSettings)

API to retrieve a CmsMetadataKey object.

Declaration

public virtual CmsMetadataKey GetCmsMetadataKey(string name, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	name	Required. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
CmsMetadataKey	The RPC response.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = CmsMetadataKeyServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/cmsMetadataKeys/[CMS_METADATA_KEY]";
// Make the request
CmsMetadataKey response = cmsMetadataKeyServiceClient.GetCmsMetadataKey(name);

GetCmsMetadataKeyAsync(CmsMetadataKeyName, CallSettings)

API to retrieve a CmsMetadataKey object.

Declaration

public virtual Task<CmsMetadataKey> GetCmsMetadataKeyAsync(CmsMetadataKeyName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
CmsMetadataKeyName	name	Required. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<CmsMetadataKey>	A Task containing the RPC response.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = await CmsMetadataKeyServiceClient.CreateAsync();
// Initialize request argument(s)
CmsMetadataKeyName name = CmsMetadataKeyName.FromNetworkCodeCmsMetadataKey("[NETWORK_CODE]", "[CMS_METADATA_KEY]");
// Make the request
CmsMetadataKey response = await cmsMetadataKeyServiceClient.GetCmsMetadataKeyAsync(name);

GetCmsMetadataKeyAsync(CmsMetadataKeyName, CancellationToken)

API to retrieve a CmsMetadataKey object.

Declaration

public virtual Task<CmsMetadataKey> GetCmsMetadataKeyAsync(CmsMetadataKeyName name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CmsMetadataKeyName	name	Required. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<CmsMetadataKey>	A Task containing the RPC response.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = await CmsMetadataKeyServiceClient.CreateAsync();
// Initialize request argument(s)
CmsMetadataKeyName name = CmsMetadataKeyName.FromNetworkCodeCmsMetadataKey("[NETWORK_CODE]", "[CMS_METADATA_KEY]");
// Make the request
CmsMetadataKey response = await cmsMetadataKeyServiceClient.GetCmsMetadataKeyAsync(name);

GetCmsMetadataKeyAsync(GetCmsMetadataKeyRequest, CallSettings)

API to retrieve a CmsMetadataKey object.

Declaration

public virtual Task<CmsMetadataKey> GetCmsMetadataKeyAsync(GetCmsMetadataKeyRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetCmsMetadataKeyRequest	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
Task<CmsMetadataKey>	A Task containing the RPC response.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = await CmsMetadataKeyServiceClient.CreateAsync();
// Initialize request argument(s)
GetCmsMetadataKeyRequest request = new GetCmsMetadataKeyRequest
{
    CmsMetadataKeyName = CmsMetadataKeyName.FromNetworkCodeCmsMetadataKey("[NETWORK_CODE]", "[CMS_METADATA_KEY]"),
};
// Make the request
CmsMetadataKey response = await cmsMetadataKeyServiceClient.GetCmsMetadataKeyAsync(request);

GetCmsMetadataKeyAsync(GetCmsMetadataKeyRequest, CancellationToken)

API to retrieve a CmsMetadataKey object.

Declaration

public virtual Task<CmsMetadataKey> GetCmsMetadataKeyAsync(GetCmsMetadataKeyRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetCmsMetadataKeyRequest	request	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<CmsMetadataKey>	A Task containing the RPC response.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = await CmsMetadataKeyServiceClient.CreateAsync();
// Initialize request argument(s)
GetCmsMetadataKeyRequest request = new GetCmsMetadataKeyRequest
{
    CmsMetadataKeyName = CmsMetadataKeyName.FromNetworkCodeCmsMetadataKey("[NETWORK_CODE]", "[CMS_METADATA_KEY]"),
};
// Make the request
CmsMetadataKey response = await cmsMetadataKeyServiceClient.GetCmsMetadataKeyAsync(request);

GetCmsMetadataKeyAsync(string, CallSettings)

API to retrieve a CmsMetadataKey object.

Declaration

public virtual Task<CmsMetadataKey> GetCmsMetadataKeyAsync(string name, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	name	Required. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<CmsMetadataKey>	A Task containing the RPC response.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = await CmsMetadataKeyServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/cmsMetadataKeys/[CMS_METADATA_KEY]";
// Make the request
CmsMetadataKey response = await cmsMetadataKeyServiceClient.GetCmsMetadataKeyAsync(name);

GetCmsMetadataKeyAsync(string, CancellationToken)

API to retrieve a CmsMetadataKey object.

Declaration

public virtual Task<CmsMetadataKey> GetCmsMetadataKeyAsync(string name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	name	Required. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<CmsMetadataKey>	A Task containing the RPC response.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = await CmsMetadataKeyServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/cmsMetadataKeys/[CMS_METADATA_KEY]";
// Make the request
CmsMetadataKey response = await cmsMetadataKeyServiceClient.GetCmsMetadataKeyAsync(name);

ListCmsMetadataKeys(ListCmsMetadataKeysRequest, CallSettings)

API to retrieve a list of CmsMetadataKey objects.

Declaration

public virtual PagedEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> ListCmsMetadataKeys(ListCmsMetadataKeysRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListCmsMetadataKeysRequest	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<ListCmsMetadataKeysResponse, CmsMetadataKey>	A pageable sequence of CmsMetadataKey resources.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = CmsMetadataKeyServiceClient.Create();
// Initialize request argument(s)
ListCmsMetadataKeysRequest request = new ListCmsMetadataKeysRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> response = cmsMetadataKeyServiceClient.ListCmsMetadataKeys(request);

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

ListCmsMetadataKeys(NetworkName, string, int?, CallSettings)

API to retrieve a list of CmsMetadataKey objects.

Declaration

public virtual PagedEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> ListCmsMetadataKeys(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent, which owns this collection of CmsMetadataKeys. Format: networks/{network_code}
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<ListCmsMetadataKeysResponse, CmsMetadataKey>	A pageable sequence of CmsMetadataKey resources.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = CmsMetadataKeyServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> response = cmsMetadataKeyServiceClient.ListCmsMetadataKeys(parent);

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

ListCmsMetadataKeys(string, string, int?, CallSettings)

API to retrieve a list of CmsMetadataKey objects.

Declaration

public virtual PagedEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> ListCmsMetadataKeys(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent, which owns this collection of CmsMetadataKeys. Format: networks/{network_code}
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<ListCmsMetadataKeysResponse, CmsMetadataKey>	A pageable sequence of CmsMetadataKey resources.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = CmsMetadataKeyServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> response = cmsMetadataKeyServiceClient.ListCmsMetadataKeys(parent);

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

ListCmsMetadataKeysAsync(ListCmsMetadataKeysRequest, CallSettings)

API to retrieve a list of CmsMetadataKey objects.

Declaration

public virtual PagedAsyncEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> ListCmsMetadataKeysAsync(ListCmsMetadataKeysRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListCmsMetadataKeysRequest	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<ListCmsMetadataKeysResponse, CmsMetadataKey>	A pageable asynchronous sequence of CmsMetadataKey resources.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = await CmsMetadataKeyServiceClient.CreateAsync();
// Initialize request argument(s)
ListCmsMetadataKeysRequest request = new ListCmsMetadataKeysRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> response = cmsMetadataKeyServiceClient.ListCmsMetadataKeysAsync(request);

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

ListCmsMetadataKeysAsync(NetworkName, string, int?, CallSettings)

API to retrieve a list of CmsMetadataKey objects.

Declaration

public virtual PagedAsyncEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> ListCmsMetadataKeysAsync(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent, which owns this collection of CmsMetadataKeys. Format: networks/{network_code}
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<ListCmsMetadataKeysResponse, CmsMetadataKey>	A pageable asynchronous sequence of CmsMetadataKey resources.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = await CmsMetadataKeyServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> response = cmsMetadataKeyServiceClient.ListCmsMetadataKeysAsync(parent);

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

ListCmsMetadataKeysAsync(string, string, int?, CallSettings)

API to retrieve a list of CmsMetadataKey objects.

Declaration

public virtual PagedAsyncEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> ListCmsMetadataKeysAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent, which owns this collection of CmsMetadataKeys. Format: networks/{network_code}
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<ListCmsMetadataKeysResponse, CmsMetadataKey>	A pageable asynchronous sequence of CmsMetadataKey resources.

Sample code

// Create client
CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient = await CmsMetadataKeyServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListCmsMetadataKeysResponse, CmsMetadataKey> response = cmsMetadataKeyServiceClient.ListCmsMetadataKeysAsync(parent);

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