Compute Engine v1 API - Class UrlMapsClient (2.16.0)

public abstract class UrlMapsClient

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

UrlMaps client wrapper, for convenient use.

Inheritance

object > UrlMapsClient

Derived Types

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The UrlMaps API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the UrlMaps 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 UrlMaps 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 UrlMaps.UrlMapsClient GrpcClient { get; }

The underlying gRPC UrlMaps client

Property Value
Type Description
UrlMapsUrlMapsClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient

InvalidateCacheOperationsClient

public virtual OperationsClient InvalidateCacheOperationsClient { get; }

The long-running operations client for InvalidateCache.

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(AggregatedListUrlMapsRequest, CallSettings)

public virtual PagedEnumerable<UrlMapsAggregatedList, KeyValuePair<string, UrlMapsScopedList>> AggregatedList(AggregatedListUrlMapsRequest request, CallSettings callSettings = null)

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListUrlMapsRequest

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
PagedEnumerableUrlMapsAggregatedListKeyValuePairstringUrlMapsScopedList

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

Example
// Create client
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
AggregatedListUrlMapsRequest request = new AggregatedListUrlMapsRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<UrlMapsAggregatedList, KeyValuePair<string, UrlMapsScopedList>> response = urlMapsClient.AggregatedList(request);

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

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
project string

Name of the project scoping 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
PagedEnumerableUrlMapsAggregatedListKeyValuePairstringUrlMapsScopedList

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

Example
// Create client
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<UrlMapsAggregatedList, KeyValuePair<string, UrlMapsScopedList>> response = urlMapsClient.AggregatedList(project);

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

public virtual PagedAsyncEnumerable<UrlMapsAggregatedList, KeyValuePair<string, UrlMapsScopedList>> AggregatedListAsync(AggregatedListUrlMapsRequest request, CallSettings callSettings = null)

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListUrlMapsRequest

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
PagedAsyncEnumerableUrlMapsAggregatedListKeyValuePairstringUrlMapsScopedList

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

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
AggregatedListUrlMapsRequest request = new AggregatedListUrlMapsRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<UrlMapsAggregatedList, KeyValuePair<string, UrlMapsScopedList>> response = urlMapsClient.AggregatedListAsync(request);

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

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
project string

Name of the project scoping 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
PagedAsyncEnumerableUrlMapsAggregatedListKeyValuePairstringUrlMapsScopedList

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

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<UrlMapsAggregatedList, KeyValuePair<string, UrlMapsScopedList>> response = urlMapsClient.AggregatedListAsync(project);

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

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

Returns
Type Description
UrlMapsClient

The created UrlMapsClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskUrlMapsClient

The task representing the created UrlMapsClient.

Delete(DeleteUrlMapRequest, CallSettings)

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

Deletes the specified UrlMap resource.

Parameters
Name Description
request DeleteUrlMapRequest

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
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
DeleteUrlMapRequest request = new DeleteUrlMapRequest
{
    RequestId = "",
    Project = "",
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.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 = urlMapsClient.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, CallSettings)

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

Deletes the specified UrlMap resource.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
string project = "";
string urlMap = "";
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.Delete(project, urlMap);

// 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 = urlMapsClient.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(DeleteUrlMapRequest, CallSettings)

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

Deletes the specified UrlMap resource.

