App Engine v1 API - Class Services.ServicesClient (2.1.0)

public class ServicesClient : ClientBase<Services.ServicesClient>

Reference documentation and code samples for the App Engine v1 API class Services.ServicesClient.

Client for Services

Inheritance

Object > ClientBase > ClientBase<Services.ServicesClient> > Services.ServicesClient

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

ServicesClient()

protected ServicesClient()

Protected parameterless constructor to allow creation of test doubles.

ServicesClient(CallInvoker)

public ServicesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ServicesClient(ChannelBase)

public ServicesClient(ChannelBase channel)

Creates a new client for Services

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ServicesClient(ClientBase.ClientBaseConfiguration)

protected ServicesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteService(DeleteServiceRequest, CallOptions)

public virtual Operation DeleteService(DeleteServiceRequest request, CallOptions options)

Deletes the specified service and all enclosed versions.

Parameters
NameDescription
requestDeleteServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteService(DeleteServiceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteService(DeleteServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified service and all enclosed versions.

Parameters
NameDescription
requestDeleteServiceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteServiceAsync(DeleteServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteServiceAsync(DeleteServiceRequest request, CallOptions options)

Deletes the specified service and all enclosed versions.

Parameters
NameDescription
requestDeleteServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteServiceAsync(DeleteServiceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteServiceAsync(DeleteServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified service and all enclosed versions.

Parameters
NameDescription
requestDeleteServiceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetService(GetServiceRequest, CallOptions)

public virtual Service GetService(GetServiceRequest request, CallOptions options)

Gets the current configuration of the specified service.

Parameters
NameDescription
requestGetServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Service

The response received from the server.

GetService(GetServiceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Service GetService(GetServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the current configuration of the specified service.

Parameters
NameDescription
requestGetServiceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Service

The response received from the server.

GetServiceAsync(GetServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Service> GetServiceAsync(GetServiceRequest request, CallOptions options)

Gets the current configuration of the specified service.

Parameters
NameDescription
requestGetServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Service>

The call object.

GetServiceAsync(GetServiceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Service> GetServiceAsync(GetServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the current configuration of the specified service.

Parameters
NameDescription
requestGetServiceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Service>

The call object.

ListServices(ListServicesRequest, CallOptions)

public virtual ListServicesResponse ListServices(ListServicesRequest request, CallOptions options)

Lists all the services in the application.

Parameters
NameDescription
requestListServicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListServicesResponse

The response received from the server.

ListServices(ListServicesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListServicesResponse ListServices(ListServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists all the services in the application.

Parameters
NameDescription
requestListServicesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListServicesResponse

The response received from the server.

ListServicesAsync(ListServicesRequest, CallOptions)

public virtual AsyncUnaryCall<ListServicesResponse> ListServicesAsync(ListServicesRequest request, CallOptions options)

Lists all the services in the application.

Parameters
NameDescription
requestListServicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListServicesResponse>

The call object.

ListServicesAsync(ListServicesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListServicesResponse> ListServicesAsync(ListServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists all the services in the application.

Parameters
NameDescription
requestListServicesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListServicesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Services.ServicesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Services.ServicesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AppEngine.V1.Services.ServicesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateService(UpdateServiceRequest, CallOptions)

public virtual Operation UpdateService(UpdateServiceRequest request, CallOptions options)

Updates the configuration of the specified service.

Parameters
NameDescription
requestUpdateServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateService(UpdateServiceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateService(UpdateServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the configuration of the specified service.

Parameters
NameDescription
requestUpdateServiceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateServiceAsync(UpdateServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateServiceAsync(UpdateServiceRequest request, CallOptions options)

Updates the configuration of the specified service.

Parameters
NameDescription
requestUpdateServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateServiceAsync(UpdateServiceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateServiceAsync(UpdateServiceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the configuration of the specified service.

Parameters
NameDescription
requestUpdateServiceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.