Google Cloud Gke Hub V1beta1 Client - Class GkeHubMembershipServiceClient (0.10.0)

Reference documentation and code samples for the Google Cloud Gke Hub V1beta1 Client class GkeHubMembershipServiceClient.

Service Description: The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource.

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones.

Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();
try {
    $formattedParent = $gkeHubMembershipServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $membershipId = 'membership_id';
    $resource = new Membership();
    $operationResponse = $gkeHubMembershipServiceClient->createMembership($formattedParent, $membershipId, $resource);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $gkeHubMembershipServiceClient->createMembership($formattedParent, $membershipId, $resource);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $gkeHubMembershipServiceClient->resumeOperation($operationName, 'createMembership');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $gkeHubMembershipServiceClient->close();
}

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 \ GkeHub \ V1beta1

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.

createMembership

Creates a new Membership.

This is currently only supported for GKE clusters on Google Cloud. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.

Parameters
Name Description
parent string

Required. The parent (project and location) where the Memberships will be created. Specified in the format projects/*/locations/*.
membershipId string

Required. Client chosen ID for the membership. membership_id must be a valid RFC 1123 compliant DNS label:

  1. At most 63 characters in length
  2. It must consist of lower case alphanumeric characters or -
  3. It must start and end with an alphanumeric character

Which can be expressed as the regex: [a-z0-9]([-a-z0-9]*[a-z0-9])?, with a maximum length of 63 characters.
resource Google\Cloud\GkeHub\V1beta1\Membership

Required. The membership to create.
optionalArgs array

Optional.
↳ requestId string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
↳ 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\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\GkeHub\V1beta1\Membership;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent (project and location) where the Memberships will be
 *                                created. Specified in the format `projects/*/locations/*`. Please see
 *                                {@see GkeHubMembershipServiceClient::locationName()} for help formatting this field.
 * @param string $membershipId    Client chosen ID for the membership. `membership_id` must be a
 *                                valid RFC 1123 compliant DNS label:
 *
 *                                1. At most 63 characters in length
 *                                2. It must consist of lower case alphanumeric characters or `-`
 *                                3. It must start and end with an alphanumeric character
 *
 *                                Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`,
 *                                with a maximum length of 63 characters.
 */
function create_membership_sample(string $formattedParent, string $membershipId): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $resource = new Membership();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $gkeHubMembershipServiceClient->createMembership(
            $formattedParent,
            $membershipId,
            $resource
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Membership $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = GkeHubMembershipServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $membershipId = '[MEMBERSHIP_ID]';

    create_membership_sample($formattedParent, $membershipId);
}

deleteMembership

Removes a Membership.

This is currently only supported for GKE clusters on Google Cloud. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.

Parameters
Name Description
name string

Required. The Membership resource name in the format projects/*/locations/*/memberships/*.
optionalArgs array

Optional.
↳ requestId string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
↳ force bool

Optional. If set to true, any subresource from this Membership will also be deleted. Otherwise, the request will only work if the Membership has no subresource.
↳ 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\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName The Membership resource name in the format
 *                              `projects/*/locations/*/memberships/*`. Please see
 *                              {@see GkeHubMembershipServiceClient::membershipName()} for help formatting this field.
 */
function delete_membership_sample(string $formattedName): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $gkeHubMembershipServiceClient->deleteMembership($formattedName);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = GkeHubMembershipServiceClient::membershipName(
        '[PROJECT]',
        '[LOCATION]',
        '[MEMBERSHIP]'
    );

    delete_membership_sample($formattedName);
}

generateConnectManifest

Generates the manifest for deployment of the GKE connect agent.

This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.

Parameters
Name Description
name string

Required. The Membership resource name the Agent will associate with, in the format projects/*/locations/*/memberships/*.
optionalArgs array

Optional.
↳ connectAgent ConnectAgent

Optional. The connect agent to generate manifest for.
↳ version string

Optional. The Connect agent version to use. Defaults to the most current version.
↳ isUpgrade bool

Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.
↳ registry string

Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.
↳ imagePullSecretContent string

Optional. The image pull secret content for the registry, if not public.
↳ 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\GkeHub\V1beta1\GenerateConnectManifestResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1beta1\GenerateConnectManifestResponse;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;

/**
 * @param string $formattedName The Membership resource name the Agent will associate with, in
 *                              the format `projects/*/locations/*/memberships/*`. Please see
 *                              {@see GkeHubMembershipServiceClient::membershipName()} for help formatting this field.
 */
