Google Cloud Cloud Controls Partner V1beta Client - Class CloudControlsPartnerCoreClient (0.1.3)

Reference documentation and code samples for the Google Cloud Cloud Controls Partner V1beta Client class CloudControlsPartnerCoreClient.

Service Description: Service describing handlers for resources

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ CloudControlsPartner \ V1beta \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.
↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "
↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

getCustomer

Gets details of a single customer

The async variant is Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient::getCustomerAsync() .

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetCustomerRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\CloudControlsPartner\V1beta\Customer
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient;
use Google\Cloud\CloudControlsPartner\V1beta\Customer;
use Google\Cloud\CloudControlsPartner\V1beta\GetCustomerRequest;

/**
 * @param string $formattedName Format:
 *                              organizations/{organization}/locations/{location}/customers/{customer}
 *                              Please see {@see CloudControlsPartnerCoreClient::customerName()} for help formatting this field.
 */
function get_customer_sample(string $formattedName): void
{
    // Create a client.
    $cloudControlsPartnerCoreClient = new CloudControlsPartnerCoreClient();

    // Prepare the request message.
    $request = (new GetCustomerRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Customer $response */
        $response = $cloudControlsPartnerCoreClient->getCustomer($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CloudControlsPartnerCoreClient::customerName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[CUSTOMER]'
    );

    get_customer_sample($formattedName);
}

getEkmConnections

Gets the EKM connections associated with a workload

The async variant is Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient::getEkmConnectionsAsync() .

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetEkmConnectionsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\CloudControlsPartner\V1beta\EkmConnections
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient;
use Google\Cloud\CloudControlsPartner\V1beta\EkmConnections;
use Google\Cloud\CloudControlsPartner\V1beta\GetEkmConnectionsRequest;

/**
 * @param string $formattedName Format:
 *                              organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
 *                              Please see {@see CloudControlsPartnerCoreClient::ekmConnectionsName()} for help formatting this field.
 */
function get_ekm_connections_sample(string $formattedName): void
{
    // Create a client.
    $cloudControlsPartnerCoreClient = new CloudControlsPartnerCoreClient();

    // Prepare the request message.
    $request = (new GetEkmConnectionsRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var EkmConnections $response */
        $response = $cloudControlsPartnerCoreClient->getEkmConnections($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CloudControlsPartnerCoreClient::ekmConnectionsName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[CUSTOMER]',
        '[WORKLOAD]'
    );

    get_ekm_connections_sample($formattedName);
}

getPartner

Get details of a Partner.

The async variant is Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient::getPartnerAsync() .

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetPartnerRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\CloudControlsPartner\V1beta\Partner
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient;
use Google\Cloud\CloudControlsPartner\V1beta\GetPartnerRequest;
use Google\Cloud\CloudControlsPartner\V1beta\Partner;

/**
 * @param string $formattedName Format: organizations/{organization}/locations/{location}/partner
 *                              Please see {@see CloudControlsPartnerCoreClient::partnerName()} for help formatting this field.
 */
function get_partner_sample(string $formattedName): void
{
    // Create a client.
    $cloudControlsPartnerCoreClient = new CloudControlsPartnerCoreClient();

    // Prepare the request message.
    $request = (new GetPartnerRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Partner $response */
        $response = $cloudControlsPartnerCoreClient->getPartner($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CloudControlsPartnerCoreClient::partnerName('[ORGANIZATION]', '[LOCATION]');

    get_partner_sample($formattedName);
}

getPartnerPermissions

Gets the partner permissions granted for a workload

The async variant is Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient::getPartnerPermissionsAsync() .

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetPartnerPermissionsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\CloudControlsPartner\V1beta\PartnerPermissions
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient;
use Google\Cloud\CloudControlsPartner\V1beta\GetPartnerPermissionsRequest;
use Google\Cloud\CloudControlsPartner\V1beta\PartnerPermissions;

/**
 * @param string $formattedName Name of the resource to get in the format:
 *                              organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions
 *                              Please see {@see CloudControlsPartnerCoreClient::partnerPermissionsName()} for help formatting this field.
 */
function get_partner_permissions_sample(string $formattedName): void
{
    // Create a client.
    $cloudControlsPartnerCoreClient = new CloudControlsPartnerCoreClient();

    // Prepare the request message.
    $request = (new GetPartnerPermissionsRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var PartnerPermissions $response */
        $response = $cloudControlsPartnerCoreClient->getPartnerPermissions($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CloudControlsPartnerCoreClient::partnerPermissionsName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[CUSTOMER]',
        '[WORKLOAD]'
    );

    get_partner_permissions_sample($formattedName);
}

getWorkload

Gets details of a single workload

The async variant is Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient::getWorkloadAsync() .

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetWorkloadRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\CloudControlsPartner\V1beta\Workload
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient;
use Google\Cloud\CloudControlsPartner\V1beta\GetWorkloadRequest;
use Google\Cloud\CloudControlsPartner\V1beta\Workload;

/**
 * @param string $formattedName Format:
 *                              organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
 *                              Please see {@see CloudControlsPartnerCoreClient::workloadName()} for help formatting this field.
 */
function get_workload_sample(string $formattedName): void
{
    // Create a client.
    $cloudControlsPartnerCoreClient = new CloudControlsPartnerCoreClient();

    // Prepare the request message.
    $request = (new GetWorkloadRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Workload $response */
        $response = $cloudControlsPartnerCoreClient->getWorkload($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CloudControlsPartnerCoreClient::workloadName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[CUSTOMER]',
        '[WORKLOAD]'
    );

    get_workload_sample($formattedName);
}

listAccessApprovalRequests

Lists access requests associated with a workload

The async variant is Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient::listAccessApprovalRequestsAsync() .

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\ListAccessApprovalRequestsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudControlsPartner\V1beta\AccessApprovalRequest;
use Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient;
use Google\Cloud\CloudControlsPartner\V1beta\ListAccessApprovalRequestsRequest;

/**
 * @param string $formattedParent Parent resource
 *                                Format:
 *                                organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
 *                                Please see {@see CloudControlsPartnerCoreClient::workloadName()} for help formatting this field.
 */
function list_access_approval_requests_sample(string $formattedParent): void
{
    // Create a client.
    $cloudControlsPartnerCoreClient = new CloudControlsPartnerCoreClient();

    // Prepare the request message.
    $request = (new ListAccessApprovalRequestsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $cloudControlsPartnerCoreClient->listAccessApprovalRequests($request);

        /** @var AccessApprovalRequest $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = CloudControlsPartnerCoreClient::workloadName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[CUSTOMER]',
        '[WORKLOAD]'
    );

    list_access_approval_requests_sample($formattedParent);
}

listCustomers

Lists customers of a partner identified by its Google Cloud organization ID

The async variant is Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient::listCustomersAsync() .

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\ListCustomersRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient;
use Google\Cloud\CloudControlsPartner\V1beta\Customer;
use Google\Cloud\CloudControlsPartner\V1beta\ListCustomersRequest;

/**
 * @param string $formattedParent Parent resource
 *                                Format: organizations/{organization}/locations/{location}
 *                                Please see {@see CloudControlsPartnerCoreClient::organizationLocationName()} for help formatting this field.
 */
function list_customers_sample(string $formattedParent): void
{
    // Create a client.
    $cloudControlsPartnerCoreClient = new CloudControlsPartnerCoreClient();

    // Prepare the request message.
    $request = (new ListCustomersRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $cloudControlsPartnerCoreClient->listCustomers($request);

        /** @var Customer $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = CloudControlsPartnerCoreClient::organizationLocationName(
        '[ORGANIZATION]',
        '[LOCATION]'
    );

    list_customers_sample($formattedParent);
}

listWorkloads

Lists customer workloads for a given customer org id

The async variant is Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient::listWorkloadsAsync() .

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\ListWorkloadsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudControlsPartner\V1beta\Client\CloudControlsPartnerCoreClient;
use Google\Cloud\CloudControlsPartner\V1beta\ListWorkloadsRequest;
use Google\Cloud\CloudControlsPartner\V1beta\Workload;

/**
 * @param string $formattedParent Parent resource
 *                                Format:
 *                                organizations/{organization}/locations/{location}/customers/{customer}
 *                                Please see {@see CloudControlsPartnerCoreClient::customerName()} for help formatting this field.
 */
function list_workloads_sample(string $formattedParent): void
{
    // Create a client.
    $cloudControlsPartnerCoreClient = new CloudControlsPartnerCoreClient();

    // Prepare the request message.
    $request = (new ListWorkloadsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $cloudControlsPartnerCoreClient->listWorkloads($request);

        /** @var Workload $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = CloudControlsPartnerCoreClient::customerName(
        '[ORGANIZATION]',
        '[LOCATION]',
        '[CUSTOMER]'
    );

    list_workloads_sample($formattedParent);
}

getCustomerAsync

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetCustomerRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getEkmConnectionsAsync

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetEkmConnectionsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getPartnerAsync

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetPartnerRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getPartnerPermissionsAsync

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetPartnerPermissionsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getWorkloadAsync

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\GetWorkloadRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listAccessApprovalRequestsAsync

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\ListAccessApprovalRequestsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listCustomersAsync

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\ListCustomersRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listWorkloadsAsync

Parameters
Name Description
request Google\Cloud\CloudControlsPartner\V1beta\ListWorkloadsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

static::customerName

Formats a string containing the fully-qualified path to represent a customer resource.

Parameters
Name Description
organization string
location string
customer string
Returns
Type Description
string The formatted customer resource.

static::ekmConnectionsName

Formats a string containing the fully-qualified path to represent a ekm_connections resource.

Parameters
Name Description
organization string
location string
customer string
workload string
Returns
Type Description
string The formatted ekm_connections resource.

static::organizationLocationName

Formats a string containing the fully-qualified path to represent a organization_location resource.

Parameters
Name Description
organization string
location string
Returns
Type Description
string The formatted organization_location resource.

static::partnerName

Formats a string containing the fully-qualified path to represent a partner resource.

Parameters
Name Description
organization string
location string
Returns
Type Description
string The formatted partner resource.

static::partnerPermissionsName

Formats a string containing the fully-qualified path to represent a partner_permissions resource.

Parameters
Name Description
organization string
location string
customer string
workload string
Returns
Type Description
string The formatted partner_permissions resource.

static::workloadName

Formats a string containing the fully-qualified path to represent a workload resource.

Parameters
Name Description
organization string
location string
customer string
workload string
Returns
Type Description
string The formatted workload resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • customer: organizations/{organization}/locations/{location}/customers/{customer}
  • ekmConnections: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
  • organizationLocation: organizations/{organization}/locations/{location}
  • partner: organizations/{organization}/locations/{location}/partner
  • partnerPermissions: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions
  • workload: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name Description
formattedName string

The formatted name string
template string

Optional name of template to match
Returns
Type Description
array An associative array from name component IDs to component values.