Class RoleServiceClient

RoleService client wrapper, for convenient use.

Inheritance

object

RoleServiceClient

RoleServiceClientImpl

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 RoleServiceClient

Remarks

Provides methods for handling Role objects.

Properties

DefaultEndpoint

The default endpoint for the RoleService 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 RoleService scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default RoleService scopes are:

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

GrpcClient

The underlying gRPC RoleService client

Declaration

public virtual RoleService.RoleServiceClient GrpcClient { get; }

Property Value

Type	Description
RoleService.RoleServiceClient

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

Declaration

public static RoleServiceClient Create()

Returns

Type	Description
RoleServiceClient	The created RoleServiceClient.

CreateAsync(CancellationToken)

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

Declaration

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

Parameters

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

Returns

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

GetRole(GetRoleRequest, CallSettings)

API to retrieve a Role object.

Declaration

public virtual Role GetRole(GetRoleRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetRoleRequest	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
Role	The RPC response.

Sample code

// Create client
RoleServiceClient roleServiceClient = RoleServiceClient.Create();
// Initialize request argument(s)
GetRoleRequest request = new GetRoleRequest
{
    RoleName = RoleName.FromNetworkCodeRole("[NETWORK_CODE]", "[ROLE]"),
};
// Make the request
Role response = roleServiceClient.GetRole(request);

GetRole(RoleName, CallSettings)

API to retrieve a Role object.

Declaration

public virtual Role GetRole(RoleName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
RoleName	name	Required. The resource name of the Role. Format: networks/{network_code}/roles/{role_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Role	The RPC response.

Sample code

// Create client
RoleServiceClient roleServiceClient = RoleServiceClient.Create();
// Initialize request argument(s)
RoleName name = RoleName.FromNetworkCodeRole("[NETWORK_CODE]", "[ROLE]");
// Make the request
Role response = roleServiceClient.GetRole(name);

GetRole(string, CallSettings)

API to retrieve a Role object.

Declaration

public virtual Role GetRole(string name, CallSettings callSettings = null)

Parameters

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

Returns

Type	Description
Role	The RPC response.

Sample code

// Create client
RoleServiceClient roleServiceClient = RoleServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/roles/[ROLE]";
// Make the request
Role response = roleServiceClient.GetRole(name);

GetRoleAsync(GetRoleRequest, CallSettings)

API to retrieve a Role object.

Declaration

public virtual Task<Role> GetRoleAsync(GetRoleRequest request, CallSettings callSettings = null)

Parameters

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

Sample code

// Create client
RoleServiceClient roleServiceClient = await RoleServiceClient.CreateAsync();
// Initialize request argument(s)
GetRoleRequest request = new GetRoleRequest
{
    RoleName = RoleName.FromNetworkCodeRole("[NETWORK_CODE]", "[ROLE]"),
};
// Make the request
Role response = await roleServiceClient.GetRoleAsync(request);

GetRoleAsync(GetRoleRequest, CancellationToken)

API to retrieve a Role object.

Declaration

public virtual Task<Role> GetRoleAsync(GetRoleRequest request, CancellationToken cancellationToken)

Parameters

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

Sample code

// Create client
RoleServiceClient roleServiceClient = await RoleServiceClient.CreateAsync();
// Initialize request argument(s)
GetRoleRequest request = new GetRoleRequest
{
    RoleName = RoleName.FromNetworkCodeRole("[NETWORK_CODE]", "[ROLE]"),
};
// Make the request
Role response = await roleServiceClient.GetRoleAsync(request);

GetRoleAsync(RoleName, CallSettings)

API to retrieve a Role object.

Declaration

public virtual Task<Role> GetRoleAsync(RoleName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
RoleName	name	Required. The resource name of the Role. Format: networks/{network_code}/roles/{role_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

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

Sample code

// Create client
RoleServiceClient roleServiceClient = await RoleServiceClient.CreateAsync();
// Initialize request argument(s)
RoleName name = RoleName.FromNetworkCodeRole("[NETWORK_CODE]", "[ROLE]");
// Make the request
Role response = await roleServiceClient.GetRoleAsync(name);

GetRoleAsync(RoleName, CancellationToken)

API to retrieve a Role object.

Declaration

public virtual Task<Role> GetRoleAsync(RoleName name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RoleName	name	Required. The resource name of the Role. Format: networks/{network_code}/roles/{role_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

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

Sample code

// Create client
RoleServiceClient roleServiceClient = await RoleServiceClient.CreateAsync();
// Initialize request argument(s)
RoleName name = RoleName.FromNetworkCodeRole("[NETWORK_CODE]", "[ROLE]");
// Make the request
Role response = await roleServiceClient.GetRoleAsync(name);

GetRoleAsync(string, CallSettings)

API to retrieve a Role object.

Declaration

public virtual Task<Role> GetRoleAsync(string name, CallSettings callSettings = null)

Parameters

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

Returns

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

Sample code

// Create client
RoleServiceClient roleServiceClient = await RoleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/roles/[ROLE]";
// Make the request
Role response = await roleServiceClient.GetRoleAsync(name);

GetRoleAsync(string, CancellationToken)

API to retrieve a Role object.

Declaration

public virtual Task<Role> GetRoleAsync(string name, CancellationToken cancellationToken)

Parameters

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

Returns

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

Sample code

// Create client
RoleServiceClient roleServiceClient = await RoleServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/roles/[ROLE]";
// Make the request
Role response = await roleServiceClient.GetRoleAsync(name);

ListRoles(ListRolesRequest, CallSettings)

API to retrieve a list of Role objects.

Declaration

public virtual PagedEnumerable<ListRolesResponse, Role> ListRoles(ListRolesRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListRolesRequest	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<ListRolesResponse, Role>	A pageable sequence of Role resources.

Sample code

// Create client
RoleServiceClient roleServiceClient = RoleServiceClient.Create();
// Initialize request argument(s)
ListRolesRequest request = new ListRolesRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListRolesResponse, Role> response = roleServiceClient.ListRoles(request);

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

ListRoles(NetworkName, string, int?, CallSettings)

API to retrieve a list of Role objects.

Declaration

public virtual PagedEnumerable<ListRolesResponse, Role> ListRoles(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 Roles. 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<ListRolesResponse, Role>	A pageable sequence of Role resources.

Sample code

// Create client
RoleServiceClient roleServiceClient = RoleServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListRolesResponse, Role> response = roleServiceClient.ListRoles(parent);

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

ListRoles(string, string, int?, CallSettings)

API to retrieve a list of Role objects.

Declaration

public virtual PagedEnumerable<ListRolesResponse, Role> ListRoles(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 Roles. 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<ListRolesResponse, Role>	A pageable sequence of Role resources.

Sample code

// Create client
RoleServiceClient roleServiceClient = RoleServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListRolesResponse, Role> response = roleServiceClient.ListRoles(parent);

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

ListRolesAsync(ListRolesRequest, CallSettings)

API to retrieve a list of Role objects.

Declaration

public virtual PagedAsyncEnumerable<ListRolesResponse, Role> ListRolesAsync(ListRolesRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListRolesRequest	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<ListRolesResponse, Role>	A pageable asynchronous sequence of Role resources.

Sample code

// Create client
RoleServiceClient roleServiceClient = await RoleServiceClient.CreateAsync();
// Initialize request argument(s)
ListRolesRequest request = new ListRolesRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListRolesResponse, Role> response = roleServiceClient.ListRolesAsync(request);

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

ListRolesAsync(NetworkName, string, int?, CallSettings)

API to retrieve a list of Role objects.

Declaration

public virtual PagedAsyncEnumerable<ListRolesResponse, Role> ListRolesAsync(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 Roles. 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<ListRolesResponse, Role>	A pageable asynchronous sequence of Role resources.

Sample code

// Create client
RoleServiceClient roleServiceClient = await RoleServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListRolesResponse, Role> response = roleServiceClient.ListRolesAsync(parent);

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

ListRolesAsync(string, string, int?, CallSettings)

API to retrieve a list of Role objects.

Declaration

public virtual PagedAsyncEnumerable<ListRolesResponse, Role> ListRolesAsync(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 Roles. 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<ListRolesResponse, Role>	A pageable asynchronous sequence of Role resources.

Sample code

// Create client
RoleServiceClient roleServiceClient = await RoleServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListRolesResponse, Role> response = roleServiceClient.ListRolesAsync(parent);

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