Compute V1 Client - Class ImageFamilyViewsClient (1.10.1)

Reference documentation and code samples for the Compute V1 Client class ImageFamilyViewsClient.

Service Description: The ImageFamilyViews API.

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:

$imageFamilyViewsClient = new ImageFamilyViewsClient();
try {
    $family = 'family';
    $project = 'project';
    $zone = 'zone';
    $response = $imageFamilyViewsClient->get($family, $project, $zone);
} finally {
    $imageFamilyViewsClient->close();
}

This service has a new (beta) implementation. See Google\Cloud\Compute\V1\Client\ImageFamilyViewsClient to use the new surface.

Namespace

Google \ Cloud \ Compute \ V1

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. At the moment, supports only `rest`. 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 = [ '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.

get

Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.

Parameters
Name	Description
`family`	`string` Name of the image family to search for.
`project`	`string` Project ID for this request.
`zone`	`string` The name of the zone for this request.
`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\Compute\V1\ImageFamilyView`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\ImageFamilyView;
use Google\Cloud\Compute\V1\ImageFamilyViewsClient;

/**
 * @param string $family  Name of the image family to search for.
 * @param string $project Project ID for this request.
 * @param string $zone    The name of the zone for this request.
 */
function get_sample(string $family, string $project, string $zone): void
{
    // Create a client.
    $imageFamilyViewsClient = new ImageFamilyViewsClient();

    // Call the API and handle any network failures.
    try {
        /** @var ImageFamilyView $response */
        $response = $imageFamilyViewsClient->get($family, $project, $zone);
        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
{
    $family = '[FAMILY]';
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    get_sample($family, $project, $zone);
}

Constants

SERVICE_NAME

Value: 'google.cloud.compute.v1.ImageFamilyViews'

The name of the service.

SERVICE_ADDRESS

Value: 'compute.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.