Compute Engine v1 API - Class PublicAdvertisedPrefixesClient (2.16.0)

public abstract class PublicAdvertisedPrefixesClient

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

PublicAdvertisedPrefixes client wrapper, for convenient use.

Inheritance

object > PublicAdvertisedPrefixesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The PublicAdvertisedPrefixes API.

Properties

AnnounceOperationsClient

public virtual OperationsClient AnnounceOperationsClient { get; }

The long-running operations client for Announce.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
IReadOnlyListstring
Remarks

The default PublicAdvertisedPrefixes scopes are:

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual PublicAdvertisedPrefixes.PublicAdvertisedPrefixesClient GrpcClient { get; }

The underlying gRPC PublicAdvertisedPrefixes client

Property Value
Type Description
PublicAdvertisedPrefixesPublicAdvertisedPrefixesClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient

PatchOperationsClient

public virtual OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

WithdrawOperationsClient

public virtual OperationsClient WithdrawOperationsClient { get; }

The long-running operations client for Withdraw.

Property Value
Type Description
OperationsClient

Methods

Announce(AnnouncePublicAdvertisedPrefixeRequest, CallSettings)

public virtual Operation<Operation, Operation> Announce(AnnouncePublicAdvertisedPrefixeRequest request, CallSettings callSettings = null)

Announces the specified PublicAdvertisedPrefix

Parameters
Name Description
request AnnouncePublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
AnnouncePublicAdvertisedPrefixeRequest request = new AnnouncePublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.Announce(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 = publicAdvertisedPrefixesClient.PollOnceAnnounce(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;
}

Announce(string, string, CallSettings)

public virtual Operation<Operation, Operation> Announce(string project, string publicAdvertisedPrefix, CallSettings callSettings = null)

Announces the specified PublicAdvertisedPrefix

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

The name of the public advertised prefix. It should comply with RFC1035.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.Announce(project, publicAdvertisedPrefix);

// 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 = publicAdvertisedPrefixesClient.PollOnceAnnounce(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;
}

AnnounceAsync(AnnouncePublicAdvertisedPrefixeRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> AnnounceAsync(AnnouncePublicAdvertisedPrefixeRequest request, CallSettings callSettings = null)

Announces the specified PublicAdvertisedPrefix

Parameters
Name Description
request AnnouncePublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
AnnouncePublicAdvertisedPrefixeRequest request = new AnnouncePublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.AnnounceAsync(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 publicAdvertisedPrefixesClient.PollOnceAnnounceAsync(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;
}

AnnounceAsync(AnnouncePublicAdvertisedPrefixeRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> AnnounceAsync(AnnouncePublicAdvertisedPrefixeRequest request, CancellationToken cancellationToken)

Announces the specified PublicAdvertisedPrefix

Parameters
Name Description
request AnnouncePublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
AnnouncePublicAdvertisedPrefixeRequest request = new AnnouncePublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.AnnounceAsync(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 publicAdvertisedPrefixesClient.PollOnceAnnounceAsync(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;
}

AnnounceAsync(string, string, CallSettings)

public virtual Task<Operation<Operation, Operation>> AnnounceAsync(string project, string publicAdvertisedPrefix, CallSettings callSettings = null)

Announces the specified PublicAdvertisedPrefix

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

The name of the public advertised prefix. It should comply with RFC1035.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.AnnounceAsync(project, publicAdvertisedPrefix);

// 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 publicAdvertisedPrefixesClient.PollOnceAnnounceAsync(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;
}

AnnounceAsync(string, string, CancellationToken)

public virtual Task<Operation<Operation, Operation>> AnnounceAsync(string project, string publicAdvertisedPrefix, CancellationToken cancellationToken)

Announces the specified PublicAdvertisedPrefix

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

The name of the public advertised prefix. It should comply with RFC1035.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.AnnounceAsync(project, publicAdvertisedPrefix);

// 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 publicAdvertisedPrefixesClient.PollOnceAnnounceAsync(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;
}

Create()

public static PublicAdvertisedPrefixesClient Create()

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

Returns
Type Description
PublicAdvertisedPrefixesClient

The created PublicAdvertisedPrefixesClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskPublicAdvertisedPrefixesClient

The task representing the created PublicAdvertisedPrefixesClient.

Delete(DeletePublicAdvertisedPrefixeRequest, CallSettings)

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

Deletes the specified PublicAdvertisedPrefix

Parameters
Name Description
request DeletePublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
DeletePublicAdvertisedPrefixeRequest request = new DeletePublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.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 = publicAdvertisedPrefixesClient.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 publicAdvertisedPrefix, CallSettings callSettings = null)

Deletes the specified PublicAdvertisedPrefix

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

Name of the PublicAdvertisedPrefix resource to delete.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.Delete(project, publicAdvertisedPrefix);

// 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 = publicAdvertisedPrefixesClient.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(DeletePublicAdvertisedPrefixeRequest, CallSettings)

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

Deletes the specified PublicAdvertisedPrefix

Parameters
Name Description
request DeletePublicAdvertisedPrefixeRequest

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

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

Deletes the specified PublicAdvertisedPrefix

Parameters
Name Description
request DeletePublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
DeletePublicAdvertisedPrefixeRequest request = new DeletePublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.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 publicAdvertisedPrefixesClient.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 publicAdvertisedPrefix, CallSettings callSettings = null)

