Google Cloud Lustre V1 Client - Class ExportDataRequest (0.6.0)

Reference documentation and code samples for the Google Cloud Lustre V1 Client class ExportDataRequest.

Export data from Managed Lustre to a Cloud Storage bucket.

Generated from protobuf message google.cloud.lustre.v1.ExportDataRequest

Namespace

Google \ Cloud \ Lustre \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ lustre_path LustrePath

The root directory path to the Managed Lustre file system. Must start with /. Default is /.

↳ gcs_path GcsPath

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 (/).

↳ name string

Required. The name of the Managed Lustre instance in the format projects/{project}/locations/{location}/instances/{instance}.

↳ request_id string

Optional. UUID to identify requests.

↳ service_account string

Optional. User-specified service account used to perform the transfer. If unspecified, the Managed Lustre service agent is used. Use one of the following formats: * * {EMAIL_ADDRESS_OR_UNIQUE_ID} * * projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID} * * projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}

getLustrePath

The root directory path to the Managed Lustre file system. Must start with /. Default is /.

Returns
Type Description
LustrePath|null

hasLustrePath

setLustrePath

The root directory path to the Managed Lustre file system. Must start with /. Default is /.

Parameter
Name Description
var LustrePath
Returns
Type Description
$this

getGcsPath

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 (/).

Returns
Type Description
GcsPath|null

hasGcsPath

setGcsPath

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 (/).

Parameter
Name Description
var GcsPath
Returns
Type Description
$this

getName

Required. The name of the Managed Lustre instance in the format projects/{project}/locations/{location}/instances/{instance}.

Returns
Type Description
string

setName

Required. The name of the Managed Lustre instance in the format projects/{project}/locations/{location}/instances/{instance}.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. UUID to identify requests.

Returns
Type Description
string

setRequestId

Optional. UUID to identify requests.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceAccount

Optional. User-specified service account used to perform the transfer.

If unspecified, the Managed Lustre service agent is used. Use one of the following formats:

  • {EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}
Returns
Type Description
string

setServiceAccount

Optional. User-specified service account used to perform the transfer.

If unspecified, the Managed Lustre service agent is used. Use one of the following formats:

  • {EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}
Parameter
Name Description
var string
Returns
Type Description
$this

getSource

Returns
Type Description
string

getDestination

Returns
Type Description
string