Documentation

Google_Service_Apigee_Resource_OrganizationsEnvironmentsKeystoresAliases extends Google_Service_Resource
in package

Application

The "aliases" collection of methods.

Typical usage is: $apigeeService = new Google_Service_Apigee(...); $aliases = $apigeeService->aliases;

$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.
create() : Google_Service_Apigee_GoogleCloudApigeeV1Alias: Creates an alias from a key, certificate pair. The structure of the request is controlled by the `format` query parameter: * `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. The request must have `Content-Type: multipart/form-data` and include fields `keyFile` and `certFile`. If uploading to a truststore, omit `keyFile`. * `pkcs12` - A PKCS12 file is uploaded. The request must have `Content-Type: multipart/form- data` with the file provided in the only field. * `selfsignedcert` - A new private key and certificate are generated. The request must have `Content- Type: application/json` and a body of CertificateGenerationSpec.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
csr() : Google_Service_Apigee_GoogleApiHttpBody: Generates a PKCS #10 Certificate Signing Request for the private key in an alias. (aliases.csr)
delete() : Google_Service_Apigee_GoogleCloudApigeeV1Alias: Deletes an alias. (aliases.delete)
get() : Google_Service_Apigee_GoogleCloudApigeeV1Alias: Gets an alias. (aliases.get)
getCertificate() : Google_Service_Apigee_GoogleApiHttpBody: Gets the certificate from an alias in PEM-encoded form.
update() : Google_Service_Apigee_GoogleCloudApigeeV1Alias: Updates the certificate in an alias. (aliases.update)
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 —

create()

Creates an alias from a key, certificate pair. The structure of the request is controlled by the `format` query parameter: * `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. The request must have `Content-Type: multipart/form-data` and include fields `keyFile` and `certFile`. If uploading to a truststore, omit `keyFile`. * `pkcs12` - A PKCS12 file is uploaded. The request must have `Content-Type: multipart/form- data` with the file provided in the only field. * `selfsignedcert` - A new private key and certificate are generated. The request must have `Content- Type: application/json` and a body of CertificateGenerationSpec.


    public
                create(string $parent, Google_Service_Apigee_GoogleApiHttpBody $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Alias

(aliases.create)

Parameters

$parent : string: Required. The name of the keystore. Must be of the form organizations/{organization}/environments/{environment}/keystores/{keystore} .
$postBody : Google_Service_Apigee_GoogleApiHttpBody
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1Alias —

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

csr()

Generates a PKCS #10 Certificate Signing Request for the private key in an alias. (aliases.csr)


    public
                csr(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleApiHttpBody

Parameters

$name : string: Required. The name of the alias. Must be of the form org anizations/{organization}/environments/{environment}/keystores/{keystore}/ali ases/{alias}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleApiHttpBody —

delete()

Deletes an alias. (aliases.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Alias

Parameters

$name : string: Required. The name of the alias. Must be of the form org anizations/{organization}/environments/{environment}/keystores/{keystore}/ali ases/{alias}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1Alias —

get()

Gets an alias. (aliases.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Alias

Parameters

$name : string: Required. The name of the alias. Must be of the form org anizations/{organization}/environments/{environment}/keystores/{keystore}/ali ases/{alias}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1Alias —

getCertificate()

Gets the certificate from an alias in PEM-encoded form.


    public
                getCertificate(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleApiHttpBody

(aliases.getCertificate)

Parameters

$name : string: Required. The name of the alias. Must be of the form org anizations/{organization}/environments/{environment}/keystores/{keystore}/ali ases/{alias}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleApiHttpBody —

update()

Updates the certificate in an alias. (aliases.update)


    public
                update(string $name, Google_Service_Apigee_GoogleApiHttpBody $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Alias

Parameters

$name : string: Required. The name of the alias. Must be of the form org anizations/{organization}/environments/{environment}/keystores/{keystore}/ali ases/{alias}.
$postBody : Google_Service_Apigee_GoogleApiHttpBody
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1Alias —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —