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();
}
Methods
__construct
Constructor.
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 {@see} object or {@see} 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 {@see} .
↳ 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 {@see} 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 {@see} 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.
Sample code:
$imageFamilyViewsClient = new ImageFamilyViewsClient();
try {
$family = 'family';
$project = 'project';
$zone = 'zone';
$response = $imageFamilyViewsClient->get($family, $project, $zone);
} finally {
$imageFamilyViewsClient->close();
}
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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
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.
