create(parent, body=None, volumeId=None, x__xgafv=None)

Creates a volume.

Args:
  parent: string, Required. The parent volume pool path, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Volume representation of a Cloud Filestore volume.
  "createTime": "A String", # Output only. The time when the volume was created.
  "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
  "labels": { # Optional. Resource labels to represent user provided metadata.
    "a_key": "A String",
  },
  "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
    "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
    "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
  },
  "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
}

  volumeId: string, Required. The ID to use for the volume. The ID must be unique within the specified volume pool.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Volume representation of a Cloud Filestore volume.
  "createTime": "A String", # Output only. The time when the volume was created.
  "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
  "labels": { # Optional. Resource labels to represent user provided metadata.
    "a_key": "A String",
  },
  "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
    "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
    "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
  },
  "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
}

delete(name, x__xgafv=None)

Deletes a volume.

Args:
  name: string, Required. The volume resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets the details of a specific volume.

Args:
  name: string, Required. The volume resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Volume representation of a Cloud Filestore volume.
  "createTime": "A String", # Output only. The time when the volume was created.
  "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
  "labels": { # Optional. Resource labels to represent user provided metadata.
    "a_key": "A String",
  },
  "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
    "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
    "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
  },
  "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists all volumes for a specified volume pool.

Args:
  parent: string, Required. The volume pool for which to retrieve volume information, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
  filter: string, Optional. List filter.
  orderBy: string, Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
  pageSize: integer, Optional. The maximum number of items to return.
  pageToken: string, Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ListVolumesResponse is the result of ListVolumesRequest.
  "nextPageToken": "A String", # Optional. The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
  "unreachable": [ # Unordered list. Locations that could not be reached.
    "A String",
  ],
  "volumes": [ # Unordered list. A list of volumes in the project for the specified volume pool.
    { # Volume representation of a Cloud Filestore volume.
      "createTime": "A String", # Output only. The time when the volume was created.
      "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
      "labels": { # Optional. Resource labels to represent user provided metadata.
        "a_key": "A String",
      },
      "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
        "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
        "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
      },
      "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
    },
  ],
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

Cloud Filestore API . projects . locations . volumePools . volumes

Instance Methods

Method Details