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

public class Services.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

Inherited Members

ClientBase<Services.ServicesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

ServicesClient(ChannelBase)

public ServicesClient(ChannelBase channel)

Creates a new client for Services

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

ServicesClient(ClientBaseConfiguration)

protected ServicesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` 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
Type	Description
`OperationsOperationsClient`	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
Name	Description
`request`	`DeleteServiceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteService(DeleteServiceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified service and all enclosed versions.

Parameters
Name	Description
`request`	`DeleteServiceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` 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
`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
Name	Description
`request`	`DeleteServiceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeleteServiceAsync(DeleteServiceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified service and all enclosed versions.

Parameters
Name	Description
`request`	`DeleteServiceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` 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
`AsyncUnaryCallOperation`	The call object.

GetService(GetServiceRequest, CallOptions)

public virtual Service GetService(GetServiceRequest request, CallOptions options)

Gets the current configuration of the specified service.

Parameters
Name	Description
`request`	`GetServiceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Service`	The response received from the server.

GetService(GetServiceRequest, Metadata, DateTime?, CancellationToken)

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

Gets the current configuration of the specified service.

Parameters
Name	Description
`request`	`GetServiceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` 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
`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
Name	Description
`request`	`GetServiceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallService`	The call object.

GetServiceAsync(GetServiceRequest, Metadata, DateTime?, CancellationToken)

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

Gets the current configuration of the specified service.

Parameters
Name	Description
`request`	`GetServiceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` 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
`AsyncUnaryCallService`	The call object.

ListServices(ListServicesRequest, CallOptions)

public virtual ListServicesResponse ListServices(ListServicesRequest request, CallOptions options)

Lists all the services in the application.

Parameters
Name	Description
`request`	`ListServicesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListServicesResponse`	The response received from the server.

ListServices(ListServicesRequest, Metadata, DateTime?, CancellationToken)

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

Lists all the services in the application.

Parameters
Name	Description
`request`	`ListServicesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` 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
`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
Name	Description
`request`	`ListServicesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListServicesResponse`	The call object.

ListServicesAsync(ListServicesRequest, Metadata, DateTime?, CancellationToken)

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

Lists all the services in the application.

Parameters
Name	Description
`request`	`ListServicesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` 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
`AsyncUnaryCallListServicesResponse`	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`ServicesServicesClient`

Overrides

ClientBase<Services.ServicesClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateService(UpdateServiceRequest, CallOptions)

public virtual Operation UpdateService(UpdateServiceRequest request, CallOptions options)

Updates the configuration of the specified service.

Parameters
Name	Description
`request`	`UpdateServiceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateService(UpdateServiceRequest, Metadata, DateTime?, CancellationToken)

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

Updates the configuration of the specified service.

Parameters
Name	Description
`request`	`UpdateServiceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` 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
`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
Name	Description
`request`	`UpdateServiceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

UpdateServiceAsync(UpdateServiceRequest, Metadata, DateTime?, CancellationToken)

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

Updates the configuration of the specified service.

Parameters
Name	Description
`request`	`UpdateServiceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` 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
`AsyncUnaryCallOperation`	The call object.