Parameters
Name Description
request DeleteUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
DeleteUrlMapRequest request = new DeleteUrlMapRequest
{
    RequestId = "",
    Project = "",
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.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 urlMapsClient.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(DeleteUrlMapRequest, CancellationToken)

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

Deletes the specified UrlMap resource.

Parameters
Name Description
request DeleteUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
DeleteUrlMapRequest request = new DeleteUrlMapRequest
{
    RequestId = "",
    Project = "",
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.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 urlMapsClient.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, CallSettings)

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

Deletes the specified UrlMap resource.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource 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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.DeleteAsync(project, urlMap);

// 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 urlMapsClient.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, CancellationToken)

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

Deletes the specified UrlMap resource.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to delete.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

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

// 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 urlMapsClient.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(GetUrlMapRequest, CallSettings)

public virtual UrlMap Get(GetUrlMapRequest request, CallSettings callSettings = null)

Returns the specified UrlMap resource.

Parameters
Name Description
request GetUrlMapRequest

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
UrlMap

The RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
GetUrlMapRequest request = new GetUrlMapRequest
{
    Project = "",
    UrlMap = "",
};
// Make the request
UrlMap response = urlMapsClient.Get(request);

Get(string, string, CallSettings)

public virtual UrlMap Get(string project, string urlMap, CallSettings callSettings = null)

Returns the specified UrlMap resource.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UrlMap

The RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
string project = "";
string urlMap = "";
// Make the request
UrlMap response = urlMapsClient.Get(project, urlMap);

GetAsync(GetUrlMapRequest, CallSettings)

public virtual Task<UrlMap> GetAsync(GetUrlMapRequest request, CallSettings callSettings = null)

Returns the specified UrlMap resource.

Parameters
Name Description
request GetUrlMapRequest

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
TaskUrlMap

A Task containing the RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
GetUrlMapRequest request = new GetUrlMapRequest
{
    Project = "",
    UrlMap = "",
};
// Make the request
UrlMap response = await urlMapsClient.GetAsync(request);

GetAsync(GetUrlMapRequest, CancellationToken)

public virtual Task<UrlMap> GetAsync(GetUrlMapRequest request, CancellationToken cancellationToken)

Returns the specified UrlMap resource.

Parameters
Name Description
request GetUrlMapRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskUrlMap

A Task containing the RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
GetUrlMapRequest request = new GetUrlMapRequest
{
    Project = "",
    UrlMap = "",
};
// Make the request
UrlMap response = await urlMapsClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<UrlMap> GetAsync(string project, string urlMap, CallSettings callSettings = null)

Returns the specified UrlMap resource.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskUrlMap

A Task containing the RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
// Make the request
UrlMap response = await urlMapsClient.GetAsync(project, urlMap);

GetAsync(string, string, CancellationToken)

public virtual Task<UrlMap> GetAsync(string project, string urlMap, CancellationToken cancellationToken)

Returns the specified UrlMap resource.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to return.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskUrlMap

A Task containing the RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
// Make the request
UrlMap response = await urlMapsClient.GetAsync(project, urlMap);

Insert(InsertUrlMapRequest, CallSettings)

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

Creates a UrlMap resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertUrlMapRequest

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
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
InsertUrlMapRequest request = new InsertUrlMapRequest
{
    RequestId = "",
    UrlMapResource = new UrlMap(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.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 = urlMapsClient.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, UrlMap, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, UrlMap urlMapResource, CallSettings callSettings = null)

Creates a UrlMap resource in the specified project using the data included in the request.

Parameters
Name Description
project string

Project ID for this request.

urlMapResource UrlMap

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
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
string project = "";
UrlMap urlMapResource = new UrlMap();
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.Insert(project, urlMapResource);

// 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 = urlMapsClient.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(InsertUrlMapRequest, CallSettings)

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

Creates a UrlMap resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
InsertUrlMapRequest request = new InsertUrlMapRequest
{
    RequestId = "",
    UrlMapResource = new UrlMap(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.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 urlMapsClient.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(InsertUrlMapRequest, CancellationToken)

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

Creates a UrlMap resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
InsertUrlMapRequest request = new InsertUrlMapRequest
{
    RequestId = "",
    UrlMapResource = new UrlMap(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.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 urlMapsClient.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, UrlMap, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, UrlMap urlMapResource, CallSettings callSettings = null)

Creates a UrlMap resource in the specified project using the data included in the request.

Parameters
Name Description
project string

Project ID for this request.

urlMapResource UrlMap

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
UrlMap urlMapResource = new UrlMap();
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.InsertAsync(project, urlMapResource);

// 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 urlMapsClient.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, UrlMap, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, UrlMap urlMapResource, CancellationToken cancellationToken)

Creates a UrlMap resource in the specified project using the data included in the request.

Parameters
Name Description
project string

Project ID for this request.

urlMapResource UrlMap

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
UrlMap urlMapResource = new UrlMap();
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.InsertAsync(project, urlMapResource);

// 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 urlMapsClient.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;
}

InvalidateCache(InvalidateCacheUrlMapRequest, CallSettings)

public virtual Operation<Operation, Operation> InvalidateCache(InvalidateCacheUrlMapRequest request, CallSettings callSettings = null)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Parameters
Name Description
request InvalidateCacheUrlMapRequest

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
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
InvalidateCacheUrlMapRequest request = new InvalidateCacheUrlMapRequest
{
    RequestId = "",
    Project = "",
    CacheInvalidationRuleResource = new CacheInvalidationRule(),
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.InvalidateCache(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 = urlMapsClient.PollOnceInvalidateCache(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;
}

InvalidateCache(string, string, CacheInvalidationRule, CallSettings)

public virtual Operation<Operation, Operation> InvalidateCache(string project, string urlMap, CacheInvalidationRule cacheInvalidationRuleResource, CallSettings callSettings = null)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap scoping this request.

cacheInvalidationRuleResource CacheInvalidationRule

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
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
string project = "";
string urlMap = "";
CacheInvalidationRule cacheInvalidationRuleResource = new CacheInvalidationRule();
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.InvalidateCache(project, urlMap, cacheInvalidationRuleResource);

// 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 = urlMapsClient.PollOnceInvalidateCache(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;
}

InvalidateCacheAsync(InvalidateCacheUrlMapRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> InvalidateCacheAsync(InvalidateCacheUrlMapRequest request, CallSettings callSettings = null)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Parameters
Name Description
request InvalidateCacheUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
InvalidateCacheUrlMapRequest request = new InvalidateCacheUrlMapRequest
{
    RequestId = "",
    Project = "",
    CacheInvalidationRuleResource = new CacheInvalidationRule(),
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.InvalidateCacheAsync(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 urlMapsClient.PollOnceInvalidateCacheAsync(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;
}

InvalidateCacheAsync(InvalidateCacheUrlMapRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InvalidateCacheAsync(InvalidateCacheUrlMapRequest request, CancellationToken cancellationToken)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Parameters
Name Description
request InvalidateCacheUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
InvalidateCacheUrlMapRequest request = new InvalidateCacheUrlMapRequest
{
    RequestId = "",
    Project = "",
    CacheInvalidationRuleResource = new CacheInvalidationRule(),
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.InvalidateCacheAsync(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 urlMapsClient.PollOnceInvalidateCacheAsync(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;
}

InvalidateCacheAsync(string, string, CacheInvalidationRule, CallSettings)

public virtual Task<Operation<Operation, Operation>> InvalidateCacheAsync(string project, string urlMap, CacheInvalidationRule cacheInvalidationRuleResource, CallSettings callSettings = null)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap scoping this request.

cacheInvalidationRuleResource CacheInvalidationRule

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
CacheInvalidationRule cacheInvalidationRuleResource = new CacheInvalidationRule();
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.InvalidateCacheAsync(project, urlMap, cacheInvalidationRuleResource);

// 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 urlMapsClient.PollOnceInvalidateCacheAsync(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;
}

InvalidateCacheAsync(string, string, CacheInvalidationRule, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InvalidateCacheAsync(string project, string urlMap, CacheInvalidationRule cacheInvalidationRuleResource, CancellationToken cancellationToken)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap scoping this request.

cacheInvalidationRuleResource CacheInvalidationRule

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
CacheInvalidationRule cacheInvalidationRuleResource = new CacheInvalidationRule();
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.InvalidateCacheAsync(project, urlMap, cacheInvalidationRuleResource);

// 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 urlMapsClient.PollOnceInvalidateCacheAsync(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(ListUrlMapsRequest, CallSettings)

public virtual PagedEnumerable<UrlMapList, UrlMap> List(ListUrlMapsRequest request, CallSettings callSettings = null)

Retrieves the list of UrlMap resources available to the specified project.

Parameters
Name Description
request ListUrlMapsRequest

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
PagedEnumerableUrlMapListUrlMap

A pageable sequence of UrlMap resources.

Example
// Create client
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
ListUrlMapsRequest request = new ListUrlMapsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<UrlMapList, UrlMap> response = urlMapsClient.List(request);

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

Retrieves the list of UrlMap resources 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
PagedEnumerableUrlMapListUrlMap

A pageable sequence of UrlMap resources.

Example
// Create client
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<UrlMapList, UrlMap> response = urlMapsClient.List(project);

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

public virtual PagedAsyncEnumerable<UrlMapList, UrlMap> ListAsync(ListUrlMapsRequest request, CallSettings callSettings = null)

Retrieves the list of UrlMap resources available to the specified project.

Parameters
Name Description
request ListUrlMapsRequest

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
PagedAsyncEnumerableUrlMapListUrlMap

A pageable asynchronous sequence of UrlMap resources.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
ListUrlMapsRequest request = new ListUrlMapsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<UrlMapList, UrlMap> response = urlMapsClient.ListAsync(request);

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

Retrieves the list of UrlMap resources 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
PagedAsyncEnumerableUrlMapListUrlMap

A pageable asynchronous sequence of UrlMap resources.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<UrlMapList, UrlMap> response = urlMapsClient.ListAsync(project);

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

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

Patches the specified UrlMap resource with 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 PatchUrlMapRequest

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
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
PatchUrlMapRequest request = new PatchUrlMapRequest
{
    RequestId = "",
    UrlMapResource = new UrlMap(),
    Project = "",
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.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 = urlMapsClient.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, UrlMap, CallSettings)

public virtual Operation<Operation, Operation> Patch(string project, string urlMap, UrlMap urlMapResource, CallSettings callSettings = null)

Patches the specified UrlMap resource with 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.

urlMap string

Name of the UrlMap resource to patch.

urlMapResource UrlMap

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
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
string project = "";
string urlMap = "";
UrlMap urlMapResource = new UrlMap();
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.Patch(project, urlMap, urlMapResource);

// 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 = urlMapsClient.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(PatchUrlMapRequest, CallSettings)

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

Patches the specified UrlMap resource with 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 PatchUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
PatchUrlMapRequest request = new PatchUrlMapRequest
{
    RequestId = "",
    UrlMapResource = new UrlMap(),
    Project = "",
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.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 urlMapsClient.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(PatchUrlMapRequest, CancellationToken)

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

Patches the specified UrlMap resource with 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 PatchUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
PatchUrlMapRequest request = new PatchUrlMapRequest
{
    RequestId = "",
    UrlMapResource = new UrlMap(),
    Project = "",
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.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 urlMapsClient.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, UrlMap, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string urlMap, UrlMap urlMapResource, CallSettings callSettings = null)

Patches the specified UrlMap resource with 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.

urlMap string

Name of the UrlMap resource to patch.

urlMapResource UrlMap

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
UrlMap urlMapResource = new UrlMap();
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.PatchAsync(project, urlMap, urlMapResource);

// 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 urlMapsClient.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, UrlMap, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string urlMap, UrlMap urlMapResource, CancellationToken cancellationToken)

Patches the specified UrlMap resource with 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.

urlMap string

Name of the UrlMap resource to patch.

urlMapResource UrlMap

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
UrlMap urlMapResource = new UrlMap();
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.PatchAsync(project, urlMap, urlMapResource);

// 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 urlMapsClient.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.

PollOnceInvalidateCache(string, CallSettings)

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

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

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.

PollOnceInvalidateCacheAsync(string, CallSettings)

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

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

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(UpdateUrlMapRequest, CallSettings)

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

Updates the specified UrlMap resource with the data included in the request.

Parameters
Name Description
request UpdateUrlMapRequest

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
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
UpdateUrlMapRequest request = new UpdateUrlMapRequest
{
    RequestId = "",
    UrlMapResource = new UrlMap(),
    Project = "",
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.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 = urlMapsClient.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, UrlMap, CallSettings)

public virtual Operation<Operation, Operation> Update(string project, string urlMap, UrlMap urlMapResource, CallSettings callSettings = null)

Updates the specified UrlMap resource with the data included in the request.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to update.

urlMapResource UrlMap

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
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
string project = "";
string urlMap = "";
UrlMap urlMapResource = new UrlMap();
// Make the request
lro::Operation<Operation, Operation> response = urlMapsClient.Update(project, urlMap, urlMapResource);

// 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 = urlMapsClient.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(UpdateUrlMapRequest, CallSettings)

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

Updates the specified UrlMap resource with the data included in the request.

Parameters
Name Description
request UpdateUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
UpdateUrlMapRequest request = new UpdateUrlMapRequest
{
    RequestId = "",
    UrlMapResource = new UrlMap(),
    Project = "",
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.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 urlMapsClient.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(UpdateUrlMapRequest, CancellationToken)

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

Updates the specified UrlMap resource with the data included in the request.

Parameters
Name Description
request UpdateUrlMapRequest

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
UpdateUrlMapRequest request = new UpdateUrlMapRequest
{
    RequestId = "",
    UrlMapResource = new UrlMap(),
    Project = "",
    UrlMap = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.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 urlMapsClient.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, UrlMap, CallSettings)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(string project, string urlMap, UrlMap urlMapResource, CallSettings callSettings = null)

Updates the specified UrlMap resource with the data included in the request.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to update.

urlMapResource UrlMap

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
UrlMap urlMapResource = new UrlMap();
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.UpdateAsync(project, urlMap, urlMapResource);

// 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 urlMapsClient.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, UrlMap, CancellationToken)

public virtual Task<Operation<Operation, Operation>> UpdateAsync(string project, string urlMap, UrlMap urlMapResource, CancellationToken cancellationToken)

Updates the specified UrlMap resource with the data included in the request.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to update.

urlMapResource UrlMap

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
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
UrlMap urlMapResource = new UrlMap();
// Make the request
lro::Operation<Operation, Operation> response = await urlMapsClient.UpdateAsync(project, urlMap, urlMapResource);

// 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 urlMapsClient.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;
}

Validate(ValidateUrlMapRequest, CallSettings)

public virtual UrlMapsValidateResponse Validate(ValidateUrlMapRequest request, CallSettings callSettings = null)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
Name Description
request ValidateUrlMapRequest

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
UrlMapsValidateResponse

The RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
ValidateUrlMapRequest request = new ValidateUrlMapRequest
{
    Project = "",
    UrlMap = "",
    UrlMapsValidateRequestResource = new UrlMapsValidateRequest(),
};
// Make the request
UrlMapsValidateResponse response = urlMapsClient.Validate(request);

Validate(string, string, UrlMapsValidateRequest, CallSettings)

public virtual UrlMapsValidateResponse Validate(string project, string urlMap, UrlMapsValidateRequest urlMapsValidateRequestResource, CallSettings callSettings = null)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to be validated as.

urlMapsValidateRequestResource UrlMapsValidateRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UrlMapsValidateResponse

The RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = UrlMapsClient.Create();
// Initialize request argument(s)
string project = "";
string urlMap = "";
UrlMapsValidateRequest urlMapsValidateRequestResource = new UrlMapsValidateRequest();
// Make the request
UrlMapsValidateResponse response = urlMapsClient.Validate(project, urlMap, urlMapsValidateRequestResource);

ValidateAsync(ValidateUrlMapRequest, CallSettings)

public virtual Task<UrlMapsValidateResponse> ValidateAsync(ValidateUrlMapRequest request, CallSettings callSettings = null)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
Name Description
request ValidateUrlMapRequest

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
TaskUrlMapsValidateResponse

A Task containing the RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
ValidateUrlMapRequest request = new ValidateUrlMapRequest
{
    Project = "",
    UrlMap = "",
    UrlMapsValidateRequestResource = new UrlMapsValidateRequest(),
};
// Make the request
UrlMapsValidateResponse response = await urlMapsClient.ValidateAsync(request);

ValidateAsync(ValidateUrlMapRequest, CancellationToken)

public virtual Task<UrlMapsValidateResponse> ValidateAsync(ValidateUrlMapRequest request, CancellationToken cancellationToken)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
Name Description
request ValidateUrlMapRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskUrlMapsValidateResponse

A Task containing the RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
ValidateUrlMapRequest request = new ValidateUrlMapRequest
{
    Project = "",
    UrlMap = "",
    UrlMapsValidateRequestResource = new UrlMapsValidateRequest(),
};
// Make the request
UrlMapsValidateResponse response = await urlMapsClient.ValidateAsync(request);

ValidateAsync(string, string, UrlMapsValidateRequest, CallSettings)

public virtual Task<UrlMapsValidateResponse> ValidateAsync(string project, string urlMap, UrlMapsValidateRequest urlMapsValidateRequestResource, CallSettings callSettings = null)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to be validated as.

urlMapsValidateRequestResource UrlMapsValidateRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskUrlMapsValidateResponse

A Task containing the RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
UrlMapsValidateRequest urlMapsValidateRequestResource = new UrlMapsValidateRequest();
// Make the request
UrlMapsValidateResponse response = await urlMapsClient.ValidateAsync(project, urlMap, urlMapsValidateRequestResource);

ValidateAsync(string, string, UrlMapsValidateRequest, CancellationToken)

public virtual Task<UrlMapsValidateResponse> ValidateAsync(string project, string urlMap, UrlMapsValidateRequest urlMapsValidateRequestResource, CancellationToken cancellationToken)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
Name Description
project string

Project ID for this request.

urlMap string

Name of the UrlMap resource to be validated as.

urlMapsValidateRequestResource UrlMapsValidateRequest

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskUrlMapsValidateResponse

A Task containing the RPC response.

Example
// Create client
UrlMapsClient urlMapsClient = await UrlMapsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string urlMap = "";
UrlMapsValidateRequest urlMapsValidateRequestResource = new UrlMapsValidateRequest();
// Make the request
UrlMapsValidateResponse response = await urlMapsClient.ValidateAsync(project, urlMap, urlMapsValidateRequestResource);