Compute Engine v1 API - Class AutoscalersClient (2.15.0)

public abstract class AutoscalersClient

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

Autoscalers client wrapper, for convenient use.

Inheritance

object > AutoscalersClient

Derived Types

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Autoscalers API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Autoscalers service, which is a host of "compute.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Autoscalers scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual Autoscalers.AutoscalersClient GrpcClient { get; }

The underlying gRPC Autoscalers client

Property Value
Type Description
AutoscalersAutoscalersClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient

PatchOperationsClient

public virtual OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

UpdateOperationsClient

public virtual OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type Description
OperationsClient

Methods

AggregatedList(AggregatedListAutoscalersRequest, CallSettings)

public virtual PagedEnumerable<AutoscalerAggregatedList, KeyValuePair<string, AutoscalersScopedList>> AggregatedList(AggregatedListAutoscalersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableAutoscalerAggregatedListKeyValuePairstringAutoscalersScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
AggregatedListAutoscalersRequest request = new AggregatedListAutoscalersRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<AutoscalerAggregatedList, KeyValuePair<string, AutoscalersScopedList>> response = autoscalersClient.AggregatedList(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, AutoscalersScopedList> item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (AutoscalerAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, AutoscalersScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, AutoscalersScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, AutoscalersScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

AggregatedList(string, string, int?, CallSettings)

public virtual PagedEnumerable<AutoscalerAggregatedList, KeyValuePair<string, AutoscalersScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableAutoscalerAggregatedListKeyValuePairstringAutoscalersScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<AutoscalerAggregatedList, KeyValuePair<string, AutoscalersScopedList>> response = autoscalersClient.AggregatedList(project);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, AutoscalersScopedList> item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (AutoscalerAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, AutoscalersScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, AutoscalersScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, AutoscalersScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

AggregatedListAsync(AggregatedListAutoscalersRequest, CallSettings)

public virtual PagedAsyncEnumerable<AutoscalerAggregatedList, KeyValuePair<string, AutoscalersScopedList>> AggregatedListAsync(AggregatedListAutoscalersRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableAutoscalerAggregatedListKeyValuePairstringAutoscalersScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
AggregatedListAutoscalersRequest request = new AggregatedListAutoscalersRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<AutoscalerAggregatedList, KeyValuePair<string, AutoscalersScopedList>> response = autoscalersClient.AggregatedListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, AutoscalersScopedList> item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((AutoscalerAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, AutoscalersScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, AutoscalersScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, AutoscalersScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

AggregatedListAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<AutoscalerAggregatedList, KeyValuePair<string, AutoscalersScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableAutoscalerAggregatedListKeyValuePairstringAutoscalersScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<AutoscalerAggregatedList, KeyValuePair<string, AutoscalersScopedList>> response = autoscalersClient.AggregatedListAsync(project);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, AutoscalersScopedList> item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((AutoscalerAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, AutoscalersScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, AutoscalersScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, AutoscalersScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

Create()

public static AutoscalersClient Create()

Synchronously creates a AutoscalersClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AutoscalersClientBuilder.

Returns
Type Description
AutoscalersClient

The created AutoscalersClient.

CreateAsync(CancellationToken)

public static Task<AutoscalersClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a AutoscalersClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AutoscalersClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskAutoscalersClient

The task representing the created AutoscalersClient.

Delete(DeleteAutoscalerRequest, CallSettings)

public virtual Operation<Operation, Operation> Delete(DeleteAutoscalerRequest request, CallSettings callSettings = null)

Deletes the specified autoscaler.

Parameters
Name Description
request DeleteAutoscalerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
DeleteAutoscalerRequest request = new DeleteAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    Project = "",
    Autoscaler = "",
};
// Make the request
lro::Operation<Operation, Operation> response = autoscalersClient.Delete(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = autoscalersClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Delete(string, string, string, CallSettings)

public virtual Operation<Operation, Operation> Delete(string project, string zone, string autoscaler, CallSettings callSettings = null)

Deletes the specified autoscaler.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscaler string

Name of the autoscaler to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string autoscaler = "";
// Make the request
lro::Operation<Operation, Operation> response = autoscalersClient.Delete(project, zone, autoscaler);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = autoscalersClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteAutoscalerRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteAutoscalerRequest request, CallSettings callSettings = null)

Deletes the specified autoscaler.

Parameters
Name Description
request DeleteAutoscalerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
DeleteAutoscalerRequest request = new DeleteAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    Project = "",
    Autoscaler = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteAutoscalerRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteAutoscalerRequest request, CancellationToken cancellationToken)

Deletes the specified autoscaler.

Parameters
Name Description
request DeleteAutoscalerRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
DeleteAutoscalerRequest request = new DeleteAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    Project = "",
    Autoscaler = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(string, string, string, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string zone, string autoscaler, CallSettings callSettings = null)

Deletes the specified autoscaler.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscaler string

Name of the autoscaler to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string autoscaler = "";
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.DeleteAsync(project, zone, autoscaler);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(string, string, string, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string zone, string autoscaler, CancellationToken cancellationToken)

Deletes the specified autoscaler.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscaler string

Name of the autoscaler to delete.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string autoscaler = "";
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.DeleteAsync(project, zone, autoscaler);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Get(GetAutoscalerRequest, CallSettings)

public virtual Autoscaler Get(GetAutoscalerRequest request, CallSettings callSettings = null)

Returns the specified autoscaler resource.

Parameters
Name Description
request GetAutoscalerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Autoscaler

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
GetAutoscalerRequest request = new GetAutoscalerRequest
{
    Zone = "",
    Project = "",
    Autoscaler = "",
};
// Make the request
Autoscaler response = autoscalersClient.Get(request);

Get(string, string, string, CallSettings)

public virtual Autoscaler Get(string project, string zone, string autoscaler, CallSettings callSettings = null)

Returns the specified autoscaler resource.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscaler string

Name of the autoscaler to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Autoscaler

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string autoscaler = "";
// Make the request
Autoscaler response = autoscalersClient.Get(project, zone, autoscaler);

GetAsync(GetAutoscalerRequest, CallSettings)

public virtual Task<Autoscaler> GetAsync(GetAutoscalerRequest request, CallSettings callSettings = null)

Returns the specified autoscaler resource.

Parameters
Name Description
request GetAutoscalerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAutoscaler

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
GetAutoscalerRequest request = new GetAutoscalerRequest
{
    Zone = "",
    Project = "",
    Autoscaler = "",
};
// Make the request
Autoscaler response = await autoscalersClient.GetAsync(request);

GetAsync(GetAutoscalerRequest, CancellationToken)

public virtual Task<Autoscaler> GetAsync(GetAutoscalerRequest request, CancellationToken cancellationToken)

Returns the specified autoscaler resource.

Parameters
Name Description
request GetAutoscalerRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAutoscaler

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
GetAutoscalerRequest request = new GetAutoscalerRequest
{
    Zone = "",
    Project = "",
    Autoscaler = "",
};
// Make the request
Autoscaler response = await autoscalersClient.GetAsync(request);

GetAsync(string, string, string, CallSettings)

public virtual Task<Autoscaler> GetAsync(string project, string zone, string autoscaler, CallSettings callSettings = null)

Returns the specified autoscaler resource.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscaler string

Name of the autoscaler to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAutoscaler

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string autoscaler = "";
// Make the request
Autoscaler response = await autoscalersClient.GetAsync(project, zone, autoscaler);

GetAsync(string, string, string, CancellationToken)

public virtual Task<Autoscaler> GetAsync(string project, string zone, string autoscaler, CancellationToken cancellationToken)

Returns the specified autoscaler resource.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscaler string

Name of the autoscaler to return.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAutoscaler

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string autoscaler = "";
// Make the request
Autoscaler response = await autoscalersClient.GetAsync(project, zone, autoscaler);

Insert(InsertAutoscalerRequest, CallSettings)

public virtual Operation<Operation, Operation> Insert(InsertAutoscalerRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request InsertAutoscalerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
InsertAutoscalerRequest request = new InsertAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    AutoscalerResource = new Autoscaler(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = autoscalersClient.Insert(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = autoscalersClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Insert(string, string, Autoscaler, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, string zone, Autoscaler autoscalerResource, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscalerResource Autoscaler

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
Autoscaler autoscalerResource = new Autoscaler();
// Make the request
lro::Operation<Operation, Operation> response = autoscalersClient.Insert(project, zone, autoscalerResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = autoscalersClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertAutoscalerRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertAutoscalerRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request InsertAutoscalerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
InsertAutoscalerRequest request = new InsertAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    AutoscalerResource = new Autoscaler(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertAutoscalerRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertAutoscalerRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request InsertAutoscalerRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
InsertAutoscalerRequest request = new InsertAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    AutoscalerResource = new Autoscaler(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(string, string, Autoscaler, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string zone, Autoscaler autoscalerResource, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscalerResource Autoscaler

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
Autoscaler autoscalerResource = new Autoscaler();
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.InsertAsync(project, zone, autoscalerResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(string, string, Autoscaler, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string zone, Autoscaler autoscalerResource, CancellationToken cancellationToken)

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

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscalerResource Autoscaler

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
Autoscaler autoscalerResource = new Autoscaler();
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.InsertAsync(project, zone, autoscalerResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

List(ListAutoscalersRequest, CallSettings)

public virtual PagedEnumerable<AutoscalerList, Autoscaler> List(ListAutoscalersRequest request, CallSettings callSettings = null)

Retrieves a list of autoscalers contained within the specified zone.

Parameters
Name Description
request ListAutoscalersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableAutoscalerListAutoscaler

A pageable sequence of Autoscaler resources.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
ListAutoscalersRequest request = new ListAutoscalersRequest
{
    Zone = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<AutoscalerList, Autoscaler> response = autoscalersClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Autoscaler item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (AutoscalerList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Autoscaler item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Autoscaler> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Autoscaler item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

List(string, string, string, int?, CallSettings)

public virtual PagedEnumerable<AutoscalerList, Autoscaler> List(string project, string zone, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of autoscalers contained within the specified zone.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableAutoscalerListAutoscaler

A pageable sequence of Autoscaler resources.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedEnumerable<AutoscalerList, Autoscaler> response = autoscalersClient.List(project, zone);

// Iterate over all response items, lazily performing RPCs as required
foreach (Autoscaler item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (AutoscalerList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Autoscaler item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Autoscaler> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Autoscaler item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAsync(ListAutoscalersRequest, CallSettings)

public virtual PagedAsyncEnumerable<AutoscalerList, Autoscaler> ListAsync(ListAutoscalersRequest request, CallSettings callSettings = null)

Retrieves a list of autoscalers contained within the specified zone.

Parameters
Name Description
request ListAutoscalersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableAutoscalerListAutoscaler

A pageable asynchronous sequence of Autoscaler resources.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
ListAutoscalersRequest request = new ListAutoscalersRequest
{
    Zone = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<AutoscalerList, Autoscaler> response = autoscalersClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Autoscaler item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((AutoscalerList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Autoscaler item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Autoscaler> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Autoscaler item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAsync(string, string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<AutoscalerList, Autoscaler> ListAsync(string project, string zone, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of autoscalers contained within the specified zone.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableAutoscalerListAutoscaler

A pageable asynchronous sequence of Autoscaler resources.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedAsyncEnumerable<AutoscalerList, Autoscaler> response = autoscalersClient.ListAsync(project, zone);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Autoscaler item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((AutoscalerList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Autoscaler item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Autoscaler> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Autoscaler item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

Patch(PatchAutoscalerRequest, CallSettings)

public virtual Operation<Operation, Operation> Patch(PatchAutoscalerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
PatchAutoscalerRequest request = new PatchAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    AutoscalerResource = new Autoscaler(),
    Project = "",
    Autoscaler = "",
};
// Make the request
lro::Operation<Operation, Operation> response = autoscalersClient.Patch(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = autoscalersClient.PollOncePatch(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Patch(string, string, Autoscaler, CallSettings)

public virtual Operation<Operation, Operation> Patch(string project, string zone, Autoscaler autoscalerResource, CallSettings callSettings = null)

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
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscalerResource Autoscaler

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
Autoscaler autoscalerResource = new Autoscaler();
// Make the request
lro::Operation<Operation, Operation> response = autoscalersClient.Patch(project, zone, autoscalerResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = autoscalersClient.PollOncePatch(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PatchAsync(PatchAutoscalerRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(PatchAutoscalerRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
PatchAutoscalerRequest request = new PatchAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    AutoscalerResource = new Autoscaler(),
    Project = "",
    Autoscaler = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.PatchAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOncePatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PatchAsync(PatchAutoscalerRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(PatchAutoscalerRequest request, CancellationToken cancellationToken)

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 object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
PatchAutoscalerRequest request = new PatchAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    AutoscalerResource = new Autoscaler(),
    Project = "",
    Autoscaler = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.PatchAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOncePatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PatchAsync(string, string, Autoscaler, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string zone, Autoscaler autoscalerResource, CallSettings callSettings = null)

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
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscalerResource Autoscaler

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
Autoscaler autoscalerResource = new Autoscaler();
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.PatchAsync(project, zone, autoscalerResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOncePatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PatchAsync(string, string, Autoscaler, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string zone, Autoscaler autoscalerResource, CancellationToken cancellationToken)

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
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscalerResource Autoscaler

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
Autoscaler autoscalerResource = new Autoscaler();
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.PatchAsync(project, zone, autoscalerResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOncePatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PollOnceDelete(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceDelete(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Delete.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceDeleteAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceDeleteAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Delete .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceInsert(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceInsert(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Insert.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceInsertAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceInsertAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Insert .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOncePatch(string, CallSettings)

public virtual Operation<Operation, Operation> PollOncePatch(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Patch.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOncePatchAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOncePatchAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Patch .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceUpdate(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceUpdate(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Update.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceUpdateAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceUpdateAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Update .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

Update(UpdateAutoscalerRequest, CallSettings)

public virtual Operation<Operation, Operation> Update(UpdateAutoscalerRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request UpdateAutoscalerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
UpdateAutoscalerRequest request = new UpdateAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    AutoscalerResource = new Autoscaler(),
    Project = "",
    Autoscaler = "",
};
// Make the request
lro::Operation<Operation, Operation> response = autoscalersClient.Update(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = autoscalersClient.PollOnceUpdate(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Update(string, string, Autoscaler, CallSettings)

public virtual Operation<Operation, Operation> Update(string project, string zone, Autoscaler autoscalerResource, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscalerResource Autoscaler

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = AutoscalersClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
Autoscaler autoscalerResource = new Autoscaler();
// Make the request
lro::Operation<Operation, Operation> response = autoscalersClient.Update(project, zone, autoscalerResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = autoscalersClient.PollOnceUpdate(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

UpdateAsync(UpdateAutoscalerRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(UpdateAutoscalerRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request UpdateAutoscalerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
UpdateAutoscalerRequest request = new UpdateAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    AutoscalerResource = new Autoscaler(),
    Project = "",
    Autoscaler = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.UpdateAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceUpdateAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

UpdateAsync(UpdateAutoscalerRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(UpdateAutoscalerRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request UpdateAutoscalerRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
UpdateAutoscalerRequest request = new UpdateAutoscalerRequest
{
    Zone = "",
    RequestId = "",
    AutoscalerResource = new Autoscaler(),
    Project = "",
    Autoscaler = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.UpdateAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceUpdateAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

UpdateAsync(string, string, Autoscaler, CallSettings)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(string project, string zone, Autoscaler autoscalerResource, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscalerResource Autoscaler

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
Autoscaler autoscalerResource = new Autoscaler();
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.UpdateAsync(project, zone, autoscalerResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceUpdateAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

UpdateAsync(string, string, Autoscaler, CancellationToken)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(string project, string zone, Autoscaler autoscalerResource, CancellationToken cancellationToken)

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

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request.

autoscalerResource Autoscaler

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
AutoscalersClient autoscalersClient = await AutoscalersClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
Autoscaler autoscalerResource = new Autoscaler();
// Make the request
lro::Operation<Operation, Operation> response = await autoscalersClient.UpdateAsync(project, zone, autoscalerResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await autoscalersClient.PollOnceUpdateAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}