AuthorizedCertificatesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.appengine_admin_v1.services.authorized_certificates.transports.base.AuthorizedCertificatesTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
Properties
transport
Returns the transport used by the client instance.
Type | Description |
AuthorizedCertificatesTransport | The transport used by the client instance. |
Methods
AuthorizedCertificatesClient
AuthorizedCertificatesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.appengine_admin_v1.services.authorized_certificates.transports.base.AuthorizedCertificatesTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the authorized certificates client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, AuthorizedCertificatesTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_authorized_certificate
create_authorized_certificate(request: Optional[Union[google.cloud.appengine_admin_v1.types.appengine.CreateAuthorizedCertificateRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Uploads the specified SSL certificate.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import appengine_admin_v1
def sample_create_authorized_certificate():
# Create a client
client = appengine_admin_v1.AuthorizedCertificatesClient()
# Initialize request argument(s)
request = appengine_admin_v1.CreateAuthorizedCertificateRequest(
)
# Make the request
response = client.create_authorized_certificate(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.appengine_admin_v1.types.CreateAuthorizedCertificateRequest, dict]
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.appengine_admin_v1.types.AuthorizedCertificate | An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. |
delete_authorized_certificate
delete_authorized_certificate(request: Optional[Union[google.cloud.appengine_admin_v1.types.appengine.DeleteAuthorizedCertificateRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified SSL certificate.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import appengine_admin_v1
def sample_delete_authorized_certificate():
# Create a client
client = appengine_admin_v1.AuthorizedCertificatesClient()
# Initialize request argument(s)
request = appengine_admin_v1.DeleteAuthorizedCertificateRequest(
)
# Make the request
client.delete_authorized_certificate(request=request)
Name | Description |
request |
Union[google.cloud.appengine_admin_v1.types.DeleteAuthorizedCertificateRequest, dict]
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
AuthorizedCertificatesClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
AuthorizedCertificatesClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
AuthorizedCertificatesClient | The constructed client. |
get_authorized_certificate
get_authorized_certificate(request: Optional[Union[google.cloud.appengine_admin_v1.types.appengine.GetAuthorizedCertificateRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the specified SSL certificate.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import appengine_admin_v1
def sample_get_authorized_certificate():
# Create a client
client = appengine_admin_v1.AuthorizedCertificatesClient()
# Initialize request argument(s)
request = appengine_admin_v1.GetAuthorizedCertificateRequest(
)
# Make the request
response = client.get_authorized_certificate(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.appengine_admin_v1.types.GetAuthorizedCertificateRequest, dict]
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.appengine_admin_v1.types.AuthorizedCertificate | An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
list_authorized_certificates
list_authorized_certificates(request: Optional[Union[google.cloud.appengine_admin_v1.types.appengine.ListAuthorizedCertificatesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all SSL certificates the user is authorized to administer.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import appengine_admin_v1
def sample_list_authorized_certificates():
# Create a client
client = appengine_admin_v1.AuthorizedCertificatesClient()
# Initialize request argument(s)
request = appengine_admin_v1.ListAuthorizedCertificatesRequest(
)
# Make the request
page_result = client.list_authorized_certificates(request=request)
# Handle the response
for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.appengine_admin_v1.types.ListAuthorizedCertificatesRequest, dict]
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.appengine_admin_v1.services.authorized_certificates.pagers.ListAuthorizedCertificatesPager | Response message for AuthorizedCertificates.ListAuthorizedCertificates. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
update_authorized_certificate
update_authorized_certificate(request: Optional[Union[google.cloud.appengine_admin_v1.types.appengine.UpdateAuthorizedCertificateRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import appengine_admin_v1
def sample_update_authorized_certificate():
# Create a client
client = appengine_admin_v1.AuthorizedCertificatesClient()
# Initialize request argument(s)
request = appengine_admin_v1.UpdateAuthorizedCertificateRequest(
)
# Make the request
response = client.update_authorized_certificate(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.appengine_admin_v1.types.UpdateAuthorizedCertificateRequest, dict]
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.appengine_admin_v1.types.AuthorizedCertificate | An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. |