blob: 94146aa2c4c849da6a2fe3232077477f07bfea90 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="netapp_v1beta1.html">NetApp API</a> . <a href="netapp_v1beta1.projects.html">projects</a> . <a href="netapp_v1beta1.projects.locations.html">locations</a> . <a href="netapp_v1beta1.projects.locations.storagePools.html">storagePools</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, storagePoolId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new storage pool.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Warning! This operation will permanently delete the storage pool.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the description of the specified storage pool by poolId.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns descriptions of all storage pools owned by the caller.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the storage pool properties with the full spec</p>
<p class="toc_element">
<code><a href="#switch">switch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">This operation will switch the active/replica zone for a regional storagePool.</p>
<p class="toc_element">
<code><a href="#validateDirectoryService">validateDirectoryService(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, storagePoolId=None, x__xgafv=None)</code>
<pre>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.
&quot;activeDirectory&quot;: &quot;A String&quot;, # Optional. Specifies the Active Directory to be used for creating a SMB volume.
&quot;allowAutoTiering&quot;: 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&#x27;t be disabled once enabled.
&quot;capacityGib&quot;: &quot;A String&quot;, # Required. Capacity in GIB of the pool
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the storage pool
&quot;customPerformanceEnabled&quot;: True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the storage pool
&quot;encryptionType&quot;: &quot;A String&quot;, # Output only. Specifies the current pool encryption key source.
&quot;globalAccessAllowed&quot;: True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
&quot;kmsConfig&quot;: &quot;A String&quot;, # Optional. Specifies the KMS config to be used for volume encryption.
&quot;labels&quot;: { # Optional. Labels as key value pairs
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;ldapEnabled&quot;: True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the storage pool
&quot;network&quot;: &quot;A String&quot;, # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
&quot;psaRange&quot;: &quot;A String&quot;, # Optional. This field is not implemented. The values provided in this field are ignored.
&quot;replicaZone&quot;: &quot;A String&quot;, # Optional. Specifies the replica zone for regional storagePool.
&quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use
&quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use
&quot;serviceLevel&quot;: &quot;A String&quot;, # Required. Service level of the storage pool
&quot;state&quot;: &quot;A String&quot;, # Output only. State of the storage pool
&quot;stateDetails&quot;: &quot;A String&quot;, # Output only. State details of the storage pool
&quot;totalIops&quot;: &quot;A String&quot;, # Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the total_throughput_mibps
&quot;totalThroughputMibps&quot;: &quot;A String&quot;, # Optional. Custom Performance Total Throughput of the pool (in MiB/s)
&quot;volumeCapacityGib&quot;: &quot;A String&quot;, # Output only. Allocated size of all volumes in GIB in the storage pool
&quot;volumeCount&quot;: 42, # Output only. Volume count of the storage pool
&quot;zone&quot;: &quot;A String&quot;, # 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.
&quot;done&quot;: 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.
&quot;error&quot;: { # 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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # 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.
},
&quot;metadata&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;response&quot;: { # 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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>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.
&quot;done&quot;: 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.
&quot;error&quot;: { # 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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # 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.
},
&quot;metadata&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;response&quot;: { # 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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>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.
&quot;activeDirectory&quot;: &quot;A String&quot;, # Optional. Specifies the Active Directory to be used for creating a SMB volume.
&quot;allowAutoTiering&quot;: 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&#x27;t be disabled once enabled.
&quot;capacityGib&quot;: &quot;A String&quot;, # Required. Capacity in GIB of the pool
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the storage pool
&quot;customPerformanceEnabled&quot;: True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the storage pool
&quot;encryptionType&quot;: &quot;A String&quot;, # Output only. Specifies the current pool encryption key source.
&quot;globalAccessAllowed&quot;: True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
&quot;kmsConfig&quot;: &quot;A String&quot;, # Optional. Specifies the KMS config to be used for volume encryption.
&quot;labels&quot;: { # Optional. Labels as key value pairs
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;ldapEnabled&quot;: True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the storage pool
&quot;network&quot;: &quot;A String&quot;, # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
&quot;psaRange&quot;: &quot;A String&quot;, # Optional. This field is not implemented. The values provided in this field are ignored.
&quot;replicaZone&quot;: &quot;A String&quot;, # Optional. Specifies the replica zone for regional storagePool.
&quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use
&quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use
&quot;serviceLevel&quot;: &quot;A String&quot;, # Required. Service level of the storage pool
&quot;state&quot;: &quot;A String&quot;, # Output only. State of the storage pool
&quot;stateDetails&quot;: &quot;A String&quot;, # Output only. State details of the storage pool
&quot;totalIops&quot;: &quot;A String&quot;, # Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the total_throughput_mibps
&quot;totalThroughputMibps&quot;: &quot;A String&quot;, # Optional. Custom Performance Total Throughput of the pool (in MiB/s)
&quot;volumeCapacityGib&quot;: &quot;A String&quot;, # Output only. Allocated size of all volumes in GIB in the storage pool
&quot;volumeCount&quot;: 42, # Output only. Volume count of the storage pool
&quot;zone&quot;: &quot;A String&quot;, # Optional. Specifies the active zone for regional storagePool.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>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 &quot;name&quot;, &quot;name desc&quot; or &quot;&quot; (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.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
&quot;storagePools&quot;: [ # 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.
&quot;activeDirectory&quot;: &quot;A String&quot;, # Optional. Specifies the Active Directory to be used for creating a SMB volume.
&quot;allowAutoTiering&quot;: 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&#x27;t be disabled once enabled.
&quot;capacityGib&quot;: &quot;A String&quot;, # Required. Capacity in GIB of the pool
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the storage pool
&quot;customPerformanceEnabled&quot;: True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the storage pool
&quot;encryptionType&quot;: &quot;A String&quot;, # Output only. Specifies the current pool encryption key source.
&quot;globalAccessAllowed&quot;: True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
&quot;kmsConfig&quot;: &quot;A String&quot;, # Optional. Specifies the KMS config to be used for volume encryption.
&quot;labels&quot;: { # Optional. Labels as key value pairs
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;ldapEnabled&quot;: True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the storage pool
&quot;network&quot;: &quot;A String&quot;, # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
&quot;psaRange&quot;: &quot;A String&quot;, # Optional. This field is not implemented. The values provided in this field are ignored.
&quot;replicaZone&quot;: &quot;A String&quot;, # Optional. Specifies the replica zone for regional storagePool.
&quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use
&quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use
&quot;serviceLevel&quot;: &quot;A String&quot;, # Required. Service level of the storage pool
&quot;state&quot;: &quot;A String&quot;, # Output only. State of the storage pool
&quot;stateDetails&quot;: &quot;A String&quot;, # Output only. State details of the storage pool
&quot;totalIops&quot;: &quot;A String&quot;, # Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the total_throughput_mibps
&quot;totalThroughputMibps&quot;: &quot;A String&quot;, # Optional. Custom Performance Total Throughput of the pool (in MiB/s)
&quot;volumeCapacityGib&quot;: &quot;A String&quot;, # Output only. Allocated size of all volumes in GIB in the storage pool
&quot;volumeCount&quot;: 42, # Output only. Volume count of the storage pool
&quot;zone&quot;: &quot;A String&quot;, # Optional. Specifies the active zone for regional storagePool.
},
],
&quot;unreachable&quot;: [ # Locations that could not be reached.
&quot;A String&quot;,
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>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.
&quot;activeDirectory&quot;: &quot;A String&quot;, # Optional. Specifies the Active Directory to be used for creating a SMB volume.
&quot;allowAutoTiering&quot;: 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&#x27;t be disabled once enabled.
&quot;capacityGib&quot;: &quot;A String&quot;, # Required. Capacity in GIB of the pool
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the storage pool
&quot;customPerformanceEnabled&quot;: True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the storage pool
&quot;encryptionType&quot;: &quot;A String&quot;, # Output only. Specifies the current pool encryption key source.
&quot;globalAccessAllowed&quot;: True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
&quot;kmsConfig&quot;: &quot;A String&quot;, # Optional. Specifies the KMS config to be used for volume encryption.
&quot;labels&quot;: { # Optional. Labels as key value pairs
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;ldapEnabled&quot;: True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the storage pool
&quot;network&quot;: &quot;A String&quot;, # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
&quot;psaRange&quot;: &quot;A String&quot;, # Optional. This field is not implemented. The values provided in this field are ignored.
&quot;replicaZone&quot;: &quot;A String&quot;, # Optional. Specifies the replica zone for regional storagePool.
&quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use
&quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use
&quot;serviceLevel&quot;: &quot;A String&quot;, # Required. Service level of the storage pool
&quot;state&quot;: &quot;A String&quot;, # Output only. State of the storage pool
&quot;stateDetails&quot;: &quot;A String&quot;, # Output only. State details of the storage pool
&quot;totalIops&quot;: &quot;A String&quot;, # Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the total_throughput_mibps
&quot;totalThroughputMibps&quot;: &quot;A String&quot;, # Optional. Custom Performance Total Throughput of the pool (in MiB/s)
&quot;volumeCapacityGib&quot;: &quot;A String&quot;, # Output only. Allocated size of all volumes in GIB in the storage pool
&quot;volumeCount&quot;: 42, # Output only. Volume count of the storage pool
&quot;zone&quot;: &quot;A String&quot;, # 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.
&quot;done&quot;: 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.
&quot;error&quot;: { # 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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # 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.
},
&quot;metadata&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;response&quot;: { # 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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="switch">switch(name, body=None, x__xgafv=None)</code>
<pre>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.
&quot;done&quot;: 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.
&quot;error&quot;: { # 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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # 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.
},
&quot;metadata&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;response&quot;: { # 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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="validateDirectoryService">validateDirectoryService(name, body=None, x__xgafv=None)</code>
<pre>ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.
Args:
name: string, Required. Name of the storage pool (required)
body: object, The request body.
The object takes the form of:
{ # ValidateDirectoryServiceRequest validates the directory service policy attached to the storage pool.
&quot;directoryServiceType&quot;: &quot;A String&quot;, # Type of directory service policy attached to the storage pool.
}
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.
&quot;done&quot;: 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.
&quot;error&quot;: { # 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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # 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.
},
&quot;metadata&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;response&quot;: { # 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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>