Documentation

Google_Service_Apigee_Resource_Organizations extends Google_Service_Resource
in package

Application

The "organizations" collection of methods.

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

$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_GoogleLongrunningOperation: Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started /create-org). (organizations.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_Apigee_GoogleCloudApigeeV1Organization: Gets the profile for an Apigee organization. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals /organization-structure). (organizations.get)
getDeployedIngressConfig() : Google_Service_Apigee_GoogleCloudApigeeV1IngressConfig: Gets the deployed ingress configuration for an organization.
getSyncAuthorization() : Google_Service_Apigee_GoogleCloudApigeeV1SyncAuthorization: Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to `getSyncAuthorization`. Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest /synchronizer-access). **Note**: Available to Apigee hybrid only.
listOrganizations() : Google_Service_Apigee_GoogleCloudApigeeV1ListOrganizationsResponse: Lists the Apigee organizations and associated GCP projects that you have permission to access. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals /organization-structure). (organizations.listOrganizations)
setSyncAuthorization() : Google_Service_Apigee_GoogleCloudApigeeV1SyncAuthorization: Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` to ensure that you are updating the correct version.
update() : Google_Service_Apigee_GoogleCloudApigeeV1Organization: Updates the properties for an Apigee organization. No other fields in the organization profile will be updated. (organizations.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 Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started /create-org). (organizations.create)


    public
                create(Google_Service_Apigee_GoogleCloudApigeeV1Organization $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleLongrunningOperation

Parameters

$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Organization
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleLongrunningOperation —

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

get()

Gets the profile for an Apigee organization. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals /organization-structure). (organizations.get)


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

Parameters

$name : string: Required. Apigee organization name in the following format: organizations/{org}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1Organization —

getDeployedIngressConfig()

Gets the deployed ingress configuration for an organization.


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

(organizations.getDeployedIngressConfig)

Parameters

$name : string: Required. Name of the deployed configuration for the organization in the following format: 'organizations/{org}/deployedIngressConfig'.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1IngressConfig —

getSyncAuthorization()

Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to `getSyncAuthorization`. Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest /synchronizer-access). **Note**: Available to Apigee hybrid only.


    public
                getSyncAuthorization(string $name, Google_Service_Apigee_GoogleCloudApigeeV1GetSyncAuthorizationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1SyncAuthorization

(organizations.getSyncAuthorization)

Parameters

$name : string: Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1GetSyncAuthorizationRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1SyncAuthorization —

listOrganizations()

Lists the Apigee organizations and associated GCP projects that you have permission to access. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals /organization-structure). (organizations.listOrganizations)


    public
                listOrganizations(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ListOrganizationsResponse

Parameters

$parent : string: Required. Use the following structure in your request: organizations
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1ListOrganizationsResponse —

setSyncAuthorization()

Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` to ensure that you are updating the correct version.


    public
                setSyncAuthorization(string $name, Google_Service_Apigee_GoogleCloudApigeeV1SyncAuthorization $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1SyncAuthorization

To get an ETag, call getSyncAuthorization. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest /synchronizer-access). Note: Available to Apigee hybrid only. (organizations.setSyncAuthorization)

Parameters

$name : string: Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1SyncAuthorization
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1SyncAuthorization —

update()

Updates the properties for an Apigee organization. No other fields in the organization profile will be updated. (organizations.update)


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

Parameters

$name : string: Required. Apigee organization name in the following format: organizations/{org}
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Organization
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1Organization —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —