Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_SQLAdmin_SslCerts_Resource Class Reference

The "sslCerts" collection of methods. More...

Inheritance diagram for Google_Service_SQLAdmin_SslCerts_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 createEphemeral ($project, $instance, Google_Service_SQLAdmin_SslCertsCreateEphemeralRequest $postBody, $optParams=array())
 Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance.
 
 delete ($project, $instance, $sha1Fingerprint, $optParams=array())
 Deletes the SSL certificate.
 
 get ($project, $instance, $sha1Fingerprint, $optParams=array())
 Retrieves a particular SSL certificate.
 
 insert ($project, $instance, Google_Service_SQLAdmin_SslCertsInsertRequest $postBody, $optParams=array())
 Creates an SSL certificate and returns it along with the private key and server certificate authority.
 
 listSslCerts ($project, $instance, $optParams=array())
 Lists all of the current SSL certificates for the instance.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "sslCerts" collection of methods.

Typical usage is: $sqladminService = new Google_Service_SQLAdmin(...); $sslCerts = $sqladminService->sslCerts;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ createEphemeral()

Google_Service_SQLAdmin_SslCerts_Resource::createEphemeral ( $project,
$instance,
Google_Service_SQLAdmin_SslCertsCreateEphemeralRequest $postBody,
$optParams = array() )

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance.

Users may use the certificate to authenticate as themselves when connecting to the database. (sslCerts.createEphemeral)

Parameters
string$projectProject ID of the Cloud SQL project.
string$instanceCloud SQL instance ID. This does not include the project ID.
Google_SslCertsCreateEphemeralRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_SQLAdmin_SslCert

◆ delete()

Google_Service_SQLAdmin_SslCerts_Resource::delete ( $project,
$instance,
$sha1Fingerprint,
$optParams = array() )

Deletes the SSL certificate.

The change will not take effect until the instance is restarted. (sslCerts.delete)

Parameters
string$projectProject ID of the project that contains the instance to be deleted.
string$instanceCloud SQL instance ID. This does not include the project ID.
string$sha1FingerprintSha1 FingerPrint.
array$optParamsOptional parameters.
Return values
Google_Service_SQLAdmin_Operation

◆ get()

Google_Service_SQLAdmin_SslCerts_Resource::get ( $project,
$instance,
$sha1Fingerprint,
$optParams = array() )

Retrieves a particular SSL certificate.

Does not include the private key (required for usage). The private key must be saved from the response to initial creation. (sslCerts.get)

Parameters
string$projectProject ID of the project that contains the instance.
string$instanceCloud SQL instance ID. This does not include the project ID.
string$sha1FingerprintSha1 FingerPrint.
array$optParamsOptional parameters.
Return values
Google_Service_SQLAdmin_SslCert

◆ insert()

Google_Service_SQLAdmin_SslCerts_Resource::insert ( $project,
$instance,
Google_Service_SQLAdmin_SslCertsInsertRequest $postBody,
$optParams = array() )

Creates an SSL certificate and returns it along with the private key and server certificate authority.

The new certificate will not be usable until the instance is restarted. (sslCerts.insert)

Parameters
string$projectProject ID of the project to which the newly created Cloud SQL instances should belong.
string$instanceCloud SQL instance ID. This does not include the project ID.
Google_SslCertsInsertRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_SQLAdmin_SslCertsInsertResponse

◆ listSslCerts()

Google_Service_SQLAdmin_SslCerts_Resource::listSslCerts ( $project,
$instance,
$optParams = array() )

Lists all of the current SSL certificates for the instance.

(sslCerts.listSslCerts)

Parameters
string$projectProject ID of the project for which to list Cloud SQL instances.
string$instanceCloud SQL instance ID. This does not include the project ID.
array$optParamsOptional parameters.
Return values
Google_Service_SQLAdmin_SslCertsListResponse

The documentation for this class was generated from the following file: