Documentation

Google_Service_SQLAdmin_Resource_SslCerts extends Google_Service_Resource
in package

Application

The "sslCerts" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createEphemeral() : Google_Service_SQLAdmin_SslCert: 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)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_SQLAdmin_Operation: Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted. (sslCerts.delete)
get() : Google_Service_SQLAdmin_SslCert: 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)
insert() : Google_Service_SQLAdmin_SslCertsInsertResponse: 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)
listSslCerts() : Google_Service_SQLAdmin_SslCertsListResponse: Lists all of the current SSL certificates for the instance.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createEphemeral()

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)


    public
                createEphemeral(string $project, string $instance, Google_Service_SQLAdmin_SslCertsCreateEphemeralRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SQLAdmin_SslCert

Parameters

$project : string: Project ID of the Cloud SQL project.
$instance : string: Cloud SQL instance ID. This does not include the project ID.
$postBody : Google_Service_SQLAdmin_SslCertsCreateEphemeralRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SQLAdmin_SslCert —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted. (sslCerts.delete)


    public
                delete(string $project, string $instance, string $sha1Fingerprint[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SQLAdmin_Operation

Parameters

$project : string: Project ID of the project that contains the instance.
$instance : string: Cloud SQL instance ID. This does not include the project ID.
$sha1Fingerprint : string: Sha1 FingerPrint.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SQLAdmin_Operation —

get()

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)


    public
                get(string $project, string $instance, string $sha1Fingerprint[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SQLAdmin_SslCert

Parameters

$project : string: Project ID of the project that contains the instance.
$instance : string: Cloud SQL instance ID. This does not include the project ID.
$sha1Fingerprint : string: Sha1 FingerPrint.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SQLAdmin_SslCert —

insert()

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)


    public
                insert(string $project, string $instance, Google_Service_SQLAdmin_SslCertsInsertRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SQLAdmin_SslCertsInsertResponse

Parameters

$project : string: Project ID of the project that contains the instance.
$instance : string: Cloud SQL instance ID. This does not include the project ID.
$postBody : Google_Service_SQLAdmin_SslCertsInsertRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SQLAdmin_SslCertsInsertResponse —

listSslCerts()

Lists all of the current SSL certificates for the instance.


    public
                listSslCerts(string $project, string $instance[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SQLAdmin_SslCertsListResponse

(sslCerts.listSslCerts)

Parameters

$project : string: Project ID of the project that contains the instance.
$instance : string: Cloud SQL instance ID. This does not include the project ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SQLAdmin_SslCertsListResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —