Compute Engine v1 API - Class SslCertificatesClient (2.16.0)

public abstract class SslCertificatesClient

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

SslCertificates client wrapper, for convenient use.

Inheritance

object > SslCertificatesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The SslCertificates API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
IReadOnlyListstring
Remarks

The default SslCertificates scopes are:

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual SslCertificates.SslCertificatesClient GrpcClient { get; }

The underlying gRPC SslCertificates client

Property Value
Type Description
SslCertificatesSslCertificatesClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

AggregatedList(AggregatedListSslCertificatesRequest, CallSettings)

public virtual PagedEnumerable<SslCertificateAggregatedList, KeyValuePair<string, SslCertificatesScopedList>> AggregatedList(AggregatedListSslCertificatesRequest request, CallSettings callSettings = null)

Retrieves the list of all SslCertificate 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 AggregatedListSslCertificatesRequest

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
PagedEnumerableSslCertificateAggregatedListKeyValuePairstringSslCertificatesScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = SslCertificatesClient.Create();
// Initialize request argument(s)
AggregatedListSslCertificatesRequest request = new AggregatedListSslCertificatesRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<SslCertificateAggregatedList, KeyValuePair<string, SslCertificatesScopedList>> response = sslCertificatesClient.AggregatedList(request);

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

Retrieves the list of all SslCertificate 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
PagedEnumerableSslCertificateAggregatedListKeyValuePairstringSslCertificatesScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = SslCertificatesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<SslCertificateAggregatedList, KeyValuePair<string, SslCertificatesScopedList>> response = sslCertificatesClient.AggregatedList(project);

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

public virtual PagedAsyncEnumerable<SslCertificateAggregatedList, KeyValuePair<string, SslCertificatesScopedList>> AggregatedListAsync(AggregatedListSslCertificatesRequest request, CallSettings callSettings = null)