function generate_connect_manifest_sample(string $formattedName): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var GenerateConnectManifestResponse $response */
        $response = $gkeHubMembershipServiceClient->generateConnectManifest($formattedName);
        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 = GkeHubMembershipServiceClient::membershipName(
        '[PROJECT]',
        '[LOCATION]',
        '[MEMBERSHIP]'
    );

    generate_connect_manifest_sample($formattedName);
}

generateExclusivityManifest

GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.

Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub.

The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.

Parameters
Name Description
name string

Required. The Membership resource name in the format projects/*/locations/*/memberships/*.
optionalArgs array

Optional.
↳ crdManifest string

Optional. The YAML manifest of the membership CRD retrieved by kubectl get customresourcedefinitions membership. Leave empty if the resource does not exist.
↳ crManifest string

Optional. The YAML manifest of the membership CR retrieved by kubectl get memberships membership. Leave empty if the resource does not exist.
↳ 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\GkeHub\V1beta1\GenerateExclusivityManifestResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1beta1\GenerateExclusivityManifestResponse;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;

/**
 * @param string $formattedName The Membership resource name in the format
 *                              `projects/*/locations/*/memberships/*`. Please see
 *                              {@see GkeHubMembershipServiceClient::membershipName()} for help formatting this field.
 */
function generate_exclusivity_manifest_sample(string $formattedName): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var GenerateExclusivityManifestResponse $response */
        $response = $gkeHubMembershipServiceClient->generateExclusivityManifest($formattedName);
        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 = GkeHubMembershipServiceClient::membershipName(
        '[PROJECT]',
        '[LOCATION]',
        '[MEMBERSHIP]'
    );

    generate_exclusivity_manifest_sample($formattedName);
}

getMembership

Gets the details of a Membership.

Parameters
Name Description
name string

Required. The Membership resource name in the format projects/*/locations/*/memberships/*.
optionalArgs 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\GkeHub\V1beta1\Membership
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\GkeHub\V1beta1\Membership;

/**
 * @param string $formattedName The Membership resource name in the format
 *                              `projects/*/locations/*/memberships/*`. Please see
 *                              {@see GkeHubMembershipServiceClient::membershipName()} for help formatting this field.
 */
function get_membership_sample(string $formattedName): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Membership $response */
        $response = $gkeHubMembershipServiceClient->getMembership($formattedName);
        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 = GkeHubMembershipServiceClient::membershipName(
        '[PROJECT]',
        '[LOCATION]',
        '[MEMBERSHIP]'
    );

    get_membership_sample($formattedName);
}

listMemberships

Lists Memberships in a given project and location.

Parameters
Name Description
parent string

Required. The parent (project and location) where the Memberships will be listed. Specified in the format projects/*/locations/*. projects/*/locations/- list memberships in all the regions.
optionalArgs array

Optional.
↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ filter string

Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Name is bar in project foo-proj and location global: name = "projects/foo-proj/locations/global/membership/bar" - Memberships that have a label called foo: labels.foo:* - Memberships that have a label called foo whose value is bar: labels.foo = bar - Memberships in the CREATING state: state = CREATING
↳ orderBy string

Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
↳ 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\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\GkeHub\V1beta1\Membership;