Deletes the specified PublicAdvertisedPrefix

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

Name of the PublicAdvertisedPrefix 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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.DeleteAsync(project, publicAdvertisedPrefix);

// 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 publicAdvertisedPrefixesClient.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 publicAdvertisedPrefix, CancellationToken cancellationToken)

Deletes the specified PublicAdvertisedPrefix

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

Name of the PublicAdvertisedPrefix 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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.DeleteAsync(project, publicAdvertisedPrefix);

// 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 publicAdvertisedPrefixesClient.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(GetPublicAdvertisedPrefixeRequest, CallSettings)

public virtual PublicAdvertisedPrefix Get(GetPublicAdvertisedPrefixeRequest request, CallSettings callSettings = null)

Returns the specified PublicAdvertisedPrefix resource.

Parameters
Name Description
request GetPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefix

The RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
GetPublicAdvertisedPrefixeRequest request = new GetPublicAdvertisedPrefixeRequest
{
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
PublicAdvertisedPrefix response = publicAdvertisedPrefixesClient.Get(request);

Get(string, string, CallSettings)

public virtual PublicAdvertisedPrefix Get(string project, string publicAdvertisedPrefix, CallSettings callSettings = null)

Returns the specified PublicAdvertisedPrefix resource.

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

Name of the PublicAdvertisedPrefix resource to return.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PublicAdvertisedPrefix

The RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
PublicAdvertisedPrefix response = publicAdvertisedPrefixesClient.Get(project, publicAdvertisedPrefix);

GetAsync(GetPublicAdvertisedPrefixeRequest, CallSettings)

public virtual Task<PublicAdvertisedPrefix> GetAsync(GetPublicAdvertisedPrefixeRequest request, CallSettings callSettings = null)

Returns the specified PublicAdvertisedPrefix resource.

Parameters
Name Description
request GetPublicAdvertisedPrefixeRequest

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
TaskPublicAdvertisedPrefix

A Task containing the RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
GetPublicAdvertisedPrefixeRequest request = new GetPublicAdvertisedPrefixeRequest
{
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
PublicAdvertisedPrefix response = await publicAdvertisedPrefixesClient.GetAsync(request);

GetAsync(GetPublicAdvertisedPrefixeRequest, CancellationToken)

public virtual Task<PublicAdvertisedPrefix> GetAsync(GetPublicAdvertisedPrefixeRequest request, CancellationToken cancellationToken)

Returns the specified PublicAdvertisedPrefix resource.

Parameters
Name Description
request GetPublicAdvertisedPrefixeRequest

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskPublicAdvertisedPrefix

A Task containing the RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
GetPublicAdvertisedPrefixeRequest request = new GetPublicAdvertisedPrefixeRequest
{
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
PublicAdvertisedPrefix response = await publicAdvertisedPrefixesClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<PublicAdvertisedPrefix> GetAsync(string project, string publicAdvertisedPrefix, CallSettings callSettings = null)

Returns the specified PublicAdvertisedPrefix resource.

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

Name of the PublicAdvertisedPrefix resource to return.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPublicAdvertisedPrefix

A Task containing the RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
PublicAdvertisedPrefix response = await publicAdvertisedPrefixesClient.GetAsync(project, publicAdvertisedPrefix);

GetAsync(string, string, CancellationToken)

public virtual Task<PublicAdvertisedPrefix> GetAsync(string project, string publicAdvertisedPrefix, CancellationToken cancellationToken)

Returns the specified PublicAdvertisedPrefix resource.

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

Name of the PublicAdvertisedPrefix resource to return.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskPublicAdvertisedPrefix

A Task containing the RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
PublicAdvertisedPrefix response = await publicAdvertisedPrefixesClient.GetAsync(project, publicAdvertisedPrefix);

Insert(InsertPublicAdvertisedPrefixeRequest, CallSettings)

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

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
Name Description
request InsertPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
InsertPublicAdvertisedPrefixeRequest request = new InsertPublicAdvertisedPrefixeRequest
{
    RequestId = "",
    Project = "",
    PublicAdvertisedPrefixResource = new PublicAdvertisedPrefix(),
};
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.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 = publicAdvertisedPrefixesClient.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, PublicAdvertisedPrefix, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, PublicAdvertisedPrefix publicAdvertisedPrefixResource, CallSettings callSettings = null)

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefixResource PublicAdvertisedPrefix

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
string project = "";
PublicAdvertisedPrefix publicAdvertisedPrefixResource = new PublicAdvertisedPrefix();
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.Insert(project, publicAdvertisedPrefixResource);

// 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 = publicAdvertisedPrefixesClient.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(InsertPublicAdvertisedPrefixeRequest, CallSettings)

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

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
Name Description
request InsertPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
InsertPublicAdvertisedPrefixeRequest request = new InsertPublicAdvertisedPrefixeRequest
{
    RequestId = "",
    Project = "",
    PublicAdvertisedPrefixResource = new PublicAdvertisedPrefix(),
};
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.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 publicAdvertisedPrefixesClient.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(InsertPublicAdvertisedPrefixeRequest, CancellationToken)

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

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
Name Description
request InsertPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
InsertPublicAdvertisedPrefixeRequest request = new InsertPublicAdvertisedPrefixeRequest
{
    RequestId = "",
    Project = "",
    PublicAdvertisedPrefixResource = new PublicAdvertisedPrefix(),
};
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.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 publicAdvertisedPrefixesClient.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, PublicAdvertisedPrefix, CallSettings)

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

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefixResource PublicAdvertisedPrefix

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

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

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, PublicAdvertisedPrefix publicAdvertisedPrefixResource, CancellationToken cancellationToken)

Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefixResource PublicAdvertisedPrefix

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

