Returns the volumes Resource.
Close httplib2 connections.
create(parent, body=None, volumePoolId=None, x__xgafv=None)
Creates a volume pool.
Deletes a volume pool.
Gets the details of a specific volume pool.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all volume pools in a project for either a specified location or for all locations.
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 pool.
close()
Close httplib2 connections.
create(parent, body=None, volumePoolId=None, x__xgafv=None)
Creates a volume pool.
Args:
parent: string, Required. The project and location for which to create the volume pool, in the format `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:
{ # VolumePool representation of a Cloud Filestore volume pool.
"createTime": "A String", # Output only. The time when the volume pool was created.
"description": "A String", # Optional. A description of the volume pool with 2048 characters or less.
"instanceListPageSize": 42, # Optional. The page size to use when listing instances.
"instanceNamePrefix": "A String", # Optional. Instance name prefix.
"instanceTemplate": { # InstanceTemplate representation of a Cloud Filestore volume pool instance template. # Optional. Instance template details.
"backendType": "A String", # Optional. Backend type.
"capacityGb": 42, # Optional. Capacity in GB.
"labels": { # Optional. Instance labels.
"a_key": "A String",
},
"networks": [ # Optional. Network configurations.
{ # Network configuration for the instance.
"connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
"ipAddresses": [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
"A String",
],
"modes": [ # Internet protocol versions for which the instance has IP addresses assigned.
"A String",
],
"network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.
"pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT.
"endpointProject": "A String", # Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project.
"requestedIpAddress": "A String", # Optional. Immutable. Optional: The desired IP address for the instance. If not specified, an IP will be automatically allocated. The IP must be from the subnetwork range configured in the Service Connection Policy. This effective ip address is set in the ip_addresses field. use 3 instead of 2 to avoid conflict with the reserved_ip_range field.
},
"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
},
],
"performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Performance configuration.
"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
"maxIops": "A String", # Required. Maximum IOPS.
},
"iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
"maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB.
},
},
"protocol": "A String", # Optional. File protocol.
"requestOverrides": "A String", # Optional. Request overrides in JSON format.
"tier": "A String", # Optional. Tier of the instance.
},
"labels": { # Optional. Resource labels to represent user provided metadata.
"a_key": "A String",
},
"maxAcquireCandidates": 42, # Optional. The maximum number of candidates to fetch when acquiring a volume.
"maxInstances": 42, # Optional. Maximum number of instances to create.
"maxPendingInstanceCreations": 42, # Optional. The maximum number of pending instance creation requests.
"maxPendingVolumeCreationsPerInstance": 42, # Optional. The maximum number of pending volume creation requests per instance.
"maxPendingVolumeDeletionsPerInstance": 42, # Optional. The maximum number of pending volume deletion requests per instance.
"maxVolumesPerInstance": 42, # Optional. Maximum number of volumes per instance.
"minAvailableVolumes": 42, # Optional. Minimum number of available volumes to maintain.
"minInstances": 42, # Optional. Minimum number of instances to create.
"name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
"negbaInstanceRatio": 3.14, # Optional. The ratio of Negba instances to maintain in the volume pool, between 0 and 1.
"operationPollLimit": 42, # Optional. The maximum number of operations to poll in a single reconciliation run.
"state": "A String", # Output only. The volume pool state.
"uniqueId": "A String", # Output only. Unique ID of the resource, as defined by CCFE.
"volumeBatchSize": 42, # Optional. The number of volumes to create in a single batch.
"volumeSizeMb": 42, # Optional. Volume size in MiB.
}
volumePoolId: string, Required. The ID to use for the volume pool, which will become the final component of the volume pool's 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 pool.
Args:
name: string, Required. The volume pool resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
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.
},
}
get(name, x__xgafv=None)
Gets the details of a specific volume pool.
Args:
name: string, Required. The volume pool resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # VolumePool representation of a Cloud Filestore volume pool.
"createTime": "A String", # Output only. The time when the volume pool was created.
"description": "A String", # Optional. A description of the volume pool with 2048 characters or less.
"instanceListPageSize": 42, # Optional. The page size to use when listing instances.
"instanceNamePrefix": "A String", # Optional. Instance name prefix.
"instanceTemplate": { # InstanceTemplate representation of a Cloud Filestore volume pool instance template. # Optional. Instance template details.
"backendType": "A String", # Optional. Backend type.
"capacityGb": 42, # Optional. Capacity in GB.
"labels": { # Optional. Instance labels.
"a_key": "A String",
},
"networks": [ # Optional. Network configurations.
{ # Network configuration for the instance.
"connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
"ipAddresses": [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
"A String",
],
"modes": [ # Internet protocol versions for which the instance has IP addresses assigned.
"A String",
],
"network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.
"pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT.
"endpointProject": "A String", # Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project.
"requestedIpAddress": "A String", # Optional. Immutable. Optional: The desired IP address for the instance. If not specified, an IP will be automatically allocated. The IP must be from the subnetwork range configured in the Service Connection Policy. This effective ip address is set in the ip_addresses field. use 3 instead of 2 to avoid conflict with the reserved_ip_range field.
},
"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
},
],
"performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Performance configuration.
"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
"maxIops": "A String", # Required. Maximum IOPS.
},
"iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
"maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB.
},
},
"protocol": "A String", # Optional. File protocol.
"requestOverrides": "A String", # Optional. Request overrides in JSON format.
"tier": "A String", # Optional. Tier of the instance.
},
"labels": { # Optional. Resource labels to represent user provided metadata.
"a_key": "A String",
},
"maxAcquireCandidates": 42, # Optional. The maximum number of candidates to fetch when acquiring a volume.
"maxInstances": 42, # Optional. Maximum number of instances to create.
"maxPendingInstanceCreations": 42, # Optional. The maximum number of pending instance creation requests.
"maxPendingVolumeCreationsPerInstance": 42, # Optional. The maximum number of pending volume creation requests per instance.
"maxPendingVolumeDeletionsPerInstance": 42, # Optional. The maximum number of pending volume deletion requests per instance.
"maxVolumesPerInstance": 42, # Optional. Maximum number of volumes per instance.
"minAvailableVolumes": 42, # Optional. Minimum number of available volumes to maintain.
"minInstances": 42, # Optional. Minimum number of instances to create.
"name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
"negbaInstanceRatio": 3.14, # Optional. The ratio of Negba instances to maintain in the volume pool, between 0 and 1.
"operationPollLimit": 42, # Optional. The maximum number of operations to poll in a single reconciliation run.
"state": "A String", # Output only. The volume pool state.
"uniqueId": "A String", # Output only. Unique ID of the resource, as defined by CCFE.
"volumeBatchSize": 42, # Optional. The number of volumes to create in a single batch.
"volumeSizeMb": 42, # Optional. Volume size in MiB.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all volume pools in a project for either a specified location or for all locations.
Args:
parent: string, Required. The project and location for which to retrieve volume pool information, in the format `projects/{project}/locations/{location}`. To retrieve volume pool information for all locations, use "-" as the value of `{location}`. (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:
{ # ListVolumePoolsResponse is the result of ListVolumePoolsRequest.
"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",
],
"volumePools": [ # Unordered list. A list of volume pools in the project for the specified location.
{ # VolumePool representation of a Cloud Filestore volume pool.
"createTime": "A String", # Output only. The time when the volume pool was created.
"description": "A String", # Optional. A description of the volume pool with 2048 characters or less.
"instanceListPageSize": 42, # Optional. The page size to use when listing instances.
"instanceNamePrefix": "A String", # Optional. Instance name prefix.
"instanceTemplate": { # InstanceTemplate representation of a Cloud Filestore volume pool instance template. # Optional. Instance template details.
"backendType": "A String", # Optional. Backend type.
"capacityGb": 42, # Optional. Capacity in GB.
"labels": { # Optional. Instance labels.
"a_key": "A String",
},
"networks": [ # Optional. Network configurations.
{ # Network configuration for the instance.
"connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
"ipAddresses": [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
"A String",
],
"modes": [ # Internet protocol versions for which the instance has IP addresses assigned.
"A String",
],
"network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.
"pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT.
"endpointProject": "A String", # Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project.
"requestedIpAddress": "A String", # Optional. Immutable. Optional: The desired IP address for the instance. If not specified, an IP will be automatically allocated. The IP must be from the subnetwork range configured in the Service Connection Policy. This effective ip address is set in the ip_addresses field. use 3 instead of 2 to avoid conflict with the reserved_ip_range field.
},
"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
},
],
"performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Performance configuration.
"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
"maxIops": "A String", # Required. Maximum IOPS.
},
"iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
"maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB.
},
},
"protocol": "A String", # Optional. File protocol.
"requestOverrides": "A String", # Optional. Request overrides in JSON format.
"tier": "A String", # Optional. Tier of the instance.
},
"labels": { # Optional. Resource labels to represent user provided metadata.
"a_key": "A String",
},
"maxAcquireCandidates": 42, # Optional. The maximum number of candidates to fetch when acquiring a volume.
"maxInstances": 42, # Optional. Maximum number of instances to create.
"maxPendingInstanceCreations": 42, # Optional. The maximum number of pending instance creation requests.
"maxPendingVolumeCreationsPerInstance": 42, # Optional. The maximum number of pending volume creation requests per instance.
"maxPendingVolumeDeletionsPerInstance": 42, # Optional. The maximum number of pending volume deletion requests per instance.
"maxVolumesPerInstance": 42, # Optional. Maximum number of volumes per instance.
"minAvailableVolumes": 42, # Optional. Minimum number of available volumes to maintain.
"minInstances": 42, # Optional. Minimum number of instances to create.
"name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
"negbaInstanceRatio": 3.14, # Optional. The ratio of Negba instances to maintain in the volume pool, between 0 and 1.
"operationPollLimit": 42, # Optional. The maximum number of operations to poll in a single reconciliation run.
"state": "A String", # Output only. The volume pool state.
"uniqueId": "A String", # Output only. Unique ID of the resource, as defined by CCFE.
"volumeBatchSize": 42, # Optional. The number of volumes to create in a single batch.
"volumeSizeMb": 42, # Optional. Volume size in MiB.
},
],
}
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 pool.
Args:
name: string, Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
body: object, The request body.
The object takes the form of:
{ # VolumePool representation of a Cloud Filestore volume pool.
"createTime": "A String", # Output only. The time when the volume pool was created.
"description": "A String", # Optional. A description of the volume pool with 2048 characters or less.
"instanceListPageSize": 42, # Optional. The page size to use when listing instances.
"instanceNamePrefix": "A String", # Optional. Instance name prefix.
"instanceTemplate": { # InstanceTemplate representation of a Cloud Filestore volume pool instance template. # Optional. Instance template details.
"backendType": "A String", # Optional. Backend type.
"capacityGb": 42, # Optional. Capacity in GB.
"labels": { # Optional. Instance labels.
"a_key": "A String",
},
"networks": [ # Optional. Network configurations.
{ # Network configuration for the instance.
"connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
"ipAddresses": [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
"A String",
],
"modes": [ # Internet protocol versions for which the instance has IP addresses assigned.
"A String",
],
"network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.
"pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT.
"endpointProject": "A String", # Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project.
"requestedIpAddress": "A String", # Optional. Immutable. Optional: The desired IP address for the instance. If not specified, an IP will be automatically allocated. The IP must be from the subnetwork range configured in the Service Connection Policy. This effective ip address is set in the ip_addresses field. use 3 instead of 2 to avoid conflict with the reserved_ip_range field.
},
"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
},
],
"performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Performance configuration.
"fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
"maxIops": "A String", # Required. Maximum IOPS.
},
"iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
"maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB.
},
},
"protocol": "A String", # Optional. File protocol.
"requestOverrides": "A String", # Optional. Request overrides in JSON format.
"tier": "A String", # Optional. Tier of the instance.
},
"labels": { # Optional. Resource labels to represent user provided metadata.
"a_key": "A String",
},
"maxAcquireCandidates": 42, # Optional. The maximum number of candidates to fetch when acquiring a volume.
"maxInstances": 42, # Optional. Maximum number of instances to create.
"maxPendingInstanceCreations": 42, # Optional. The maximum number of pending instance creation requests.
"maxPendingVolumeCreationsPerInstance": 42, # Optional. The maximum number of pending volume creation requests per instance.
"maxPendingVolumeDeletionsPerInstance": 42, # Optional. The maximum number of pending volume deletion requests per instance.
"maxVolumesPerInstance": 42, # Optional. Maximum number of volumes per instance.
"minAvailableVolumes": 42, # Optional. Minimum number of available volumes to maintain.
"minInstances": 42, # Optional. Minimum number of instances to create.
"name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
"negbaInstanceRatio": 3.14, # Optional. The ratio of Negba instances to maintain in the volume pool, between 0 and 1.
"operationPollLimit": 42, # Optional. The maximum number of operations to poll in a single reconciliation run.
"state": "A String", # Output only. The volume pool state.
"uniqueId": "A String", # Output only. Unique ID of the resource, as defined by CCFE.
"volumeBatchSize": 42, # Optional. The number of volumes to create in a single batch.
"volumeSizeMb": 42, # Optional. Volume size in MiB.
}
updateMask: string, Optional. 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:
{ # 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.
},
}