Reference documentation and code samples for the Google Cloud Lustre V1 Client class LustreClient.
Service Description: Service describing handlers for resources
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ Lustre \ 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. 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. |
↳ 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'. |
createDirectoryPolicy
Creates a directory policy resource.
The async variant is LustreClient::createDirectoryPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\CreateDirectoryPolicyRequest
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<Google\Cloud\Lustre\V1\DirectoryPolicy> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\CreateDirectoryPolicyRequest;
use Google\Cloud\Lustre\V1\DirectoryPolicy;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent instance.
* It must be in the format of
* `projects/{project}/locations/{location}/instances/{instance}`. Please see
* {@see LustreClient::instanceName()} for help formatting this field.
* @param string $directoryPolicyId The ID for the DirectoryPolicy to create.
* @param string $directoryPolicyDirectoryPath Immutable. The lustre instance filesystem full path of the
* directory. It must start with a slash. e.g. /lustre/testFolder
*/
function create_directory_policy_sample(
string $formattedParent,
string $directoryPolicyId,
string $directoryPolicyDirectoryPath
): void {
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$directoryPolicy = (new DirectoryPolicy())
->setDirectoryPath($directoryPolicyDirectoryPath);
$request = (new CreateDirectoryPolicyRequest())
->setParent($formattedParent)
->setDirectoryPolicyId($directoryPolicyId)
->setDirectoryPolicy($directoryPolicy);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->createDirectoryPolicy($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DirectoryPolicy $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 = LustreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
$directoryPolicyId = '[DIRECTORY_POLICY_ID]';
$directoryPolicyDirectoryPath = '[DIRECTORY_PATH]';
create_directory_policy_sample($formattedParent, $directoryPolicyId, $directoryPolicyDirectoryPath);
}
createInstance
Creates a new instance in a given project and location.
The async variant is LustreClient::createInstanceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\CreateInstanceRequest
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<Google\Cloud\Lustre\V1\Instance> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\CreateInstanceRequest;
use Google\Cloud\Lustre\V1\Instance;
use Google\Rpc\Status;
/**
* @param string $formattedParent The instance's project and location, in the format
* `projects/{project}/locations/{location}`. Locations map to Google Cloud
* zones; for example, `us-west1-b`. Please see
* {@see LustreClient::locationName()} for help formatting this field.
* @param string $instanceId The name of the Managed Lustre instance.
*
* * Must contain only lowercase letters, numbers, and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
* @param string $instanceFilesystem Immutable. The filesystem name for this instance. This name is
* used by client-side tools, including when mounting the instance. Must be
* eight characters or less and can only contain letters and numbers.
* @param int $instanceCapacityGib The storage capacity of the instance in gibibytes (GiB). Allowed
* values depend on the `perUnitStorageThroughput`. See [Performance
* tiers](https://docs.cloud.google.com/managed-lustre/docs/performance-tiers)
* for specific minimums, maximums, and step sizes for each performance tier.
* @param string $formattedInstanceNetwork Immutable. The full name of the VPC network to which the instance
* is connected. Must be in the format
* `projects/{project_id}/global/networks/{network_name}`. Please see
* {@see LustreClient::networkName()} for help formatting this field.
*/
function create_instance_sample(
string $formattedParent,
string $instanceId,
string $instanceFilesystem,
int $instanceCapacityGib,
string $formattedInstanceNetwork
): void {
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$instance = (new Instance())
->setFilesystem($instanceFilesystem)
->setCapacityGib($instanceCapacityGib)
->setNetwork($formattedInstanceNetwork);
$request = (new CreateInstanceRequest())
->setParent($formattedParent)
->setInstanceId($instanceId)
->setInstance($instance);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->createInstance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $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 = LustreClient::locationName('[PROJECT]', '[LOCATION]');
$instanceId = '[INSTANCE_ID]';
$instanceFilesystem = '[FILESYSTEM]';
$instanceCapacityGib = 0;
$formattedInstanceNetwork = LustreClient::networkName('[PROJECT]', '[NETWORK]');
create_instance_sample(
$formattedParent,
$instanceId,
$instanceFilesystem,
$instanceCapacityGib,
$formattedInstanceNetwork
);
}
createMirror
Creates a new mirror in a given instance.
The async variant is LustreClient::createMirrorAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\CreateMirrorRequest
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<Google\Cloud\Lustre\V1\Mirror> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\CreateMirrorRequest;
use Google\Cloud\Lustre\V1\GcsPath;
use Google\Cloud\Lustre\V1\LustrePath;
use Google\Cloud\Lustre\V1\Mirror;
use Google\Cloud\Lustre\V1\Mirror\Direction;
use Google\Rpc\Status;
/**
* @param string $formattedParent Parent instance resource where the mirror will be created, in the
* format: `projects/{project}/locations/{location}/instances/{instance}`
* Please see {@see LustreClient::instanceName()} for help formatting this field.
* @param string $mirrorId The ID to use for the mirror.
*
* * Must contain only lowercase letters, numbers, and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
*
* The ID cannot be changed after the mirror is created.
* @param string $mirrorGcsPathUri The URI to a Cloud Storage bucket, or a path within a bucket,
* using the format `gs://<bucket_name>/<optional_path_inside_bucket>/`. If a
* path inside the bucket is specified, it must end with a forward slash
* (`/`).
* @param int $mirrorDirection Immutable. Represents the direction of the mirror.
*/
function create_mirror_sample(
string $formattedParent,
string $mirrorId,
string $mirrorGcsPathUri,
int $mirrorDirection
): void {
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$mirrorGcsPath = (new GcsPath())
->setUri($mirrorGcsPathUri);
$mirrorLustrePath = new LustrePath();
$mirror = (new Mirror())
->setGcsPath($mirrorGcsPath)
->setLustrePath($mirrorLustrePath)
->setDirection($mirrorDirection);
$request = (new CreateMirrorRequest())
->setParent($formattedParent)
->setMirrorId($mirrorId)
->setMirror($mirror);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->createMirror($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Mirror $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 = LustreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
$mirrorId = '[MIRROR_ID]';
$mirrorGcsPathUri = '[URI]';
$mirrorDirection = Direction::DIRECTION_UNSPECIFIED;
create_mirror_sample($formattedParent, $mirrorId, $mirrorGcsPathUri, $mirrorDirection);
}
deleteDirectoryPolicy
Deletes a directory policy resource.
The async variant is LustreClient::deleteDirectoryPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\DeleteDirectoryPolicyRequest
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<null> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\DeleteDirectoryPolicyRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the directory policy.
* DirectoryPolicy names have the form
* `projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{id}`. Please see
* {@see LustreClient::directoryPolicyName()} for help formatting this field.
*/
function delete_directory_policy_sample(string $formattedName): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new DeleteDirectoryPolicyRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->deleteDirectoryPolicy($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 = LustreClient::directoryPolicyName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]',
'[DIRECTORY_POLICY]'
);
delete_directory_policy_sample($formattedName);
}
deleteInstance
Deletes a single instance.
The async variant is LustreClient::deleteInstanceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\DeleteInstanceRequest
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<null> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\DeleteInstanceRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the instance to delete, in the format
* `projects/{projectId}/locations/{location}/instances/{instanceId}`. Please see
* {@see LustreClient::instanceName()} for help formatting this field.
*/
function delete_instance_sample(string $formattedName): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new DeleteInstanceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->deleteInstance($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 = LustreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
delete_instance_sample($formattedName);
}
deleteMirror
Deletes a single mirror.
The async variant is LustreClient::deleteMirrorAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\DeleteMirrorRequest
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<null> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\DeleteMirrorRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName Name of the mirror to delete, in the format:
* `projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}`
* Please see {@see LustreClient::mirrorName()} for help formatting this field.
*/
function delete_mirror_sample(string $formattedName): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new DeleteMirrorRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->deleteMirror($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 = LustreClient::mirrorName('[PROJECT]', '[LOCATION]', '[INSTANCE]', '[MIRROR]');
delete_mirror_sample($formattedName);
}
exportData
Exports data from a Managed Lustre instance to Cloud Storage.
The async variant is LustreClient::exportDataAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ExportDataRequest
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<Google\Cloud\Lustre\V1\ExportDataResponse> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\ExportDataRequest;
use Google\Cloud\Lustre\V1\ExportDataResponse;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the Managed Lustre instance in the format
* `projects/{project}/locations/{location}/instances/{instance}`. Please see
* {@see LustreClient::instanceName()} for help formatting this field.
*/
function export_data_sample(string $formattedName): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new ExportDataRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->exportData($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ExportDataResponse $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 = LustreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
export_data_sample($formattedName);
}
getDirectoryPolicy
Gets details of a single directory policy.
The async variant is LustreClient::getDirectoryPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\GetDirectoryPolicyRequest
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\Lustre\V1\DirectoryPolicy |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\DirectoryPolicy;
use Google\Cloud\Lustre\V1\GetDirectoryPolicyRequest;
/**
* @param string $formattedName The resource name of the directory policy.
* DirectoryPolicy names have the form
* `projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{id}`. Please see
* {@see LustreClient::directoryPolicyName()} for help formatting this field.
*/
function get_directory_policy_sample(string $formattedName): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new GetDirectoryPolicyRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DirectoryPolicy $response */
$response = $lustreClient->getDirectoryPolicy($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 = LustreClient::directoryPolicyName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]',
'[DIRECTORY_POLICY]'
);
get_directory_policy_sample($formattedName);
}
getInstance
Gets details of a single instance.
The async variant is LustreClient::getInstanceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\GetInstanceRequest
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\Lustre\V1\Instance |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\GetInstanceRequest;
use Google\Cloud\Lustre\V1\Instance;
/**
* @param string $formattedName The instance resource name, in the format
* `projects/{projectId}/locations/{location}/instances/{instanceId}`. Please see
* {@see LustreClient::instanceName()} for help formatting this field.
*/
function get_instance_sample(string $formattedName): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new GetInstanceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Instance $response */
$response = $lustreClient->getInstance($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 = LustreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
get_instance_sample($formattedName);
}
getMirror
Gets details of a single mirror.
The async variant is LustreClient::getMirrorAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\GetMirrorRequest
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\Lustre\V1\Mirror |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\GetMirrorRequest;
use Google\Cloud\Lustre\V1\Mirror;
/**
* @param string $formattedName Name of the mirror to retrieve, in the format:
* `projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}`
* Please see {@see LustreClient::mirrorName()} for help formatting this field.
*/
function get_mirror_sample(string $formattedName): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new GetMirrorRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Mirror $response */
$response = $lustreClient->getMirror($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 = LustreClient::mirrorName('[PROJECT]', '[LOCATION]', '[INSTANCE]', '[MIRROR]');
get_mirror_sample($formattedName);
}
importData
Imports data from Cloud Storage to a Managed Lustre instance.
The async variant is LustreClient::importDataAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ImportDataRequest
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<Google\Cloud\Lustre\V1\ImportDataResponse> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\ImportDataRequest;
use Google\Cloud\Lustre\V1\ImportDataResponse;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the Managed Lustre instance in the format
* `projects/{project}/locations/{location}/instances/{instance}`. Please see
* {@see LustreClient::instanceName()} for help formatting this field.
*/
function import_data_sample(string $formattedName): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new ImportDataRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->importData($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ImportDataResponse $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 = LustreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
import_data_sample($formattedName);
}
listDirectoryPolicies
Gets details of multiple directory policies under a given instance.
The async variant is LustreClient::listDirectoryPoliciesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ListDirectoryPoliciesRequest
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\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\DirectoryPolicy;
use Google\Cloud\Lustre\V1\ListDirectoryPoliciesRequest;
/**
* @param string $formattedParent The parent instance.
* It must be in the format of
* `projects/{project}/locations/{location}/instances/{instance}`. Please see
* {@see LustreClient::instanceName()} for help formatting this field.
*/
function list_directory_policies_sample(string $formattedParent): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new ListDirectoryPoliciesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $lustreClient->listDirectoryPolicies($request);
/** @var DirectoryPolicy $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 = LustreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
list_directory_policies_sample($formattedParent);
}
listInstances
Lists instances in a given project and location.
The async variant is LustreClient::listInstancesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ListInstancesRequest
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\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\Instance;
use Google\Cloud\Lustre\V1\ListInstancesRequest;
/**
* @param string $formattedParent The project and location for which to retrieve a list of
* instances, in the format `projects/{projectId}/locations/{location}`.
*
* To retrieve instance information for all locations, use "-" as the value
* of `{location}`. Please see
* {@see LustreClient::locationName()} for help formatting this field.
*/
function list_instances_sample(string $formattedParent): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new ListInstancesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $lustreClient->listInstances($request);
/** @var Instance $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 = LustreClient::locationName('[PROJECT]', '[LOCATION]');
list_instances_sample($formattedParent);
}
listMirrors
Gets details of multiple mirrors under a given instance.
The async variant is LustreClient::listMirrorsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ListMirrorsRequest
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\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\ListMirrorsRequest;
use Google\Cloud\Lustre\V1\Mirror;
/**
* @param string $formattedParent Parent instance resource where the mirrors will be listed, in the
* format: `projects/{project}/locations/{location}/instances/{instance}`
* Please see {@see LustreClient::instanceName()} for help formatting this field.
*/
function list_mirrors_sample(string $formattedParent): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = (new ListMirrorsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $lustreClient->listMirrors($request);
/** @var Mirror $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 = LustreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
list_mirrors_sample($formattedParent);
}
rescheduleMaintenance
Reschedules a planned maintenance event for a specific instance.
The async variant is LustreClient::rescheduleMaintenanceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\RescheduleMaintenanceRequest
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<Google\Cloud\Lustre\V1\Instance> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\Instance;
use Google\Cloud\Lustre\V1\RescheduleMaintenanceRequest;
use Google\Cloud\Lustre\V1\RescheduleMaintenanceRequest\Reschedule;
use Google\Cloud\Lustre\V1\RescheduleMaintenanceRequest\RescheduleType;
use Google\Rpc\Status;
/**
* @param string $formattedName Format:
* projects/{project}/locations/{location}/instances/{instance}
* Please see {@see LustreClient::instanceName()} for help formatting this field.
* @param int $rescheduleRescheduleType The type of rescheduling.
*/
function reschedule_maintenance_sample(string $formattedName, int $rescheduleRescheduleType): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$reschedule = (new Reschedule())
->setRescheduleType($rescheduleRescheduleType);
$request = (new RescheduleMaintenanceRequest())
->setName($formattedName)
->setReschedule($reschedule);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->rescheduleMaintenance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $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 = LustreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
$rescheduleRescheduleType = RescheduleType::RESCHEDULE_TYPE_UNSPECIFIED;
reschedule_maintenance_sample($formattedName, $rescheduleRescheduleType);
}
updateInstance
Updates the parameters of a single instance.
The async variant is LustreClient::updateInstanceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\UpdateInstanceRequest
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<Google\Cloud\Lustre\V1\Instance> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\Instance;
use Google\Cloud\Lustre\V1\UpdateInstanceRequest;
use Google\Rpc\Status;
/**
* @param string $instanceFilesystem Immutable. The filesystem name for this instance. This name is
* used by client-side tools, including when mounting the instance. Must be
* eight characters or less and can only contain letters and numbers.
* @param int $instanceCapacityGib The storage capacity of the instance in gibibytes (GiB). Allowed
* values depend on the `perUnitStorageThroughput`. See [Performance
* tiers](https://docs.cloud.google.com/managed-lustre/docs/performance-tiers)
* for specific minimums, maximums, and step sizes for each performance tier.
* @param string $formattedInstanceNetwork Immutable. The full name of the VPC network to which the instance
* is connected. Must be in the format
* `projects/{project_id}/global/networks/{network_name}`. Please see
* {@see LustreClient::networkName()} for help formatting this field.
*/
function update_instance_sample(
string $instanceFilesystem,
int $instanceCapacityGib,
string $formattedInstanceNetwork
): void {
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$instance = (new Instance())
->setFilesystem($instanceFilesystem)
->setCapacityGib($instanceCapacityGib)
->setNetwork($formattedInstanceNetwork);
$request = (new UpdateInstanceRequest())
->setInstance($instance);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->updateInstance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $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
{
$instanceFilesystem = '[FILESYSTEM]';
$instanceCapacityGib = 0;
$formattedInstanceNetwork = LustreClient::networkName('[PROJECT]', '[NETWORK]');
update_instance_sample($instanceFilesystem, $instanceCapacityGib, $formattedInstanceNetwork);
}
updateMirror
Updates the parameters of a single mirror.
The async variant is LustreClient::updateMirrorAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\UpdateMirrorRequest
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<Google\Cloud\Lustre\V1\Mirror> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Lustre\V1\Client\LustreClient;
use Google\Cloud\Lustre\V1\GcsPath;
use Google\Cloud\Lustre\V1\LustrePath;
use Google\Cloud\Lustre\V1\Mirror;
use Google\Cloud\Lustre\V1\Mirror\Direction;
use Google\Cloud\Lustre\V1\UpdateMirrorRequest;
use Google\Rpc\Status;
/**
* @param string $mirrorGcsPathUri The URI to a Cloud Storage bucket, or a path within a bucket,
* using the format `gs://<bucket_name>/<optional_path_inside_bucket>/`. If a
* path inside the bucket is specified, it must end with a forward slash
* (`/`).
* @param int $mirrorDirection Immutable. Represents the direction of the mirror.
*/
function update_mirror_sample(string $mirrorGcsPathUri, int $mirrorDirection): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$mirrorGcsPath = (new GcsPath())
->setUri($mirrorGcsPathUri);
$mirrorLustrePath = new LustrePath();
$mirror = (new Mirror())
->setGcsPath($mirrorGcsPath)
->setLustrePath($mirrorLustrePath)
->setDirection($mirrorDirection);
$request = (new UpdateMirrorRequest())
->setMirror($mirror);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $lustreClient->updateMirror($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Mirror $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
{
$mirrorGcsPathUri = '[URI]';
$mirrorDirection = Direction::DIRECTION_UNSPECIFIED;
update_mirror_sample($mirrorGcsPathUri, $mirrorDirection);
}
getLocation
Gets information about a location.
The async variant is LustreClient::getLocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
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\Location\Location |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\Lustre\V1\Client\LustreClient;
/**
* 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_location_sample(): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $lustreClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
This method lists locations based on the resource scope provided in
the ListLocationsRequest.name field: *
Global locations: If name is empty, the method lists the
public locations available to all projects. * Project-specific
locations: If name follows the format
projects/{project}, the method lists locations visible to that
specific project. This includes public, private, or other
project-specific locations enabled for the project.
For gRPC and client library implementations, the resource name is
passed as the name field. For direct service calls, the resource
name is
incorporated into the request path based on the specific service
implementation and version.
The async variant is LustreClient::listLocationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
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\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\Lustre\V1\Client\LustreClient;
/**
* 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_locations_sample(): void
{
// Create a client.
$lustreClient = new LustreClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $lustreClient->listLocations($request);
/** @var Location $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());
}
}
createDirectoryPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\CreateDirectoryPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
createInstanceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\CreateInstanceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
createMirrorAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\CreateMirrorRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteDirectoryPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\DeleteDirectoryPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteInstanceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\DeleteInstanceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteMirrorAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\DeleteMirrorRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
exportDataAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ExportDataRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
getDirectoryPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\GetDirectoryPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Lustre\V1\DirectoryPolicy> |
|
getInstanceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\GetInstanceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Lustre\V1\Instance> |
|
getMirrorAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\GetMirrorRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Lustre\V1\Mirror> |
|
importDataAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ImportDataRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
listDirectoryPoliciesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ListDirectoryPoliciesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listInstancesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ListInstancesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listMirrorsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\ListMirrorsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
rescheduleMaintenanceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\RescheduleMaintenanceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
updateInstanceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\UpdateInstanceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
updateMirrorAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Lustre\V1\UpdateMirrorRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
getLocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
|
listLocationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\LongRunning\Client\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::cryptoKeyName
Formats a string containing the fully-qualified path to represent a crypto_key resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted crypto_key resource. |
static::directoryPolicyName
Formats a string containing the fully-qualified path to represent a directory_policy resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
instance |
string
|
directoryPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted directory_policy resource. |
static::instanceName
Formats a string containing the fully-qualified path to represent a instance resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
instance |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted instance 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::mirrorName
Formats a string containing the fully-qualified path to represent a mirror resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
instance |
string
|
mirror |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted mirror resource. |
static::networkName
Formats a string containing the fully-qualified path to represent a network resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
network |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted network resource. |
static::projectLocationResourcePolicyName
Formats a string containing the fully-qualified path to represent a project_location_resource_policy resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
resourcePolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_resource_policy resource. |
static::projectRegionResourcePolicyName
Formats a string containing the fully-qualified path to represent a project_region_resource_policy resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
region |
string
|
resourcePolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_region_resource_policy resource. |
static::resourcePolicyName
Formats a string containing the fully-qualified path to represent a resource_policy resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
region |
string
|
resourcePolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted resource_policy resource. |
static::serviceAccountName
Formats a string containing the fully-qualified path to represent a service_account resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
serviceAccount |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted service_account 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
- cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
- directoryPolicy: projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{directory_policy}
- instance: projects/{project}/locations/{location}/instances/{instance}
- location: projects/{project}/locations/{location}
- mirror: projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}
- network: projects/{project}/global/networks/{network}
- projectLocationResourcePolicy: projects/{project}/locations/{location}/resourcePolicies/{resource_policy}
- projectRegionResourcePolicy: projects/{project}/regions/{region}/resourcePolicies/{resource_policy}
- resourcePolicy: projects/{project}/regions/{region}/resourcePolicies/{resource_policy}
- serviceAccount: projects/{project}/serviceAccounts/{service_account}
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. |