// 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 publicAdvertisedPrefixesClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

List(ListPublicAdvertisedPrefixesRequest, CallSettings)

public virtual PagedEnumerable<PublicAdvertisedPrefixList, PublicAdvertisedPrefix> List(ListPublicAdvertisedPrefixesRequest request, CallSettings callSettings = null)

Lists the PublicAdvertisedPrefixes for a project.

Parameters
Name Description
request ListPublicAdvertisedPrefixesRequest

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
PagedEnumerablePublicAdvertisedPrefixListPublicAdvertisedPrefix

A pageable sequence of PublicAdvertisedPrefix resources.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
ListPublicAdvertisedPrefixesRequest request = new ListPublicAdvertisedPrefixesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<PublicAdvertisedPrefixList, PublicAdvertisedPrefix> response = publicAdvertisedPrefixesClient.List(request);

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

Lists the PublicAdvertisedPrefixes for a 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
PagedEnumerablePublicAdvertisedPrefixListPublicAdvertisedPrefix

A pageable sequence of PublicAdvertisedPrefix resources.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<PublicAdvertisedPrefixList, PublicAdvertisedPrefix> response = publicAdvertisedPrefixesClient.List(project);

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

public virtual PagedAsyncEnumerable<PublicAdvertisedPrefixList, PublicAdvertisedPrefix> ListAsync(ListPublicAdvertisedPrefixesRequest request, CallSettings callSettings = null)

