Show / Hide Table of Contents

Class ProgramsService.ProgramsServiceClient

Client for ProgramsService

Inheritance
object
ClientBase
ClientBase<ProgramsService.ProgramsServiceClient>
ProgramsService.ProgramsServiceClient
Inherited Members
ClientBase<ProgramsService.ProgramsServiceClient>.WithHost(string)
ClientBase.CallInvoker
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Shopping.Merchant.Accounts.V1
Assembly: Google.Shopping.Merchant.Accounts.V1.dll
Syntax
public class ProgramsService.ProgramsServiceClient : ClientBase<ProgramsService.ProgramsServiceClient>

Constructors

ProgramsServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected ProgramsServiceClient()

ProgramsServiceClient(CallInvoker)

Creates a new client for ProgramsService that uses a custom CallInvoker.

Declaration
public ProgramsServiceClient(CallInvoker callInvoker)
Parameters
Type Name Description
CallInvoker callInvoker

The callInvoker to use to make remote calls.

ProgramsServiceClient(ChannelBase)

Creates a new client for ProgramsService

Declaration
public ProgramsServiceClient(ChannelBase channel)
Parameters
Type Name Description
ChannelBase channel

The channel to use to make remote calls.

ProgramsServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration
protected ProgramsServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration

The client configuration.

Methods

DisableProgram(DisableProgramRequest, CallOptions)

Disable participation in the specified program for the account.

Declaration
public virtual Program DisableProgram(DisableProgramRequest request, CallOptions options)
Parameters
Type Name Description
DisableProgramRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Program

The response received from the server.

DisableProgram(DisableProgramRequest, Metadata, DateTime?, CancellationToken)

Disable participation in the specified program for the account.

Declaration
public virtual Program DisableProgram(DisableProgramRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DisableProgramRequest 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
Program

The response received from the server.

DisableProgramAsync(DisableProgramRequest, CallOptions)

Disable participation in the specified program for the account.

Declaration
public virtual AsyncUnaryCall<Program> DisableProgramAsync(DisableProgramRequest request, CallOptions options)
Parameters
Type Name Description
DisableProgramRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Program>

The call object.

DisableProgramAsync(DisableProgramRequest, Metadata, DateTime?, CancellationToken)

Disable participation in the specified program for the account.

Declaration
public virtual AsyncUnaryCall<Program> DisableProgramAsync(DisableProgramRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DisableProgramRequest 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<Program>

The call object.

EnableProgram(EnableProgramRequest, CallOptions)

Enable participation in the specified program for the account.

Declaration
public virtual Program EnableProgram(EnableProgramRequest request, CallOptions options)
Parameters
Type Name Description
EnableProgramRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Program

The response received from the server.

EnableProgram(EnableProgramRequest, Metadata, DateTime?, CancellationToken)

Enable participation in the specified program for the account.

Declaration
public virtual Program EnableProgram(EnableProgramRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
EnableProgramRequest 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
Program

The response received from the server.

EnableProgramAsync(EnableProgramRequest, CallOptions)

Enable participation in the specified program for the account.

Declaration
public virtual AsyncUnaryCall<Program> EnableProgramAsync(EnableProgramRequest request, CallOptions options)
Parameters
Type Name Description
EnableProgramRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Program>

The call object.

EnableProgramAsync(EnableProgramRequest, Metadata, DateTime?, CancellationToken)

Enable participation in the specified program for the account.

Declaration
public virtual AsyncUnaryCall<Program> EnableProgramAsync(EnableProgramRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
EnableProgramRequest 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<Program>

The call object.

GetProgram(GetProgramRequest, CallOptions)

Retrieves the specified program for the account.

Declaration
public virtual Program GetProgram(GetProgramRequest request, CallOptions options)
Parameters
Type Name Description
GetProgramRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Program

The response received from the server.

GetProgram(GetProgramRequest, Metadata, DateTime?, CancellationToken)

Retrieves the specified program for the account.

Declaration
public virtual Program GetProgram(GetProgramRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetProgramRequest 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
Program

The response received from the server.

GetProgramAsync(GetProgramRequest, CallOptions)

Retrieves the specified program for the account.

Declaration
public virtual AsyncUnaryCall<Program> GetProgramAsync(GetProgramRequest request, CallOptions options)
Parameters
Type Name Description
GetProgramRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Program>

The call object.

GetProgramAsync(GetProgramRequest, Metadata, DateTime?, CancellationToken)

Retrieves the specified program for the account.

Declaration
public virtual AsyncUnaryCall<Program> GetProgramAsync(GetProgramRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetProgramRequest 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<Program>

The call object.

ListPrograms(ListProgramsRequest, CallOptions)

Retrieves all programs for the account.

Declaration
public virtual ListProgramsResponse ListPrograms(ListProgramsRequest request, CallOptions options)
Parameters
Type Name Description
ListProgramsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
ListProgramsResponse

The response received from the server.

ListPrograms(ListProgramsRequest, Metadata, DateTime?, CancellationToken)

Retrieves all programs for the account.

Declaration
public virtual ListProgramsResponse ListPrograms(ListProgramsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListProgramsRequest 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
ListProgramsResponse

The response received from the server.

ListProgramsAsync(ListProgramsRequest, CallOptions)

Retrieves all programs for the account.

Declaration
public virtual AsyncUnaryCall<ListProgramsResponse> ListProgramsAsync(ListProgramsRequest request, CallOptions options)
Parameters
Type Name Description
ListProgramsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListProgramsResponse>

The call object.

ListProgramsAsync(ListProgramsRequest, Metadata, DateTime?, CancellationToken)

Retrieves all programs for the account.

Declaration
public virtual AsyncUnaryCall<ListProgramsResponse> ListProgramsAsync(ListProgramsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListProgramsRequest 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<ListProgramsResponse>

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration
protected override ProgramsService.ProgramsServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration
Returns
Type Description
ProgramsService.ProgramsServiceClient
Overrides
Grpc.Core.ClientBase<Google.Shopping.Merchant.Accounts.V1.ProgramsService.ProgramsServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)
In this article
Back to top Generated by DocFX