Close httplib2 connections.
create(parent, body=None, volumeId=None, x__xgafv=None)
Creates a volume.
createFromSource(parent, body=None, x__xgafv=None)
Creates a volume in a volume pool from an existing data source (such as a Filestore backup).
Deletes a volume.
directCreate(parent, body=None, volumeId=None, x__xgafv=None)
Creates a volume directly on the CLH, bypassing CCFE. This is a temporary PoC that will be used for testing and removed.
directDelete(name, body=None, x__xgafv=None)
Deletes a volume directly on the CLH, bypassing CCFE. This is a temporary PoC that will be used for testing and removed.
Gets the details of a specific volume.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all volumes for a specified volume pool.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the settings of a specific volume.
unfreeze(name, body=None, x__xgafv=None)
Unfreezes a volume.
close()
Close httplib2 connections.
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.
"ipAcls": [ # Optional. User-defined permissions protecting mount points.
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"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}`.
"quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
"state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only and initialized to `HOT`.
}
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.
"ipAcls": [ # Optional. User-defined permissions protecting mount points.
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"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}`.
"quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
"state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only and initialized to `HOT`.
}
createFromSource(parent, body=None, x__xgafv=None)
Creates a volume in a volume pool from an existing data source (such as a Filestore backup).
Args:
parent: string, Required. The parent resource where this volume will be created. Format: projects/{project}/locations/{location}/volumePools/{volume_pool} (required)
body: object, The request body.
The object takes the form of:
{ # Request for creating a volume from an existing data source (such as a backup).
"backup": "A String", # The resource name of the backup to create from. Format: projects/{project}/locations/{location}/backups/{backup}
"ipAcls": [ # Optional. IP ACLs defining permissions/ACLs to apply to the newly created volume.
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"quota": "A String", # Optional. The limit for how much data can be written to this volume, in MiB.
"requestId": "A String", # Optional. A unique ID used to identify the request, so retries are idempotent. Must be a valid UUID4; the zero UUID (`00000000-0000-0000-0000-000000000000`) is not supported.
"volumeId": "A String", # Required. Unique identifier for the volume which also appears in the volumes resource name.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
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); }
}
directCreate(parent, body=None, volumeId=None, x__xgafv=None)
Creates a volume directly on the CLH, bypassing CCFE. This is a temporary PoC that will be used for testing and removed.
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.
"ipAcls": [ # Optional. User-defined permissions protecting mount points.
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"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}`.
"quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
"state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only and initialized to `HOT`.
}
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.
"ipAcls": [ # Optional. User-defined permissions protecting mount points.
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"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}`.
"quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
"state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only and initialized to `HOT`.
}
directDelete(name, body=None, x__xgafv=None)
Deletes a volume directly on the CLH, bypassing CCFE. This is a temporary PoC that will be used for testing and removed.
Args:
name: string, Required. The volume resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`. (required)
body: object, The request body.
The object takes the form of:
{ # DeleteVolumeRequest deletes a volume.
}
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.
"ipAcls": [ # Optional. User-defined permissions protecting mount points.
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"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}`.
"quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
"state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only and initialized to `HOT`.
}
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.
"ipAcls": [ # Optional. User-defined permissions protecting mount points.
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"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}`.
"quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
"state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only and initialized to `HOT`.
},
],
}
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.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the settings of a specific volume.
Args:
name: string, Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`. (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.
"ipAcls": [ # Optional. User-defined permissions protecting mount points.
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"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}`.
"quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
"state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only and initialized to `HOT`.
}
updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
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.
"ipAcls": [ # Optional. User-defined permissions protecting mount points.
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"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}`.
"quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
"state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only and initialized to `HOT`.
}
unfreeze(name, body=None, x__xgafv=None)
Unfreezes a volume.
Args:
name: string, Required. The name of the volume to unfreeze. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request for unfreezing a volume.
"ipAcls": [ # Optional. IP ACLs defining permissions/ACLs to apply to the unfrozen volume
{ # NFS export options specifications.
"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
"A String",
],
"network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
"securityFlavors": [ # The security flavors allowed for mount operations. The default is AUTH_SYS.
"A String",
],
"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
},
],
"quota": "A String", # Optional. The limit for how much data can be written to this volume, in MiB.
"requestId": "A String", # Optional. A unique ID used to identify the request, so retries are idempotent. Must be a valid UUID4; the zero UUID (`00000000-0000-0000-0000-000000000000`) is not supported.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}