Lists the PublicAdvertisedPrefixes for a project.

Parameters
Name Description
request ListPublicAdvertisedPrefixesRequest

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
PagedAsyncEnumerablePublicAdvertisedPrefixListPublicAdvertisedPrefix

A pageable asynchronous sequence of PublicAdvertisedPrefix resources.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
ListPublicAdvertisedPrefixesRequest request = new ListPublicAdvertisedPrefixesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<PublicAdvertisedPrefixList, PublicAdvertisedPrefix> response = publicAdvertisedPrefixesClient.ListAsync(request);

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

Lists the PublicAdvertisedPrefixes for a 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
PagedAsyncEnumerablePublicAdvertisedPrefixListPublicAdvertisedPrefix

A pageable asynchronous sequence of PublicAdvertisedPrefix resources.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<PublicAdvertisedPrefixList, PublicAdvertisedPrefix> response = publicAdvertisedPrefixesClient.ListAsync(project);

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

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

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
Name Description
request PatchPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
PatchPublicAdvertisedPrefixeRequest request = new PatchPublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
    PublicAdvertisedPrefixResource = new PublicAdvertisedPrefix(),
};
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.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 = publicAdvertisedPrefixesClient.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, PublicAdvertisedPrefix, CallSettings)

public virtual Operation<Operation, Operation> Patch(string project, string publicAdvertisedPrefix, PublicAdvertisedPrefix publicAdvertisedPrefixResource, CallSettings callSettings = null)

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

Name of the PublicAdvertisedPrefix resource to patch.
publicAdvertisedPrefixResource PublicAdvertisedPrefix

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
PublicAdvertisedPrefix publicAdvertisedPrefixResource = new PublicAdvertisedPrefix();
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.Patch(project, publicAdvertisedPrefix, publicAdvertisedPrefixResource);

// 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 = publicAdvertisedPrefixesClient.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(PatchPublicAdvertisedPrefixeRequest, CallSettings)

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

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
Name Description
request PatchPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
PatchPublicAdvertisedPrefixeRequest request = new PatchPublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
    PublicAdvertisedPrefixResource = new PublicAdvertisedPrefix(),
};
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.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 publicAdvertisedPrefixesClient.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(PatchPublicAdvertisedPrefixeRequest, CancellationToken)

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

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
Name Description
request PatchPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
PatchPublicAdvertisedPrefixeRequest request = new PatchPublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
    PublicAdvertisedPrefixResource = new PublicAdvertisedPrefix(),
};
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.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 publicAdvertisedPrefixesClient.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, PublicAdvertisedPrefix, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string publicAdvertisedPrefix, PublicAdvertisedPrefix publicAdvertisedPrefixResource, CallSettings callSettings = null)

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

Name of the PublicAdvertisedPrefix resource to patch.
publicAdvertisedPrefixResource PublicAdvertisedPrefix

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
PublicAdvertisedPrefix publicAdvertisedPrefixResource = new PublicAdvertisedPrefix();
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.PatchAsync(project, publicAdvertisedPrefix, publicAdvertisedPrefixResource);

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

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string publicAdvertisedPrefix, PublicAdvertisedPrefix publicAdvertisedPrefixResource, CancellationToken cancellationToken)

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

Name of the PublicAdvertisedPrefix resource to patch.
publicAdvertisedPrefixResource PublicAdvertisedPrefix

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
PublicAdvertisedPrefix publicAdvertisedPrefixResource = new PublicAdvertisedPrefix();
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.PatchAsync(project, publicAdvertisedPrefix, publicAdvertisedPrefixResource);

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