/**
 * @param string $formattedParent The parent (project and location) where the Memberships will be
 *                                listed. Specified in the format `projects/*/locations/*`.
 *                                `projects/*/locations/-` list memberships in all the regions. Please see
 *                                {@see GkeHubMembershipServiceClient::locationName()} for help formatting this field.
 */
function list_memberships_sample(string $formattedParent): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

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

        /** @var Membership $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 = GkeHubMembershipServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_memberships_sample($formattedParent);
}

updateMembership

Updates an existing Membership.

Parameters
Name Description
name string

Required. The membership resource name in the format: projects/[project_id]/locations/global/memberships/[membership_id]
updateMask Google\Protobuf\FieldMask

Required. Mask of fields to update. At least one field path must be specified in this mask.
resource Google\Cloud\GkeHub\V1beta1\Membership

Required. Only fields specified in update_mask are updated. If you specify a field in the update_mask but don't specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It's not possible to update a key's value to the empty string. If you specify the update_mask to be a special path "*", fully replaces all user-modifiable fields to match resource.
optionalArgs array

Optional.
↳ requestId string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
↳ 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\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\GkeHub\V1beta1\Membership;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $formattedName The membership resource name in the format:
 *                              `projects/[project_id]/locations/global/memberships/[membership_id]`
 *                              Please see {@see GkeHubMembershipServiceClient::membershipName()} for help formatting this field.
 */
function update_membership_sample(string $formattedName): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $updateMask = new FieldMask();
    $resource = new Membership();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $gkeHubMembershipServiceClient->updateMembership(
            $formattedName,
            $updateMask,
            $resource
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Membership $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = GkeHubMembershipServiceClient::membershipName(
        '[PROJECT]',
        '[LOCATION]',
        '[MEMBERSHIP]'
    );

    update_membership_sample($formattedName);
}

validateExclusivity

ValidateExclusivity validates the state of exclusivity in the cluster.

The validation does not depend on an existing Hub membership resource.

Parameters
Name Description
parent string

Required. The parent (project and location) where the Memberships will be created. Specified in the format projects/*/locations/*.
intendedMembership string

Required. The intended membership name under the parent. This method only does validation in anticipation of a CreateMembership call with the same name.
optionalArgs array

Optional.
↳ crManifest string

Optional. The YAML of the membership CR in the cluster. Empty if the membership CR does not exist.
↳ 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\GkeHub\V1beta1\ValidateExclusivityResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\GkeHub\V1beta1\ValidateExclusivityResponse;

/**
 * @param string $formattedParent    The parent (project and location) where the Memberships will be
 *                                   created. Specified in the format `projects/*/locations/*`. Please see
 *                                   {@see GkeHubMembershipServiceClient::locationName()} for help formatting this field.
 * @param string $intendedMembership The intended membership name under the `parent`. This method only
 *                                   does validation in anticipation of a CreateMembership call with the same
 *                                   name.
 */
function validate_exclusivity_sample(string $formattedParent, string $intendedMembership): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var ValidateExclusivityResponse $response */
        $response = $gkeHubMembershipServiceClient->validateExclusivity(
            $formattedParent,
            $intendedMembership
        );
        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
{
    $formattedParent = GkeHubMembershipServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $intendedMembership = '[INTENDED_MEMBERSHIP]';

    validate_exclusivity_sample($formattedParent, $intendedMembership);
}

getLocation

Gets information about a location.

Parameters
Name Description
optionalArgs array

Optional.
↳ name string

Resource name for the location.
↳ 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\Location\Location
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

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

listLocations

Lists information about the supported locations for this service.

Parameters
Name Description
optionalArgs array

Optional.
↳ name string

The resource that owns the locations collection, if applicable.
↳ filter string

The standard list filter.
↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ 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\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\Location\Location;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

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

        /** @var Location $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());
    }
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
optionalArgs array

Optional.
↳ options GetPolicyOptions

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
↳ 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\Iam\V1\Policy
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $gkeHubMembershipServiceClient->getIamPolicy($resource);
        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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy Google\Cloud\Iam\V1\Policy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
optionalArgs array

Optional.
↳ updateMask FieldMask

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"
↳ 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\Iam\V1\Policy
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $policy = new Policy();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $gkeHubMembershipServiceClient->setIamPolicy($resource, $policy);
        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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions string[]

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
optionalArgs 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\Iam\V1\TestIamPermissionsResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1beta1\GkeHubMembershipServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $gkeHubMembershipServiceClient = new GkeHubMembershipServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $permissions = [$permissionsElement,];

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $gkeHubMembershipServiceClient->testIamPermissions($resource, $permissions);
        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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name Description
operationName string

The name of the long running operation
methodName string

The name of the method used to start the operation
Returns
Type Description
Google\ApiCore\OperationResponse

static::locationName

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

Parameters
Name Description
project string
location string
Returns
Type Description
string The formatted location resource.

static::membershipName

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

Parameters
Name Description
project string
location string
membership string
Returns
Type Description
string The formatted membership 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

  • location: projects/{project}/locations/{location}
  • membership: projects/{project}/locations/{location}/memberships/{membership}

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.

Constants

SERVICE_NAME

Value: 'google.cloud.gkehub.v1beta1.GkeHubMembershipService'

The name of the service.

SERVICE_ADDRESS

Value: 'gkehub.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.