Compute Engine v1 API - Class Autoscalers.AutoscalersClient (2.14.0)

Version 2.14.0

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class Autoscalers.AutoscalersClient : ClientBase<Autoscalers.AutoscalersClient>

Reference documentation and code samples for the Compute Engine v1 API class Autoscalers.AutoscalersClient.

Client for Autoscalers

Inheritance

object > ClientBase > ClientBaseAutoscalersAutoscalersClient > Autoscalers.AutoscalersClient

Inherited Members

ClientBase<Autoscalers.AutoscalersClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

AutoscalersClient()

protected AutoscalersClient()

Protected parameterless constructor to allow creation of test doubles.

AutoscalersClient(CallInvoker)

public AutoscalersClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

AutoscalersClient(ChannelBase)

public AutoscalersClient(ChannelBase channel)

Creates a new client for Autoscalers

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

AutoscalersClient(ClientBaseConfiguration)

protected AutoscalersClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListAutoscalersRequest, CallOptions)

public virtual AutoscalerAggregatedList AggregatedList(AggregatedListAutoscalersRequest request, CallOptions options)

Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

Returns
Type	Description
AutoscalerAggregatedList	The response received from the server.

AggregatedList(AggregatedListAutoscalersRequest, Metadata, DateTime?, CancellationToken)

public virtual AutoscalerAggregatedList AggregatedList(AggregatedListAutoscalersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListAutoscalersRequest 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
AutoscalerAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListAutoscalersRequest, CallOptions)

public virtual AsyncUnaryCall<AutoscalerAggregatedList> AggregatedListAsync(AggregatedListAutoscalersRequest request, CallOptions options)

Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

Returns
Type	Description
AsyncUnaryCallAutoscalerAggregatedList	The call object.

AggregatedListAsync(AggregatedListAutoscalersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AutoscalerAggregatedList> AggregatedListAsync(AggregatedListAutoscalersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListAutoscalersRequest 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
AsyncUnaryCallAutoscalerAggregatedList	The call object.

CreateOperationsClientForZoneOperations()

public virtual Operations.OperationsClient CreateOperationsClientForZoneOperations()

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

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteAutoscalerRequest, CallOptions)

public virtual Operation Delete(DeleteAutoscalerRequest request, CallOptions options)

Deletes the specified autoscaler.

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

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteAutoscalerRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified autoscaler.

Parameters
Name	Description
request	DeleteAutoscalerRequest 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.

DeleteAsync(DeleteAutoscalerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteAutoscalerRequest request, CallOptions options)

Deletes the specified autoscaler.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteAutoscalerRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified autoscaler.

Parameters
Name	Description
request	DeleteAutoscalerRequest 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.

Get(GetAutoscalerRequest, CallOptions)

public virtual Autoscaler Get(GetAutoscalerRequest request, CallOptions options)

Returns the specified autoscaler resource.

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

Returns
Type	Description
Autoscaler	The response received from the server.

Get(GetAutoscalerRequest, Metadata, DateTime?, CancellationToken)

public virtual Autoscaler Get(GetAutoscalerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified autoscaler resource.

Parameters
Name	Description
request	GetAutoscalerRequest 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
Autoscaler	The response received from the server.

GetAsync(GetAutoscalerRequest, CallOptions)

public virtual AsyncUnaryCall<Autoscaler> GetAsync(GetAutoscalerRequest request, CallOptions options)

Returns the specified autoscaler resource.

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

Returns
Type	Description
AsyncUnaryCallAutoscaler	The call object.

GetAsync(GetAutoscalerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Autoscaler> GetAsync(GetAutoscalerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified autoscaler resource.

Parameters
Name	Description
request	GetAutoscalerRequest 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
AsyncUnaryCallAutoscaler	The call object.

Insert(InsertAutoscalerRequest, CallOptions)

public virtual Operation Insert(InsertAutoscalerRequest request, CallOptions options)

Creates an autoscaler in the specified project using the data included in the request.

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

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertAutoscalerRequest, Metadata, DateTime?, CancellationToken)

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

Creates an autoscaler in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertAutoscalerRequest 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.

InsertAsync(InsertAutoscalerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertAutoscalerRequest request, CallOptions options)

Creates an autoscaler in the specified project using the data included in the request.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertAutoscalerRequest, Metadata, DateTime?, CancellationToken)

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

Creates an autoscaler in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertAutoscalerRequest 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.

List(ListAutoscalersRequest, CallOptions)

public virtual AutoscalerList List(ListAutoscalersRequest request, CallOptions options)

Retrieves a list of autoscalers contained within the specified zone.

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

Returns
Type	Description
AutoscalerList	The response received from the server.

List(ListAutoscalersRequest, Metadata, DateTime?, CancellationToken)

public virtual AutoscalerList List(ListAutoscalersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of autoscalers contained within the specified zone.

Parameters
Name	Description
request	ListAutoscalersRequest 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
AutoscalerList	The response received from the server.

ListAsync(ListAutoscalersRequest, CallOptions)

public virtual AsyncUnaryCall<AutoscalerList> ListAsync(ListAutoscalersRequest request, CallOptions options)

Retrieves a list of autoscalers contained within the specified zone.

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

Returns
Type	Description
AsyncUnaryCallAutoscalerList	The call object.

ListAsync(ListAutoscalersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AutoscalerList> ListAsync(ListAutoscalersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of autoscalers contained within the specified zone.

Parameters
Name	Description
request	ListAutoscalersRequest 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
AsyncUnaryCallAutoscalerList	The call object.

NewInstance(ClientBaseConfiguration)

protected override Autoscalers.AutoscalersClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
AutoscalersAutoscalersClient

Overrides

ClientBase<Autoscalers.AutoscalersClient>.NewInstance(ClientBase.ClientBaseConfiguration)

Patch(PatchAutoscalerRequest, CallOptions)

public virtual Operation Patch(PatchAutoscalerRequest request, CallOptions options)

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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

Returns
Type	Description
Operation	The response received from the server.

Patch(PatchAutoscalerRequest, Metadata, DateTime?, CancellationToken)

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

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
request	PatchAutoscalerRequest 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.

PatchAsync(PatchAutoscalerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchAutoscalerRequest request, CallOptions options)

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PatchAsync(PatchAutoscalerRequest, Metadata, DateTime?, CancellationToken)

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

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
request	PatchAutoscalerRequest 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.

Update(UpdateAutoscalerRequest, CallOptions)

public virtual Operation Update(UpdateAutoscalerRequest request, CallOptions options)

Updates an autoscaler in the specified project using the data included in the request.

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

Returns
Type	Description
Operation	The response received from the server.

Update(UpdateAutoscalerRequest, Metadata, DateTime?, CancellationToken)

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

Updates an autoscaler in the specified project using the data included in the request.

Parameters
Name	Description
request	UpdateAutoscalerRequest 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.

UpdateAsync(UpdateAutoscalerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateAutoscalerRequest request, CallOptions options)

Updates an autoscaler in the specified project using the data included in the request.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateAsync(UpdateAutoscalerRequest, Metadata, DateTime?, CancellationToken)

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

Updates an autoscaler in the specified project using the data included in the request.

Parameters
Name	Description
request	UpdateAutoscalerRequest 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.