PollOnceAnnounce(string, CallSettings)

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

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

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.

PollOnceAnnounceAsync(string, CallSettings)

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

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

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.

PollOnceDelete(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceDeleteAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceInsert(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceInsertAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOncePatch(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOncePatchAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceWithdraw(string, CallSettings)

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

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

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.

PollOnceWithdrawAsync(string, CallSettings)

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

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

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.

Withdraw(WithdrawPublicAdvertisedPrefixeRequest, CallSettings)

public virtual Operation<Operation, Operation> Withdraw(WithdrawPublicAdvertisedPrefixeRequest request, CallSettings callSettings = null)

Withdraws the specified PublicAdvertisedPrefix

Parameters
Name Description
request WithdrawPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
WithdrawPublicAdvertisedPrefixeRequest request = new WithdrawPublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.Withdraw(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 = publicAdvertisedPrefixesClient.PollOnceWithdraw(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;
}

Withdraw(string, string, CallSettings)

public virtual Operation<Operation, Operation> Withdraw(string project, string publicAdvertisedPrefix, CallSettings callSettings = null)

Withdraws the specified PublicAdvertisedPrefix

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

The name of the public advertised prefix. It should comply with RFC1035.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = PublicAdvertisedPrefixesClient.Create();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
lro::Operation<Operation, Operation> response = publicAdvertisedPrefixesClient.Withdraw(project, publicAdvertisedPrefix);

// 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 = publicAdvertisedPrefixesClient.PollOnceWithdraw(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;
}

WithdrawAsync(WithdrawPublicAdvertisedPrefixeRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> WithdrawAsync(WithdrawPublicAdvertisedPrefixeRequest request, CallSettings callSettings = null)

Withdraws the specified PublicAdvertisedPrefix

Parameters
Name Description
request WithdrawPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
WithdrawPublicAdvertisedPrefixeRequest request = new WithdrawPublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.WithdrawAsync(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 publicAdvertisedPrefixesClient.PollOnceWithdrawAsync(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;
}

WithdrawAsync(WithdrawPublicAdvertisedPrefixeRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> WithdrawAsync(WithdrawPublicAdvertisedPrefixeRequest request, CancellationToken cancellationToken)

Withdraws the specified PublicAdvertisedPrefix

Parameters
Name Description
request WithdrawPublicAdvertisedPrefixeRequest

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
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
WithdrawPublicAdvertisedPrefixeRequest request = new WithdrawPublicAdvertisedPrefixeRequest
{
    RequestId = "",
    PublicAdvertisedPrefix = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.WithdrawAsync(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 publicAdvertisedPrefixesClient.PollOnceWithdrawAsync(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;
}

WithdrawAsync(string, string, CallSettings)

public virtual Task<Operation<Operation, Operation>> WithdrawAsync(string project, string publicAdvertisedPrefix, CallSettings callSettings = null)

Withdraws the specified PublicAdvertisedPrefix

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

The name of the public advertised prefix. It should comply with RFC1035.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.WithdrawAsync(project, publicAdvertisedPrefix);

// 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 publicAdvertisedPrefixesClient.PollOnceWithdrawAsync(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;
}

WithdrawAsync(string, string, CancellationToken)

public virtual Task<Operation<Operation, Operation>> WithdrawAsync(string project, string publicAdvertisedPrefix, CancellationToken cancellationToken)

Withdraws the specified PublicAdvertisedPrefix

Parameters
Name Description
project string

Project ID for this request.
publicAdvertisedPrefix string

The name of the public advertised prefix. It should comply with RFC1035.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Example 
// Create client
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient = await PublicAdvertisedPrefixesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string publicAdvertisedPrefix = "";
// Make the request
lro::Operation<Operation, Operation> response = await publicAdvertisedPrefixesClient.WithdrawAsync(project, publicAdvertisedPrefix);

// 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 publicAdvertisedPrefixesClient.PollOnceWithdrawAsync(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;
}