App Engine v1 API - Class AuthorizedCertificatesClient (2.4.0)

public abstract class AuthorizedCertificatesClient

Reference documentation and code samples for the App Engine v1 API class AuthorizedCertificatesClient.

AuthorizedCertificates client wrapper, for convenient use.

Inheritance

object > AuthorizedCertificatesClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

AuthorizedCertificatesClientImpl

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Remarks

Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the AuthorizedCertificates service, which is a host of "appengine.googleapis.com" and a port of 443.

Property Value
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default AuthorizedCertificates scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default AuthorizedCertificates scopes are:

GrpcClient

public virtual AuthorizedCertificates.AuthorizedCertificatesClient GrpcClient { get; }

The underlying gRPC AuthorizedCertificates client

Property Value
Type	Description
`AuthorizedCertificatesAuthorizedCertificatesClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static AuthorizedCertificatesClient Create()

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

Returns
Type	Description
`AuthorizedCertificatesClient`	The created AuthorizedCertificatesClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
`TaskAuthorizedCertificatesClient`	The task representing the created AuthorizedCertificatesClient.

CreateAuthorizedCertificate(CreateAuthorizedCertificateRequest, CallSettings)

public virtual AuthorizedCertificate CreateAuthorizedCertificate(CreateAuthorizedCertificateRequest request, CallSettings callSettings = null)

Uploads the specified SSL certificate.

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = AuthorizedCertificatesClient.Create();
// Initialize request argument(s)
CreateAuthorizedCertificateRequest request = new CreateAuthorizedCertificateRequest
{
    Parent = "",
    Certificate = new AuthorizedCertificate(),
};
// Make the request
AuthorizedCertificate response = authorizedCertificatesClient.CreateAuthorizedCertificate(request);

CreateAuthorizedCertificateAsync(CreateAuthorizedCertificateRequest, CallSettings)

public virtual Task<AuthorizedCertificate> CreateAuthorizedCertificateAsync(CreateAuthorizedCertificateRequest request, CallSettings callSettings = null)

Uploads the specified SSL certificate.

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = await AuthorizedCertificatesClient.CreateAsync();
// Initialize request argument(s)
CreateAuthorizedCertificateRequest request = new CreateAuthorizedCertificateRequest
{
    Parent = "",
    Certificate = new AuthorizedCertificate(),
};
// Make the request
AuthorizedCertificate response = await authorizedCertificatesClient.CreateAuthorizedCertificateAsync(request);

CreateAuthorizedCertificateAsync(CreateAuthorizedCertificateRequest, CancellationToken)

public virtual Task<AuthorizedCertificate> CreateAuthorizedCertificateAsync(CreateAuthorizedCertificateRequest request, CancellationToken cancellationToken)

Uploads the specified SSL certificate.

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

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = await AuthorizedCertificatesClient.CreateAsync();
// Initialize request argument(s)
CreateAuthorizedCertificateRequest request = new CreateAuthorizedCertificateRequest
{
    Parent = "",
    Certificate = new AuthorizedCertificate(),
};
// Make the request
AuthorizedCertificate response = await authorizedCertificatesClient.CreateAuthorizedCertificateAsync(request);

DeleteAuthorizedCertificate(DeleteAuthorizedCertificateRequest, CallSettings)

public virtual void DeleteAuthorizedCertificate(DeleteAuthorizedCertificateRequest request, CallSettings callSettings = null)

Deletes the specified SSL certificate.

Parameters
Name	Description
`request`	`DeleteAuthorizedCertificateRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = AuthorizedCertificatesClient.Create();
// Initialize request argument(s)
DeleteAuthorizedCertificateRequest request = new DeleteAuthorizedCertificateRequest { Name = "", };
// Make the request
authorizedCertificatesClient.DeleteAuthorizedCertificate(request);

DeleteAuthorizedCertificateAsync(DeleteAuthorizedCertificateRequest, CallSettings)

public virtual Task DeleteAuthorizedCertificateAsync(DeleteAuthorizedCertificateRequest request, CallSettings callSettings = null)

Deletes the specified SSL certificate.

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = await AuthorizedCertificatesClient.CreateAsync();
// Initialize request argument(s)
DeleteAuthorizedCertificateRequest request = new DeleteAuthorizedCertificateRequest { Name = "", };
// Make the request
await authorizedCertificatesClient.DeleteAuthorizedCertificateAsync(request);

DeleteAuthorizedCertificateAsync(DeleteAuthorizedCertificateRequest, CancellationToken)

public virtual Task DeleteAuthorizedCertificateAsync(DeleteAuthorizedCertificateRequest request, CancellationToken cancellationToken)

Deletes the specified SSL certificate.

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

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = await AuthorizedCertificatesClient.CreateAsync();
// Initialize request argument(s)
DeleteAuthorizedCertificateRequest request = new DeleteAuthorizedCertificateRequest { Name = "", };
// Make the request
await authorizedCertificatesClient.DeleteAuthorizedCertificateAsync(request);

GetAuthorizedCertificate(GetAuthorizedCertificateRequest, CallSettings)

public virtual AuthorizedCertificate GetAuthorizedCertificate(GetAuthorizedCertificateRequest request, CallSettings callSettings = null)

Gets the specified SSL certificate.

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = AuthorizedCertificatesClient.Create();
// Initialize request argument(s)
GetAuthorizedCertificateRequest request = new GetAuthorizedCertificateRequest
{
    Name = "",
    View = AuthorizedCertificateView.BasicCertificate,
};
// Make the request
AuthorizedCertificate response = authorizedCertificatesClient.GetAuthorizedCertificate(request);

GetAuthorizedCertificateAsync(GetAuthorizedCertificateRequest, CallSettings)