Retrieves the list of all SslCertificate 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 AggregatedListSslCertificatesRequest

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
PagedAsyncEnumerableSslCertificateAggregatedListKeyValuePairstringSslCertificatesScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
AggregatedListSslCertificatesRequest request = new AggregatedListSslCertificatesRequest
{
    OrderBy = "",
    Project = "",
    ServiceProjectNumber = 0L,
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<SslCertificateAggregatedList, KeyValuePair<string, SslCertificatesScopedList>> response = sslCertificatesClient.AggregatedListAsync(request);

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

Retrieves the list of all SslCertificate 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
PagedAsyncEnumerableSslCertificateAggregatedListKeyValuePairstringSslCertificatesScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<SslCertificateAggregatedList, KeyValuePair<string, SslCertificatesScopedList>> response = sslCertificatesClient.AggregatedListAsync(project);

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

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

Returns
Type Description
SslCertificatesClient

The created SslCertificatesClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

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

The task representing the created SslCertificatesClient.

Delete(DeleteSslCertificateRequest, CallSettings)

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

Deletes the specified SslCertificate resource.

Parameters
Name Description
request DeleteSslCertificateRequest

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
SslCertificatesClient sslCertificatesClient = SslCertificatesClient.Create();
// Initialize request argument(s)
DeleteSslCertificateRequest request = new DeleteSslCertificateRequest
{
    RequestId = "",
    SslCertificate = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = sslCertificatesClient.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 = sslCertificatesClient.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 sslCertificate, CallSettings callSettings = null)

Deletes the specified SslCertificate resource.

Parameters
Name Description
project string

Project ID for this request.
sslCertificate string

Name of the SslCertificate resource to delete.
callSettings CallSettings

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

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

// 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 = sslCertificatesClient.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(DeleteSslCertificateRequest, CallSettings)

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

Deletes the specified SslCertificate resource.

Parameters
Name Description
request DeleteSslCertificateRequest

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

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

Deletes the specified SslCertificate resource.

Parameters
Name Description
request DeleteSslCertificateRequest

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
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
DeleteSslCertificateRequest request = new DeleteSslCertificateRequest
{
    RequestId = "",
    SslCertificate = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await sslCertificatesClient.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 sslCertificatesClient.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 sslCertificate, CallSettings callSettings = null)

Deletes the specified SslCertificate resource.

Parameters
Name Description
project string

Project ID for this request.
sslCertificate string

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

// 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 sslCertificatesClient.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 sslCertificate, CancellationToken cancellationToken)

Deletes the specified SslCertificate resource.

Parameters
Name Description
project string

Project ID for this request.
sslCertificate string

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

// 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 sslCertificatesClient.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(GetSslCertificateRequest, CallSettings)

public virtual SslCertificate Get(GetSslCertificateRequest request, CallSettings callSettings = null)

Returns the specified SslCertificate resource.

Parameters
Name Description
request GetSslCertificateRequest

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
SslCertificate

The RPC response.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = SslCertificatesClient.Create();
// Initialize request argument(s)
GetSslCertificateRequest request = new GetSslCertificateRequest
{
    SslCertificate = "",
    Project = "",
};
// Make the request
SslCertificate response = sslCertificatesClient.Get(request);

Get(string, string, CallSettings)

public virtual SslCertificate Get(string project, string sslCertificate, CallSettings callSettings = null)

Returns the specified SslCertificate resource.

Parameters
Name Description
project string

Project ID for this request.
sslCertificate string

Name of the SslCertificate resource to return.
callSettings CallSettings

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

The RPC response.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = SslCertificatesClient.Create();
// Initialize request argument(s)
string project = "";
string sslCertificate = "";
// Make the request
SslCertificate response = sslCertificatesClient.Get(project, sslCertificate);

GetAsync(GetSslCertificateRequest, CallSettings)

public virtual Task<SslCertificate> GetAsync(GetSslCertificateRequest request, CallSettings callSettings = null)

Returns the specified SslCertificate resource.

Parameters
Name Description
request GetSslCertificateRequest

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
TaskSslCertificate

A Task containing the RPC response.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
GetSslCertificateRequest request = new GetSslCertificateRequest
{
    SslCertificate = "",
    Project = "",
};
// Make the request
SslCertificate response = await sslCertificatesClient.GetAsync(request);

GetAsync(GetSslCertificateRequest, CancellationToken)

public virtual Task<SslCertificate> GetAsync(GetSslCertificateRequest request, CancellationToken cancellationToken)

Returns the specified SslCertificate resource.

Parameters
Name Description
request GetSslCertificateRequest

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

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

A Task containing the RPC response.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
GetSslCertificateRequest request = new GetSslCertificateRequest
{
    SslCertificate = "",
    Project = "",
};
// Make the request
SslCertificate response = await sslCertificatesClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<SslCertificate> GetAsync(string project, string sslCertificate, CallSettings callSettings = null)

Returns the specified SslCertificate resource.

Parameters
Name Description
project string

Project ID for this request.
sslCertificate string

Name of the SslCertificate resource to return.
callSettings CallSettings

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

A Task containing the RPC response.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string sslCertificate = "";
// Make the request
SslCertificate response = await sslCertificatesClient.GetAsync(project, sslCertificate);

GetAsync(string, string, CancellationToken)

public virtual Task<SslCertificate> GetAsync(string project, string sslCertificate, CancellationToken cancellationToken)

Returns the specified SslCertificate resource.

Parameters
Name Description
project string

Project ID for this request.
sslCertificate string

Name of the SslCertificate resource to return.
cancellationToken CancellationToken

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

A Task containing the RPC response.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string sslCertificate = "";
// Make the request
SslCertificate response = await sslCertificatesClient.GetAsync(project, sslCertificate);

Insert(InsertSslCertificateRequest, CallSettings)

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

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

Parameters
Name Description
request InsertSslCertificateRequest

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
SslCertificatesClient sslCertificatesClient = SslCertificatesClient.Create();
// Initialize request argument(s)
InsertSslCertificateRequest request = new InsertSslCertificateRequest
{
    RequestId = "",
    SslCertificateResource = new SslCertificate(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = sslCertificatesClient.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 = sslCertificatesClient.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, SslCertificate, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, SslCertificate sslCertificateResource, CallSettings callSettings = null)

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

Parameters
Name Description
project string

Project ID for this request.
sslCertificateResource SslCertificate

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
SslCertificatesClient sslCertificatesClient = SslCertificatesClient.Create();
// Initialize request argument(s)
string project = "";
SslCertificate sslCertificateResource = new SslCertificate();
// Make the request
lro::Operation<Operation, Operation> response = sslCertificatesClient.Insert(project, sslCertificateResource);

// 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 = sslCertificatesClient.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(InsertSslCertificateRequest, CallSettings)

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

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

Parameters
Name Description
request InsertSslCertificateRequest

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
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
InsertSslCertificateRequest request = new InsertSslCertificateRequest
{
    RequestId = "",
    SslCertificateResource = new SslCertificate(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await sslCertificatesClient.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 sslCertificatesClient.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(InsertSslCertificateRequest, CancellationToken)

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

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

Parameters
Name Description
request InsertSslCertificateRequest

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
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
InsertSslCertificateRequest request = new InsertSslCertificateRequest
{
    RequestId = "",
    SslCertificateResource = new SslCertificate(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await sslCertificatesClient.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 sslCertificatesClient.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, SslCertificate, CallSettings)

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

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

Parameters
Name Description
project string

Project ID for this request.
sslCertificateResource SslCertificate

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

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

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, SslCertificate sslCertificateResource, CancellationToken cancellationToken)

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

Parameters
Name Description
project string

Project ID for this request.
sslCertificateResource SslCertificate

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

// 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 sslCertificatesClient.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(ListSslCertificatesRequest, CallSettings)

public virtual PagedEnumerable<SslCertificateList, SslCertificate> List(ListSslCertificatesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListSslCertificatesRequest

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
PagedEnumerableSslCertificateListSslCertificate

A pageable sequence of SslCertificate resources.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = SslCertificatesClient.Create();
// Initialize request argument(s)
ListSslCertificatesRequest request = new ListSslCertificatesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<SslCertificateList, SslCertificate> response = sslCertificatesClient.List(request);

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

Retrieves the list of SslCertificate 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
PagedEnumerableSslCertificateListSslCertificate

A pageable sequence of SslCertificate resources.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = SslCertificatesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<SslCertificateList, SslCertificate> response = sslCertificatesClient.List(project);

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

public virtual PagedAsyncEnumerable<SslCertificateList, SslCertificate> ListAsync(ListSslCertificatesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListSslCertificatesRequest

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
PagedAsyncEnumerableSslCertificateListSslCertificate

A pageable asynchronous sequence of SslCertificate resources.
Example 
// Create client
SslCertificatesClient sslCertificatesClient = await SslCertificatesClient.CreateAsync();
// Initialize request argument(s)
ListSslCertificatesRequest request = new ListSslCertificatesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<SslCertificateList, SslCertificate> response = sslCertificatesClient.ListAsync(request);

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

Retrieves the list of SslCertificate 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
PagedAsyncEnumerableSslCertificateListSslCertificate

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

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

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.

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.