Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class GkeHubClient.
Service Description: The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ GkeHub \ V1 \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
createFeature
Adds a new Feature.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::createFeatureAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\CreateFeatureRequest
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\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\CreateFeatureRequest;
use Google\Cloud\GkeHub\V1\Feature;
use Google\Rpc\Status;
/**
* 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 create_feature_sample(): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$request = new CreateFeatureRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gkeHubClient->createFeature($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Feature $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());
}
}
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.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::createMembershipAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\CreateMembershipRequest
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\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\CreateMembershipRequest;
use Google\Cloud\GkeHub\V1\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 GkeHubClient::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.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$resource = new Membership();
$request = (new CreateMembershipRequest())
->setParent($formattedParent)
->setMembershipId($membershipId)
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gkeHubClient->createMembership($request);
$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 = GkeHubClient::locationName('[PROJECT]', '[LOCATION]');
$membershipId = '[MEMBERSHIP_ID]';
create_membership_sample($formattedParent, $membershipId);
}
deleteFeature
Removes a Feature.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::deleteFeatureAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\DeleteFeatureRequest
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\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\DeleteFeatureRequest;
use Google\Rpc\Status;
/**
* 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 delete_feature_sample(): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$request = new DeleteFeatureRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gkeHubClient->deleteFeature($request);
$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());
}
}
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.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::deleteMembershipAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\DeleteMembershipRequest
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\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\DeleteMembershipRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The Membership resource name in the format
* `projects/*/locations/*/memberships/*`. Please see
* {@see GkeHubClient::membershipName()} for help formatting this field.
*/
function delete_membership_sample(string $formattedName): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$request = (new DeleteMembershipRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gkeHubClient->deleteMembership($request);
$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 = GkeHubClient::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.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::generateConnectManifestAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\GenerateConnectManifestRequest
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\GkeHub\V1\GenerateConnectManifestResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\GenerateConnectManifestRequest;
use Google\Cloud\GkeHub\V1\GenerateConnectManifestResponse;
/**
* @param string $formattedName The Membership resource name the Agent will associate with, in
* the format `projects/*/locations/*/memberships/*`. Please see
* {@see GkeHubClient::membershipName()} for help formatting this field.
*/
function generate_connect_manifest_sample(string $formattedName): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$request = (new GenerateConnectManifestRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var GenerateConnectManifestResponse $response */
$response = $gkeHubClient->generateConnectManifest($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 = GkeHubClient::membershipName('[PROJECT]', '[LOCATION]', '[MEMBERSHIP]');
generate_connect_manifest_sample($formattedName);
}
getFeature
Gets details of a single Feature.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::getFeatureAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\GetFeatureRequest
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\GkeHub\V1\Feature |
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\Feature;
use Google\Cloud\GkeHub\V1\GetFeatureRequest;
/**
* 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_feature_sample(): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$request = new GetFeatureRequest();
// Call the API and handle any network failures.
try {
/** @var Feature $response */
$response = $gkeHubClient->getFeature($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getMembership
Gets the details of a Membership.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::getMembershipAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\GetMembershipRequest
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\GkeHub\V1\Membership |
use Google\ApiCore\ApiException;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\GetMembershipRequest;
use Google\Cloud\GkeHub\V1\Membership;
/**
* @param string $formattedName The Membership resource name in the format
* `projects/*/locations/*/memberships/*`. Please see
* {@see GkeHubClient::membershipName()} for help formatting this field.
*/
function get_membership_sample(string $formattedName): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$request = (new GetMembershipRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Membership $response */
$response = $gkeHubClient->getMembership($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 = GkeHubClient::membershipName('[PROJECT]', '[LOCATION]', '[MEMBERSHIP]');
get_membership_sample($formattedName);
}
listFeatures
Lists Features in a given project and location.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::listFeaturesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\ListFeaturesRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\Feature;
use Google\Cloud\GkeHub\V1\ListFeaturesRequest;
/**
* 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_features_sample(): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$request = new ListFeaturesRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $gkeHubClient->listFeatures($request);
/** @var Feature $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());
}
}
listMemberships
Lists Memberships in a given project and location.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::listMembershipsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\ListMembershipsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\ListMembershipsRequest;
use Google\Cloud\GkeHub\V1\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 GkeHubClient::locationName()} for help formatting this field.
*/
function list_memberships_sample(string $formattedParent): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$request = (new ListMembershipsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $gkeHubClient->listMemberships($request);
/** @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 = GkeHubClient::locationName('[PROJECT]', '[LOCATION]');
list_memberships_sample($formattedParent);
}
updateFeature
Updates an existing Feature.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::updateFeatureAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\UpdateFeatureRequest
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\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\Feature;
use Google\Cloud\GkeHub\V1\UpdateFeatureRequest;
use Google\Rpc\Status;
/**
* 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 update_feature_sample(): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$request = new UpdateFeatureRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gkeHubClient->updateFeature($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Feature $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());
}
}
updateMembership
Updates an existing Membership.
The async variant is Google\Cloud\GkeHub\V1\Client\BaseClient\self::updateMembershipAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\UpdateMembershipRequest
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\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\GkeHub\V1\Client\GkeHubClient;
use Google\Cloud\GkeHub\V1\Membership;
use Google\Cloud\GkeHub\V1\UpdateMembershipRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* @param string $formattedName The Membership resource name in the format
* `projects/*/locations/*/memberships/*`. Please see
* {@see GkeHubClient::membershipName()} for help formatting this field.
*/
function update_membership_sample(string $formattedName): void
{
// Create a client.
$gkeHubClient = new GkeHubClient();
// Prepare the request message.
$updateMask = new FieldMask();
$resource = new Membership();
$request = (new UpdateMembershipRequest())
->setName($formattedName)
->setUpdateMask($updateMask)
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gkeHubClient->updateMembership($request);
$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 = GkeHubClient::membershipName('[PROJECT]', '[LOCATION]', '[MEMBERSHIP]');
update_membership_sample($formattedName);
}
createFeatureAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\CreateFeatureRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createMembershipAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\CreateMembershipRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteFeatureAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\DeleteFeatureRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteMembershipAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\DeleteMembershipRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
generateConnectManifestAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\GenerateConnectManifestRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getFeatureAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\GetFeatureRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getMembershipAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\GetMembershipRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listFeaturesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\ListFeaturesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listMembershipsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\ListMembershipsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateFeatureAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\UpdateFeatureRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateMembershipAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\GkeHub\V1\UpdateMembershipRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
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::featureName
Formats a string containing the fully-qualified path to represent a feature resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
feature |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted feature resource. |
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
- feature: projects/{project}/locations/{location}/features/{feature}
- 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. |