public virtual Task<AuthorizedCertificate> GetAuthorizedCertificateAsync(GetAuthorizedCertificateRequest request, CallSettings callSettings = null)

Gets the specified SSL certificate.

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = await AuthorizedCertificatesClient.CreateAsync();
// Initialize request argument(s)
GetAuthorizedCertificateRequest request = new GetAuthorizedCertificateRequest
{
    Name = "",
    View = AuthorizedCertificateView.BasicCertificate,
};
// Make the request
AuthorizedCertificate response = await authorizedCertificatesClient.GetAuthorizedCertificateAsync(request);

GetAuthorizedCertificateAsync(GetAuthorizedCertificateRequest, CancellationToken)

public virtual Task<AuthorizedCertificate> GetAuthorizedCertificateAsync(GetAuthorizedCertificateRequest request, CancellationToken cancellationToken)

Gets the specified SSL certificate.

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

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = await AuthorizedCertificatesClient.CreateAsync();
// Initialize request argument(s)
GetAuthorizedCertificateRequest request = new GetAuthorizedCertificateRequest
{
    Name = "",
    View = AuthorizedCertificateView.BasicCertificate,
};
// Make the request
AuthorizedCertificate response = await authorizedCertificatesClient.GetAuthorizedCertificateAsync(request);

ListAuthorizedCertificates(ListAuthorizedCertificatesRequest, CallSettings)

public virtual PagedEnumerable<ListAuthorizedCertificatesResponse, AuthorizedCertificate> ListAuthorizedCertificates(ListAuthorizedCertificatesRequest request, CallSettings callSettings = null)

Lists all SSL certificates the user is authorized to administer.

Parameters
Name	Description
`request`	`ListAuthorizedCertificatesRequest` 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
`PagedEnumerableListAuthorizedCertificatesResponseAuthorizedCertificate`	A pageable sequence of AuthorizedCertificate resources.

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = AuthorizedCertificatesClient.Create();
// Initialize request argument(s)
ListAuthorizedCertificatesRequest request = new ListAuthorizedCertificatesRequest
{
    Parent = "",
    View = AuthorizedCertificateView.BasicCertificate,
};
// Make the request
PagedEnumerable<ListAuthorizedCertificatesResponse, AuthorizedCertificate> response = authorizedCertificatesClient.ListAuthorizedCertificates(request);

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

ListAuthorizedCertificatesAsync(ListAuthorizedCertificatesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAuthorizedCertificatesResponse, AuthorizedCertificate> ListAuthorizedCertificatesAsync(ListAuthorizedCertificatesRequest request, CallSettings callSettings = null)

Lists all SSL certificates the user is authorized to administer.

Parameters
Name	Description
`request`	`ListAuthorizedCertificatesRequest` 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
`PagedAsyncEnumerableListAuthorizedCertificatesResponseAuthorizedCertificate`	A pageable asynchronous sequence of AuthorizedCertificate resources.

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = await AuthorizedCertificatesClient.CreateAsync();
// Initialize request argument(s)
ListAuthorizedCertificatesRequest request = new ListAuthorizedCertificatesRequest
{
    Parent = "",
    View = AuthorizedCertificateView.BasicCertificate,
};
// Make the request
PagedAsyncEnumerable<ListAuthorizedCertificatesResponse, AuthorizedCertificate> response = authorizedCertificatesClient.ListAuthorizedCertificatesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AuthorizedCertificate 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((ListAuthorizedCertificatesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AuthorizedCertificate 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<AuthorizedCertificate> 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 (AuthorizedCertificate item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
`Task`	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateAuthorizedCertificate(UpdateAuthorizedCertificateRequest, CallSettings)

public virtual AuthorizedCertificate UpdateAuthorizedCertificate(UpdateAuthorizedCertificateRequest request, CallSettings callSettings = null)

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = AuthorizedCertificatesClient.Create();
// Initialize request argument(s)
UpdateAuthorizedCertificateRequest request = new UpdateAuthorizedCertificateRequest
{
    Name = "",
    Certificate = new AuthorizedCertificate(),
    UpdateMask = new FieldMask(),
};
// Make the request
AuthorizedCertificate response = authorizedCertificatesClient.UpdateAuthorizedCertificate(request);

UpdateAuthorizedCertificateAsync(UpdateAuthorizedCertificateRequest, CallSettings)

public virtual Task<AuthorizedCertificate> UpdateAuthorizedCertificateAsync(UpdateAuthorizedCertificateRequest request, CallSettings callSettings = null)

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = await AuthorizedCertificatesClient.CreateAsync();
// Initialize request argument(s)
UpdateAuthorizedCertificateRequest request = new UpdateAuthorizedCertificateRequest
{
    Name = "",
    Certificate = new AuthorizedCertificate(),
    UpdateMask = new FieldMask(),
};
// Make the request
AuthorizedCertificate response = await authorizedCertificatesClient.UpdateAuthorizedCertificateAsync(request);

UpdateAuthorizedCertificateAsync(UpdateAuthorizedCertificateRequest, CancellationToken)

public virtual Task<AuthorizedCertificate> UpdateAuthorizedCertificateAsync(UpdateAuthorizedCertificateRequest request, CancellationToken cancellationToken)

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

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

Example

// Create client
AuthorizedCertificatesClient authorizedCertificatesClient = await AuthorizedCertificatesClient.CreateAsync();
// Initialize request argument(s)
UpdateAuthorizedCertificateRequest request = new UpdateAuthorizedCertificateRequest
{
    Name = "",
    Certificate = new AuthorizedCertificate(),
    UpdateMask = new FieldMask(),
};
// Make the request
AuthorizedCertificate response = await authorizedCertificatesClient.UpdateAuthorizedCertificateAsync(request);