Class UserService.UserServiceClient
Client for UserService
Inheritance
Inherited Members
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public class UserService.UserServiceClient : ClientBase<UserService.UserServiceClient>
Constructors
UserServiceClient()
Protected parameterless constructor to allow creation of test doubles.
Declaration
protected UserServiceClient()
UserServiceClient(CallInvoker)
Creates a new client for UserService that uses a custom CallInvoker
.
Declaration
public UserServiceClient(CallInvoker callInvoker)
Parameters
Type | Name | Description |
---|---|---|
CallInvoker | callInvoker | The callInvoker to use to make remote calls. |
UserServiceClient(ChannelBase)
Creates a new client for UserService
Declaration
public UserServiceClient(ChannelBase channel)
Parameters
Type | Name | Description |
---|---|---|
ChannelBase | channel | The channel to use to make remote calls. |
UserServiceClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
Declaration
protected UserServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBase.ClientBaseConfiguration | configuration | The client configuration. |
Methods
GetUser(GetUserRequest, CallOptions)
API to retrieve a User object.
To get the current user, the resource name
networks/{networkCode}/users/me
can be used.
Declaration
public virtual User GetUser(GetUserRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
GetUserRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
User | The response received from the server. |
GetUser(GetUserRequest, Metadata, DateTime?, CancellationToken)
API to retrieve a User object.
To get the current user, the resource name
networks/{networkCode}/users/me
can be used.
Declaration
public virtual User GetUser(GetUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
GetUserRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
User | The response received from the server. |
GetUserAsync(GetUserRequest, CallOptions)
API to retrieve a User object.
To get the current user, the resource name
networks/{networkCode}/users/me
can be used.
Declaration
public virtual AsyncUnaryCall<User> GetUserAsync(GetUserRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
GetUserRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<User> | The call object. |
GetUserAsync(GetUserRequest, Metadata, DateTime?, CancellationToken)
API to retrieve a User object.
To get the current user, the resource name
networks/{networkCode}/users/me
can be used.
Declaration
public virtual AsyncUnaryCall<User> GetUserAsync(GetUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
GetUserRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<User> | The call object. |
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration
.
Declaration
protected override UserService.UserServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBase.ClientBaseConfiguration | configuration |
Returns
Type | Description |
---|---|
UserService.UserServiceClient |