close()

Close httplib2 connections.

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

Creates a new storage pool.

Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:

{ # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
"activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
"capacityGib": "A String", # Required. Capacity in GIB of the pool
"createTime": "A String", # Output only. Create time of the storage pool
"description": "A String", # Optional. Description of the storage pool
"encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
"globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
"kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
"name": "A String", # Identifier. Name of the storage pool
"network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
"psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
"replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
"serviceLevel": "A String", # Required. Service level of the storage pool
"state": "A String", # Output only. State of the storage pool
"stateDetails": "A String", # Output only. State details of the storage pool
"volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
"volumeCount": 42, # Output only. Volume count of the storage pool
"zone": "A String", # Optional. Specifies the active zone for regional storagePool.
}

storagePoolId: string, Required. Id of the requesting storage pool. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
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)

Warning! This operation will permanently delete the storage pool.

Args:
name: string, Required. Name of the storage 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)

Returns the description of the specified storage pool by poolId.

Args:
  name: string, Required. Name of the storage pool (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
  "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
  "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
  "capacityGib": "A String", # Required. Capacity in GIB of the pool
  "createTime": "A String", # Output only. Create time of the storage pool
  "description": "A String", # Optional. Description of the storage pool
  "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
  "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
  "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
  "labels": { # Optional. Labels as key value pairs
    "a_key": "A String",
  },
  "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
  "name": "A String", # Identifier. Name of the storage pool
  "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
  "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
  "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
  "serviceLevel": "A String", # Required. Service level of the storage pool
  "state": "A String", # Output only. State of the storage pool
  "stateDetails": "A String", # Output only. State details of the storage pool
  "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
  "volumeCount": 42, # Output only. Volume count of the storage pool
  "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
}

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

Returns descriptions of all storage pools owned by the caller.

Args:
  parent: string, Required. Parent value (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:

    { # ListStoragePoolsResponse is the response to a ListStoragePoolsRequest.
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "storagePools": [ # The list of StoragePools
    { # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
      "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
      "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
      "capacityGib": "A String", # Required. Capacity in GIB of the pool
      "createTime": "A String", # Output only. Create time of the storage pool
      "description": "A String", # Optional. Description of the storage pool
      "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
      "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
      "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
      "labels": { # Optional. Labels as key value pairs
        "a_key": "A String",
      },
      "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
      "name": "A String", # Identifier. Name of the storage pool
      "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
      "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
      "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
      "serviceLevel": "A String", # Required. Service level of the storage pool
      "state": "A String", # Output only. State of the storage pool
      "stateDetails": "A String", # Output only. State details of the storage pool
      "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
      "volumeCount": 42, # Output only. Volume count of the storage pool
      "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
    },
  ],
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}

list_next()

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 storage pool properties with the full spec

Args:
name: string, Identifier. Name of the storage pool (required)
body: object, The request body.
The object takes the form of:

{ # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
"activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
"capacityGib": "A String", # Required. Capacity in GIB of the pool
"createTime": "A String", # Output only. Create time of the storage pool
"description": "A String", # Optional. Description of the storage pool
"encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
"globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
"kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
"name": "A String", # Identifier. Name of the storage pool
"network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
"psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
"replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
"serviceLevel": "A String", # Required. Service level of the storage pool
"state": "A String", # Output only. State of the storage pool
"stateDetails": "A String", # Output only. State details of the storage pool
"volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
"volumeCount": 42, # Output only. Volume count of the storage pool
"zone": "A String", # Optional. Specifies the active zone for regional storagePool.
}

updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the StoragePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
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.
},
}

switch(name, body=None, x__xgafv=None)

This operation will switch the active/replica zone for a regional storagePool.

Args:
name: string, Required. Name of the storage pool (required)
body: object, The request body.
The object takes the form of:

{ # SwitchActiveReplicaZoneRequest switch the active/replica zone for a regional storagePool.
}

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.
},
}

NetApp API . projects . locations . storagePools

Instance Methods

Method Details