Compute Engine v1 API - Class InterconnectLocationsClient (3.1.0)

public abstract class InterconnectLocationsClient

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

InterconnectLocations client wrapper, for convenient use.

Inheritance

object > InterconnectLocationsClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

InterconnectLocationsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The InterconnectLocations API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the InterconnectLocations 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 InterconnectLocations scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default InterconnectLocations scopes are:

GrpcClient

public virtual InterconnectLocations.InterconnectLocationsClient GrpcClient { get; }

The underlying gRPC InterconnectLocations client

Property Value
Type	Description
`InterconnectLocationsInterconnectLocationsClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static InterconnectLocationsClient Create()

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

Returns
Type	Description
`InterconnectLocationsClient`	The created InterconnectLocationsClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
`TaskInterconnectLocationsClient`	The task representing the created InterconnectLocationsClient.

Get(GetInterconnectLocationRequest, CallSettings)

public virtual InterconnectLocation Get(GetInterconnectLocationRequest request, CallSettings callSettings = null)

Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.

Parameters
Name	Description
`request`	`GetInterconnectLocationRequest` 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
`InterconnectLocation`	The RPC response.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = InterconnectLocationsClient.Create();
// Initialize request argument(s)
GetInterconnectLocationRequest request = new GetInterconnectLocationRequest
{
    Project = "",
    InterconnectLocation = "",
};
// Make the request
InterconnectLocation response = interconnectLocationsClient.Get(request);

Get(string, string, CallSettings)

public virtual InterconnectLocation Get(string project, string interconnectLocation, CallSettings callSettings = null)

Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`interconnectLocation`	`string` Name of the interconnect location to return.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`InterconnectLocation`	The RPC response.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = InterconnectLocationsClient.Create();
// Initialize request argument(s)
string project = "";
string interconnectLocation = "";
// Make the request
InterconnectLocation response = interconnectLocationsClient.Get(project, interconnectLocation);

GetAsync(GetInterconnectLocationRequest, CallSettings)

public virtual Task<InterconnectLocation> GetAsync(GetInterconnectLocationRequest request, CallSettings callSettings = null)

Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.

Parameters
Name	Description
`request`	`GetInterconnectLocationRequest` 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
`TaskInterconnectLocation`	A Task containing the RPC response.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = await InterconnectLocationsClient.CreateAsync();
// Initialize request argument(s)
GetInterconnectLocationRequest request = new GetInterconnectLocationRequest
{
    Project = "",
    InterconnectLocation = "",
};
// Make the request
InterconnectLocation response = await interconnectLocationsClient.GetAsync(request);

GetAsync(GetInterconnectLocationRequest, CancellationToken)

public virtual Task<InterconnectLocation> GetAsync(GetInterconnectLocationRequest request, CancellationToken cancellationToken)

Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.

Parameters
Name	Description
`request`	`GetInterconnectLocationRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskInterconnectLocation`	A Task containing the RPC response.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = await InterconnectLocationsClient.CreateAsync();
// Initialize request argument(s)
GetInterconnectLocationRequest request = new GetInterconnectLocationRequest
{
    Project = "",
    InterconnectLocation = "",
};
// Make the request
InterconnectLocation response = await interconnectLocationsClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<InterconnectLocation> GetAsync(string project, string interconnectLocation, CallSettings callSettings = null)

Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`interconnectLocation`	`string` Name of the interconnect location to return.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskInterconnectLocation`	A Task containing the RPC response.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = await InterconnectLocationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnectLocation = "";
// Make the request
InterconnectLocation response = await interconnectLocationsClient.GetAsync(project, interconnectLocation);

GetAsync(string, string, CancellationToken)

public virtual Task<InterconnectLocation> GetAsync(string project, string interconnectLocation, CancellationToken cancellationToken)

Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`interconnectLocation`	`string` Name of the interconnect location to return.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskInterconnectLocation`	A Task containing the RPC response.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = await InterconnectLocationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnectLocation = "";
// Make the request
InterconnectLocation response = await interconnectLocationsClient.GetAsync(project, interconnectLocation);

List(ListInterconnectLocationsRequest, CallSettings)

public virtual PagedEnumerable<InterconnectLocationList, InterconnectLocation> List(ListInterconnectLocationsRequest request, CallSettings callSettings = null)

Retrieves the list of interconnect locations available to the specified project.

Parameters
Name	Description
`request`	`ListInterconnectLocationsRequest` 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
`PagedEnumerableInterconnectLocationListInterconnectLocation`	A pageable sequence of InterconnectLocation resources.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = InterconnectLocationsClient.Create();
// Initialize request argument(s)
ListInterconnectLocationsRequest request = new ListInterconnectLocationsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<InterconnectLocationList, InterconnectLocation> response = interconnectLocationsClient.List(request);

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

public virtual PagedEnumerable<InterconnectLocationList, InterconnectLocation> List(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of interconnect locations available to the specified project.

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
`PagedEnumerableInterconnectLocationListInterconnectLocation`	A pageable sequence of InterconnectLocation resources.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = InterconnectLocationsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<InterconnectLocationList, InterconnectLocation> response = interconnectLocationsClient.List(project);

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

public virtual PagedAsyncEnumerable<InterconnectLocationList, InterconnectLocation> ListAsync(ListInterconnectLocationsRequest request, CallSettings callSettings = null)

Retrieves the list of interconnect locations available to the specified project.

Parameters
Name	Description
`request`	`ListInterconnectLocationsRequest` 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
`PagedAsyncEnumerableInterconnectLocationListInterconnectLocation`	A pageable asynchronous sequence of InterconnectLocation resources.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = await InterconnectLocationsClient.CreateAsync();
// Initialize request argument(s)
ListInterconnectLocationsRequest request = new ListInterconnectLocationsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<InterconnectLocationList, InterconnectLocation> response = interconnectLocationsClient.ListAsync(request);

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

public virtual PagedAsyncEnumerable<InterconnectLocationList, InterconnectLocation> ListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of interconnect locations available to the specified project.

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
`PagedAsyncEnumerableInterconnectLocationListInterconnectLocation`	A pageable asynchronous sequence of InterconnectLocation resources.

Example

// Create client
InterconnectLocationsClient interconnectLocationsClient = await InterconnectLocationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<InterconnectLocationList, InterconnectLocation> response = interconnectLocationsClient.ListAsync(project);

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