Reference documentation and code samples for the Compute V1 Client class HostsClient.
Service Description: The Hosts API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array|Google\ApiCore\Options\ClientOptions
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 |
Google\Auth\FetchAuthTokenInterface|Google\ApiCore\CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ 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|Google\ApiCore\Transport\TransportInterface
The transport used for executing network requests. At the moment, supports only |
↳ 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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method 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. |
↳ logger |
false|Psr\Log\LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
↳ universeDomain |
string
The service domain for the client. Defaults to 'googleapis.com'. |
get
Retrieves information about the specified host.
The async variant is HostsClient::getAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\GetHostRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\Compute\V1\Host |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\HostsClient;
use Google\Cloud\Compute\V1\GetHostRequest;
use Google\Cloud\Compute\V1\Host;
/**
* @param string $association The parent resource association for the Host. This field specifies the
* hierarchical context (e.g., reservation, block, sub-block) when
* accessing the host. For example, reservations/reservation_name,
* reservations/reservation_name/reservationBlocks/reservation_block_name or
* reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name.
* @param string $host The name of the host, formatted as RFC1035 or a resource ID
* number.
* @param string $project The project ID for this request.
* @param string $zone The name of the zone for this request, formatted as RFC1035.
*/
function get_sample(string $association, string $host, string $project, string $zone): void
{
// Create a client.
$hostsClient = new HostsClient();
// Prepare the request message.
$request = (new GetHostRequest())
->setAssociation($association)
->setHost($host)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var Host $response */
$response = $hostsClient->get($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
{
$association = '[ASSOCIATION]';
$host = '[HOST]';
$project = '[PROJECT]';
$zone = '[ZONE]';
get_sample($association, $host, $project, $zone);
}
getVersion
Allows customers to get SBOM versions of a host.
The async variant is HostsClient::getVersionAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\GetVersionHostRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\Compute\V1\Client\HostsClient;
use Google\Cloud\Compute\V1\GetVersionHostRequest;
use Google\Cloud\Compute\V1\HostsGetVersionRequest;
use Google\Rpc\Status;
/**
* @param string $association The parent resource association for the Host. This field specifies the
* hierarchical context (e.g., reservation, block, sub-block) when
* accessing the host.
* @param string $host The name of the host, formatted as RFC1035 or a resource ID
* number.
* @param string $project Project ID for this request.
* @param string $zone Name of the zone for this request. Zone name should conform to RFC1035.
*/
function get_version_sample(
string $association,
string $host,
string $project,
string $zone
): void {
// Create a client.
$hostsClient = new HostsClient();
// Prepare the request message.
$hostsGetVersionRequestResource = new HostsGetVersionRequest();
$request = (new GetVersionHostRequest())
->setAssociation($association)
->setHost($host)
->setHostsGetVersionRequestResource($hostsGetVersionRequestResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $hostsClient->getVersion($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
{
$association = '[ASSOCIATION]';
$host = '[HOST]';
$project = '[PROJECT]';
$zone = '[ZONE]';
get_version_sample($association, $host, $project, $zone);
}
list
Retrieves a list of hosts.
The async variant is HostsClient::listAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\ListHostsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\Compute\V1\Client\HostsClient;
use Google\Cloud\Compute\V1\ListHostsRequest;
/**
* @param string $association The parent resource association for the Host. This field specifies the
* hierarchical context (e.g., reservation, block, sub-block) when
* accessing the host. For example, reservations/reservation_name,
* reservations/reservation_name/reservationBlocks/reservation_block_name or
* reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name.
* @param string $project The project ID for this request.
* @param string $zone The name of the zone for this request, formatted as RFC1035.
*/
function list_sample(string $association, string $project, string $zone): void
{
// Create a client.
$hostsClient = new HostsClient();
// Prepare the request message.
$request = (new ListHostsRequest())
->setAssociation($association)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $hostsClient->list($request);
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
{
$association = '[ASSOCIATION]';
$project = '[PROJECT]';
$zone = '[ZONE]';
list_sample($association, $project, $zone);
}
getAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\GetHostRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Host> |
|
getVersionAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\GetVersionHostRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
listAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\ListHostsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
getOperationsClient
Return an ZoneOperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
ZoneOperationsClient |
|
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 |
|