Compute V1 Client - Class DiskTypesClient (2.5.0)

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

Service Description: The DiskTypes API.

This class provides the ability to make remote calls to the backing service through methodcalls that map to API methods.

Namespace

Google \ Cloud \ Compute \ V1 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
optionsarray|Google\ApiCore\Options\ClientOptions

Optional. Options for configuring the service API wrapper.

↳ apiEndpointstring

The address of the API remote host. May optionally include the port, formatted as "

↳ credentialsFetchAuthTokenInterface|CredentialsWrapper

This option should only be used with a pre-constructedGoogle\Auth\FetchAuthTokenInterface orGoogle\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 explicitlyuse Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Compute\V1\DiskTypesClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new DiskTypesClient(['credentials' => $creds]);https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ credentialsConfigarray

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, seeGoogle\ApiCore\CredentialsWrapper::build() .

↳ disableRetriesbool

Determines whether or not retries defined by the client configuration should be disabled. Defaults tofalse.

↳ clientConfigstring|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.

↳ transportstring|TransportInterface

The transport used for executing network requests. At the moment, supports onlyrest.Advanced usage: Additionally, it is possible to pass in an already instantiatedGoogle\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfigarray

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 theGoogle\ApiCore\Transport\RestTransport::build() method for the supported options.

↳ clientCertSourcecallable

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.

↳ loggerfalse|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomainstring

The service domain for the client. Defaults to 'googleapis.com'.

aggregatedList

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\AggregatedListDiskTypesRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;use Google\ApiCore\PagedListResponse;use Google\Cloud\Compute\V1\AggregatedListDiskTypesRequest;use Google\Cloud\Compute\V1\Client\DiskTypesClient;/** * @param string $project Project ID for this request. */function aggregated_list_sample(string $project): void{    // Create a client.    $diskTypesClient = new DiskTypesClient();    // Prepare the request message.    $request = (new AggregatedListDiskTypesRequest())        ->setProject($project);    // Call the API and handle any network failures.    try {        /** @var PagedListResponse $response */        $response = $diskTypesClient->aggregatedList($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{    $project = '[PROJECT]';    aggregated_list_sample($project);}

get

Returns the specified disk type.

The async variant isDiskTypesClient::getAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\GetDiskTypeRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Compute\V1\DiskType
Example
use Google\ApiCore\ApiException;use Google\Cloud\Compute\V1\Client\DiskTypesClient;use Google\Cloud\Compute\V1\DiskType;use Google\Cloud\Compute\V1\GetDiskTypeRequest;/** * @param string $diskType Name of the disk type to return. * @param string $project  Project ID for this request. * @param string $zone     The name of the zone for this request. */function get_sample(string $diskType, string $project, string $zone): void{    // Create a client.    $diskTypesClient = new DiskTypesClient();    // Prepare the request message.    $request = (new GetDiskTypeRequest())        ->setDiskType($diskType)        ->setProject($project)        ->setZone($zone);    // Call the API and handle any network failures.    try {        /** @var DiskType $response */        $response = $diskTypesClient->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{    $diskType = '[DISK_TYPE]';    $project = '[PROJECT]';    $zone = '[ZONE]';    get_sample($diskType, $project, $zone);}

list

Retrieves a list of disk types available to the specifiedproject.

The async variant isDiskTypesClient::listAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\ListDiskTypesRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;use Google\ApiCore\PagedListResponse;use Google\Cloud\Compute\V1\Client\DiskTypesClient;use Google\Cloud\Compute\V1\ListDiskTypesRequest;/** * @param string $project Project ID for this request. * @param string $zone    The name of the zone for this request. */function list_sample(string $project, string $zone): void{    // Create a client.    $diskTypesClient = new DiskTypesClient();    // Prepare the request message.    $request = (new ListDiskTypesRequest())        ->setProject($project)        ->setZone($zone);    // Call the API and handle any network failures.    try {        /** @var PagedListResponse $response */        $response = $diskTypesClient->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{    $project = '[PROJECT]';    $zone = '[ZONE]';    list_sample($project, $zone);}

aggregatedListAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\AggregatedListDiskTypesRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

getAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\GetDiskTypeRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\DiskType>

listAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\ListDiskTypesRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-23 UTC.