Compute Engine v1 API - Class InterconnectRemoteLocationsClient (3.1.0)

public abstract class InterconnectRemoteLocationsClient

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

InterconnectRemoteLocations client wrapper, for convenient use.

Inheritance

object > InterconnectRemoteLocationsClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

InterconnectRemoteLocationsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The InterconnectRemoteLocations API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default InterconnectRemoteLocations scopes are:

GrpcClient

public virtual InterconnectRemoteLocations.InterconnectRemoteLocationsClient GrpcClient { get; }

The underlying gRPC InterconnectRemoteLocations client

Property Value
Type	Description
`InterconnectRemoteLocationsInterconnectRemoteLocationsClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static InterconnectRemoteLocationsClient Create()

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

Returns
Type	Description
`InterconnectRemoteLocationsClient`	The created InterconnectRemoteLocationsClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
`TaskInterconnectRemoteLocationsClient`	The task representing the created InterconnectRemoteLocationsClient.

Get(GetInterconnectRemoteLocationRequest, CallSettings)

public virtual InterconnectRemoteLocation Get(GetInterconnectRemoteLocationRequest request, CallSettings callSettings = null)

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

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

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = InterconnectRemoteLocationsClient.Create();
// Initialize request argument(s)
GetInterconnectRemoteLocationRequest request = new GetInterconnectRemoteLocationRequest
{
    Project = "",
    InterconnectRemoteLocation = "",
};
// Make the request
InterconnectRemoteLocation response = interconnectRemoteLocationsClient.Get(request);

Get(string, string, CallSettings)

public virtual InterconnectRemoteLocation Get(string project, string interconnectRemoteLocation, CallSettings callSettings = null)

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

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

Returns
Type	Description
`InterconnectRemoteLocation`	The RPC response.

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = InterconnectRemoteLocationsClient.Create();
// Initialize request argument(s)
string project = "";
string interconnectRemoteLocation = "";
// Make the request
InterconnectRemoteLocation response = interconnectRemoteLocationsClient.Get(project, interconnectRemoteLocation);

GetAsync(GetInterconnectRemoteLocationRequest, CallSettings)

public virtual Task<InterconnectRemoteLocation> GetAsync(GetInterconnectRemoteLocationRequest request, CallSettings callSettings = null)

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

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

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = await InterconnectRemoteLocationsClient.CreateAsync();
// Initialize request argument(s)
GetInterconnectRemoteLocationRequest request = new GetInterconnectRemoteLocationRequest
{
    Project = "",
    InterconnectRemoteLocation = "",
};
// Make the request
InterconnectRemoteLocation response = await interconnectRemoteLocationsClient.GetAsync(request);

GetAsync(GetInterconnectRemoteLocationRequest, CancellationToken)

public virtual Task<InterconnectRemoteLocation> GetAsync(GetInterconnectRemoteLocationRequest request, CancellationToken cancellationToken)

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

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

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

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = await InterconnectRemoteLocationsClient.CreateAsync();
// Initialize request argument(s)
GetInterconnectRemoteLocationRequest request = new GetInterconnectRemoteLocationRequest
{
    Project = "",
    InterconnectRemoteLocation = "",
};
// Make the request
InterconnectRemoteLocation response = await interconnectRemoteLocationsClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<InterconnectRemoteLocation> GetAsync(string project, string interconnectRemoteLocation, CallSettings callSettings = null)

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

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

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

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = await InterconnectRemoteLocationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnectRemoteLocation = "";
// Make the request
InterconnectRemoteLocation response = await interconnectRemoteLocationsClient.GetAsync(project, interconnectRemoteLocation);

GetAsync(string, string, CancellationToken)

public virtual Task<InterconnectRemoteLocation> GetAsync(string project, string interconnectRemoteLocation, CancellationToken cancellationToken)

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

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

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

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = await InterconnectRemoteLocationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnectRemoteLocation = "";
// Make the request
InterconnectRemoteLocation response = await interconnectRemoteLocationsClient.GetAsync(project, interconnectRemoteLocation);

List(ListInterconnectRemoteLocationsRequest, CallSettings)

public virtual PagedEnumerable<InterconnectRemoteLocationList, InterconnectRemoteLocation> List(ListInterconnectRemoteLocationsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListInterconnectRemoteLocationsRequest` 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
`PagedEnumerableInterconnectRemoteLocationListInterconnectRemoteLocation`	A pageable sequence of InterconnectRemoteLocation resources.

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = InterconnectRemoteLocationsClient.Create();
// Initialize request argument(s)
ListInterconnectRemoteLocationsRequest request = new ListInterconnectRemoteLocationsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<InterconnectRemoteLocationList, InterconnectRemoteLocation> response = interconnectRemoteLocationsClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (InterconnectRemoteLocation 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 (InterconnectRemoteLocationList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (InterconnectRemoteLocation 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<InterconnectRemoteLocation> 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 (InterconnectRemoteLocation 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<InterconnectRemoteLocationList, InterconnectRemoteLocation> List(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of interconnect remote 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
`PagedEnumerableInterconnectRemoteLocationListInterconnectRemoteLocation`	A pageable sequence of InterconnectRemoteLocation resources.

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = InterconnectRemoteLocationsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<InterconnectRemoteLocationList, InterconnectRemoteLocation> response = interconnectRemoteLocationsClient.List(project);

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

public virtual PagedAsyncEnumerable<InterconnectRemoteLocationList, InterconnectRemoteLocation> ListAsync(ListInterconnectRemoteLocationsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListInterconnectRemoteLocationsRequest` 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
`PagedAsyncEnumerableInterconnectRemoteLocationListInterconnectRemoteLocation`	A pageable asynchronous sequence of InterconnectRemoteLocation resources.

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = await InterconnectRemoteLocationsClient.CreateAsync();
// Initialize request argument(s)
ListInterconnectRemoteLocationsRequest request = new ListInterconnectRemoteLocationsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<InterconnectRemoteLocationList, InterconnectRemoteLocation> response = interconnectRemoteLocationsClient.ListAsync(request);

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

Retrieves the list of interconnect remote 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
`PagedAsyncEnumerableInterconnectRemoteLocationListInterconnectRemoteLocation`	A pageable asynchronous sequence of InterconnectRemoteLocation resources.

Example

// Create client
InterconnectRemoteLocationsClient interconnectRemoteLocationsClient = await InterconnectRemoteLocationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<InterconnectRemoteLocationList, InterconnectRemoteLocation> response = interconnectRemoteLocationsClient.ListAsync(project);

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