Cloud Composer v1 API - Class ImageVersionsClient (2.7.0)

public abstract class ImageVersionsClient

Reference documentation and code samples for the Cloud Composer v1 API class ImageVersionsClient.

ImageVersions client wrapper, for convenient use.

Inheritance

object > ImageVersionsClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ImageVersionsClientImpl

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

Google.Cloud.Orchestration.Airflow.Service.V1.dll

Remarks

Readonly service to query available ImageVersions.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ImageVersions scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default ImageVersions scopes are:

https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual ImageVersions.ImageVersionsClient GrpcClient { get; }

The underlying gRPC ImageVersions client

Property Value
Type	Description
`ImageVersionsImageVersionsClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static ImageVersionsClient Create()

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

Returns
Type	Description
`ImageVersionsClient`	The created ImageVersionsClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskImageVersionsClient`	The task representing the created ImageVersionsClient.

ListImageVersions(ListImageVersionsRequest, CallSettings)

public virtual PagedEnumerable<ListImageVersionsResponse, ImageVersion> ListImageVersions(ListImageVersionsRequest request, CallSettings callSettings = null)

List ImageVersions for provided location.

Parameters
Name	Description
`request`	`ListImageVersionsRequest` 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
`PagedEnumerableListImageVersionsResponseImageVersion`	A pageable sequence of ImageVersion resources.

Example

// Create client
ImageVersionsClient imageVersionsClient = ImageVersionsClient.Create();
// Initialize request argument(s)
ListImageVersionsRequest request = new ListImageVersionsRequest
{
    Parent = "",
    IncludePastReleases = false,
};
// Make the request
PagedEnumerable<ListImageVersionsResponse, ImageVersion> response = imageVersionsClient.ListImageVersions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ImageVersion 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 (ListImageVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ImageVersion 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<ImageVersion> 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 (ImageVersion 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;

ListImageVersions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListImageVersionsResponse, ImageVersion> ListImageVersions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List ImageVersions for provided location.

Parameters
Name	Description
`parent`	`string` List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"
`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
`PagedEnumerableListImageVersionsResponseImageVersion`	A pageable sequence of ImageVersion resources.

Example

// Create client
ImageVersionsClient imageVersionsClient = ImageVersionsClient.Create();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedEnumerable<ListImageVersionsResponse, ImageVersion> response = imageVersionsClient.ListImageVersions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ImageVersion 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 (ListImageVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ImageVersion 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<ImageVersion> 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 (ImageVersion 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;

ListImageVersionsAsync(ListImageVersionsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListImageVersionsResponse, ImageVersion> ListImageVersionsAsync(ListImageVersionsRequest request, CallSettings callSettings = null)

List ImageVersions for provided location.

Parameters
Name	Description
`request`	`ListImageVersionsRequest` 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
`PagedAsyncEnumerableListImageVersionsResponseImageVersion`	A pageable asynchronous sequence of ImageVersion resources.

Example

// Create client
ImageVersionsClient imageVersionsClient = await ImageVersionsClient.CreateAsync();
// Initialize request argument(s)
ListImageVersionsRequest request = new ListImageVersionsRequest
{
    Parent = "",
    IncludePastReleases = false,
};
// Make the request
PagedAsyncEnumerable<ListImageVersionsResponse, ImageVersion> response = imageVersionsClient.ListImageVersionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ImageVersion 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((ListImageVersionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ImageVersion 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<ImageVersion> 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 (ImageVersion 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;

ListImageVersionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListImageVersionsResponse, ImageVersion> ListImageVersionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List ImageVersions for provided location.

Parameters
Name	Description
`parent`	`string` List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"
`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
`PagedAsyncEnumerableListImageVersionsResponseImageVersion`	A pageable asynchronous sequence of ImageVersion resources.

Example

// Create client
ImageVersionsClient imageVersionsClient = await ImageVersionsClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedAsyncEnumerable<ListImageVersionsResponse, ImageVersion> response = imageVersionsClient.ListImageVersionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ImageVersion 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((ListImageVersionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ImageVersion 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<ImageVersion> 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 (ImageVersion 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;

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.