{ "name": "netapp", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "path": "v1beta1/{+name}/locations", "flatPath": "v1beta1/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "netapp.projects.locations.list", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "httpMethod": "GET", "parameters": { "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string", "location": "query" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string", "location": "query" }, "pageSize": { "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32" }, "extraLocationTypes": { "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string", "repeated": true }, "name": { "description": "The resource that owns the locations collection, if applicable.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+$" } } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Resource name for the location.", "required": true } }, "httpMethod": "GET", "id": "netapp.projects.locations.get", "description": "Gets information about a location." } }, "resources": { "storagePools": { "resources": { "ontap": { "methods": { "executeOntapGet": { "parameterOrder": [ "ontapPath" ], "response": { "$ref": "ExecuteOntapGetResponse" }, "path": "v1beta1/{+ontapPath}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "netapp.projects.locations.storagePools.ontap.executeOntapGet", "description": "`ExecuteOntapGet` sends the ONTAP `GET` request to the `StoragePool` cluster.", "httpMethod": "GET", "parameters": { "ontapPath": { "description": "Required. The resource path of the ONTAP resource. Format: `projects/{project_number}/locations/{location_id}/storagePools/{storage_pool_id}/ontap/{ontap_resource_path}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "type": "string" } } }, "executeOntapPatch": { "path": "v1beta1/{+ontapPath}", "parameterOrder": [ "ontapPath" ], "response": { "$ref": "ExecuteOntapPatchResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ExecuteOntapPatchRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "httpMethod": "PATCH", "description": "`ExecuteOntapPatch` sends the ONTAP `PATCH` request to the `StoragePool` cluster.", "id": "netapp.projects.locations.storagePools.ontap.executeOntapPatch", "parameters": { "ontapPath": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "type": "string", "description": "Required. The resource path of the ONTAP resource. Format: `projects/{project_number}/locations/{location_id}/storagePools/{storage_pool_id}/ontap/{ontap_resource_path}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`.", "required": true } } }, "executeOntapPost": { "id": "netapp.projects.locations.storagePools.ontap.executeOntapPost", "description": "`ExecuteOntapPost` sends the ONTAP `POST` request to the `StoragePool` cluster.", "httpMethod": "POST", "parameters": { "ontapPath": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "description": "Required. The path of the ONTAP resource. Format: `projects/{project_number}/locations/{location_id}/storagePools/{storage_pool_id}/ontap/{ontap_resource_path}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`.", "required": true } }, "parameterOrder": [ "ontapPath" ], "response": { "$ref": "ExecuteOntapPostResponse" }, "path": "v1beta1/{+ontapPath}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "request": { "$ref": "ExecuteOntapPostRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "executeOntapDelete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "path": "v1beta1/{+ontapPath}", "parameterOrder": [ "ontapPath" ], "response": { "$ref": "ExecuteOntapDeleteResponse" }, "parameters": { "ontapPath": { "description": "Required. The resource path of the ONTAP resource. Format: `projects/{project_number}/locations/{location_id}/storagePools/{storage_pool_id}/ontap/{ontap_resource_path}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "type": "string" } }, "httpMethod": "DELETE", "id": "netapp.projects.locations.storagePools.ontap.executeOntapDelete", "description": "`ExecuteOntapDelete` sends the ONTAP `DELETE` request to the `StoragePool` cluster." } } }, "backupConfigs": { "methods": { "list": { "parameters": { "filter": { "description": "Optional. The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. Sort results. Supported values are \"volume_id\" or \"\"", "type": "string" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "type": "string", "description": "Required. The ONTAP StoragePool for which to retrieve backup configuration information, in the format `projects/{project}/locations/{location}/storagePools/{storage_pool}`.", "required": true }, "pageSize": { "format": "int32", "description": "Optional. The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified or set to 0, a default of 50 will be used.", "type": "integer", "location": "query" } }, "description": "Lists backup configurations for all volumes in an ONTAP-mode Storage Pool.", "id": "netapp.projects.locations.storagePools.backupConfigs.list", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/backupConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListBackupConfigsResponse" }, "path": "v1beta1/{+parent}/backupConfigs" } } } }, "methods": { "create": { "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. Value for parent.", "required": true }, "storagePoolId": { "location": "query", "description": "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.", "type": "string" } }, "id": "netapp.projects.locations.storagePools.create", "description": "Creates a new storage pool.", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools", "request": { "$ref": "StoragePool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+parent}/storagePools" }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "type": "string", "location": "path", "description": "Required. Name of the storage pool", "required": true } }, "description": "Returns the description of the specified storage pool by poolId.", "id": "netapp.projects.locations.storagePools.get", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "StoragePool" }, "path": "v1beta1/{+name}" }, "switch": { "parameters": { "name": { "description": "Required. Name of the storage pool", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "location": "path" } }, "description": "This operation will switch the active/replica zone for a regional storagePool.", "id": "netapp.projects.locations.storagePools.switch", "httpMethod": "POST", "request": { "$ref": "SwitchActiveReplicaZoneRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:switch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}:switch" }, "restoreVolume": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:restoreVolume", "request": { "$ref": "RestoreVolumeRequest" }, "path": "v1beta1/{+name}:restoreVolume", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "Required. The resource name of the ONTAP mode storage pool, in the format of `projects/{project}/locations/{location}/storagePools/{storage_pool}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$" } }, "httpMethod": "POST", "id": "netapp.projects.locations.storagePools.restoreVolume", "description": "Restores a backup to an ONTAP-mode volume." }, "delete": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", "httpMethod": "DELETE", "id": "netapp.projects.locations.storagePools.delete", "description": "Warning! This operation will permanently delete the storage pool.", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "description": "Required. Name of the storage pool", "required": true } } }, "validateDirectoryService": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}:validateDirectoryService", "request": { "$ref": "ValidateDirectoryServiceRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:validateDirectoryService", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.", "id": "netapp.projects.locations.storagePools.validateDirectoryService", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the storage pool", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "type": "string" } } }, "updateBackupConfig": { "id": "netapp.projects.locations.storagePools.updateBackupConfig", "description": "Updates the backup configuration for an ONTAP-mode volume.", "httpMethod": "POST", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "location": "path", "description": "Required. The resource name of the StoragePool, in the format: projects/{projectNumber}/locations/{locationId}/storagePools/{poolId}", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}:updateBackupConfig", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:updateBackupConfig", "request": { "$ref": "UpdateBackupConfigRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1beta1/{+parent}/storagePools", "parameterOrder": [ "parent" ], "response": { "$ref": "ListStoragePoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools", "httpMethod": "GET", "id": "netapp.projects.locations.storagePools.list", "description": "Returns descriptions of all storage pools owned by the caller.", "parameters": { "pageToken": { "location": "query", "description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", "type": "string" }, "filter": { "description": "Optional. List filter.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "description": "Optional. The maximum number of items to return.", "type": "integer", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. Parent value", "required": true } } }, "patch": { "request": { "$ref": "StoragePool" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "parameters": { "name": { "description": "Identifier. Name of the storage pool", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$" }, "updateMask": { "location": "query", "description": "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.", "type": "string", "format": "google-fieldmask" } }, "description": "Updates the storage pool properties with the full spec", "id": "netapp.projects.locations.storagePools.patch", "httpMethod": "PATCH" } } }, "backupVaults": { "resources": { "backups": { "methods": { "list": { "httpMethod": "GET", "description": "Returns descriptions of all backups for a backupVault.", "id": "netapp.projects.locations.backupVaults.backups.list", "parameters": { "pageToken": { "location": "query", "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", "type": "string" }, "orderBy": { "location": "query", "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", "type": "string" }, "filter": { "location": "query", "description": "The standard list filter. If specified, backups will be returned based on the attribute name that matches the filter expression. If empty, then no backups are filtered out. See https://google.aip.dev/160", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer" }, "parent": { "description": "Required. The backupVault for which to retrieve backup information, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. To retrieve backup information for all locations, use \"-\" for the `{location}` value. To retrieve backup information for all backupVaults, use \"-\" for the `{backup_vault_id}` value. To retrieve backup information for a volume, use \"-\" for the `{backup_vault_id}` value and specify volume full name with the filter.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "type": "string" } }, "path": "v1beta1/{+parent}/backups", "parameterOrder": [ "parent" ], "response": { "$ref": "ListBackupsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups" }, "patch": { "request": { "$ref": "Backup" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "parameters": { "name": { "description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. 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.", "type": "string" } }, "description": "Update backup with full spec.", "id": "netapp.projects.locations.backupVaults.backups.patch", "httpMethod": "PATCH" }, "delete": { "parameters": { "name": { "description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", "type": "string", "location": "path" } }, "httpMethod": "DELETE", "id": "netapp.projects.locations.backupVaults.backups.delete", "description": "Warning! This operation will permanently delete the backup.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } }, "get": { "httpMethod": "GET", "description": "Returns the description of the specified backup", "id": "netapp.projects.locations.backupVaults.backups.get", "parameters": { "name": { "description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$" } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Backup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}" }, "create": { "httpMethod": "POST", "description": "Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request. If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.", "id": "netapp.projects.locations.backupVaults.backups.create", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "type": "string", "description": "Required. The NetApp backupVault to create the backups of, in the format `projects/*/locations/*/backupVaults/{backup_vault_id}`", "required": true }, "backupId": { "location": "query", "description": "Required. The ID to use for the backup. The ID must be unique within the specified backupVault. 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.", "type": "string" } }, "path": "v1beta1/{+parent}/backups", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Backup" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups" } } } }, "methods": { "create": { "request": { "$ref": "BackupVault" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+parent}/backupVaults", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The location to create the backup vaults, in the format `projects/{project_id}/locations/{location}`", "required": true }, "backupVaultId": { "description": "Required. The ID to use for the backupVault. The ID must be unique within the specified location. 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.", "type": "string", "location": "query" } }, "description": "Creates new backup vault", "id": "netapp.projects.locations.backupVaults.create", "httpMethod": "POST" }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "BackupVault" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns the description of the specified backup vault", "id": "netapp.projects.locations.backupVaults.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "description": "Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", "required": true } } }, "delete": { "id": "netapp.projects.locations.backupVaults.delete", "description": "Warning! This operation will permanently delete the backup vault.", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "filter": { "location": "query", "description": "List filter.", "type": "string" }, "pageToken": { "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", "type": "string", "location": "query" }, "orderBy": { "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", "type": "string", "location": "query" }, "parent": { "description": "Required. The location for which to retrieve backupVault information, in the format `projects/{project_id}/locations/{location}`.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "format": "int32", "description": "The maximum number of items to return.", "type": "integer", "location": "query" } }, "description": "Returns list of all available backup vaults.", "id": "netapp.projects.locations.backupVaults.list", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults", "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListBackupVaultsResponse" }, "path": "v1beta1/{+parent}/backupVaults" }, "patch": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", "request": { "$ref": "BackupVault" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "type": "string", "location": "path", "description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", "required": true }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. 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.", "type": "string" } }, "id": "netapp.projects.locations.backupVaults.patch", "description": "Updates the settings of a specific backup vault.", "httpMethod": "PATCH" } } }, "activeDirectories": { "methods": { "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. Value for parent.", "required": true }, "activeDirectoryId": { "description": "Required. ID of the active directory to create. 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.", "type": "string", "location": "query" } }, "description": "CreateActiveDirectory Creates the active directory specified in the request.", "id": "netapp.projects.locations.activeDirectories.create", "httpMethod": "POST", "request": { "$ref": "ActiveDirectory" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+parent}/activeDirectories" }, "get": { "httpMethod": "GET", "description": "Describes a specified active directory.", "id": "netapp.projects.locations.activeDirectories.get", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", "description": "Required. Name of the active directory.", "required": true } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "ActiveDirectory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}" }, "delete": { "parameters": { "name": { "description": "Required. Name of the active directory.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", "type": "string", "location": "path" } }, "id": "netapp.projects.locations.activeDirectories.delete", "description": "Delete the active directory specified in the request.", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}" }, "list": { "httpMethod": "GET", "description": "Lists active directories.", "id": "netapp.projects.locations.activeDirectories.list", "parameters": { "pageToken": { "location": "query", "description": "A token identifying a page of results the server should return.", "type": "string" }, "orderBy": { "description": "Hint for how to order the results", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "Filtering results", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", "type": "integer" }, "parent": { "description": "Required. Parent value for ListActiveDirectoriesRequest", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1beta1/{+parent}/activeDirectories", "parameterOrder": [ "parent" ], "response": { "$ref": "ListActiveDirectoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories" }, "patch": { "description": "Update the parameters of an active directories.", "id": "netapp.projects.locations.activeDirectories.patch", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$" }, "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten in the Active Directory 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.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "request": { "$ref": "ActiveDirectory" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "backupPolicies": { "methods": { "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "ListBackupPoliciesResponse" }, "path": "v1beta1/{+parent}/backupPolicies", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies", "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "id": "netapp.projects.locations.backupPolicies.list", "description": "Returns list of all available backup policies.", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent value for ListBackupPoliciesRequest", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageSize": { "format": "int32", "description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" }, "filter": { "description": "Filtering results", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "A token identifying a page of results the server should return.", "type": "string" }, "orderBy": { "description": "Hint for how to order the results", "type": "string", "location": "query" } } }, "patch": { "request": { "$ref": "BackupPolicy" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "parameters": { "name": { "description": "Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", "type": "string" }, "updateMask": { "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten in the Backup Policy 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.", "type": "string", "location": "query" } }, "description": "Updates settings of a specific backup policy.", "id": "netapp.projects.locations.backupPolicies.patch", "httpMethod": "PATCH" }, "delete": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", "httpMethod": "DELETE", "description": "Warning! This operation will permanently delete the backup policy.", "id": "netapp.projects.locations.backupPolicies.delete", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", "type": "string", "description": "Required. The backup policy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`", "required": true } } }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "BackupPolicy" }, "path": "v1beta1/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", "type": "string", "description": "Required. The backupPolicy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`", "required": true } }, "id": "netapp.projects.locations.backupPolicies.get", "description": "Returns the description of the specified backup policy by backup_policy_id.", "httpMethod": "GET" }, "create": { "httpMethod": "POST", "description": "Creates new backup policy", "id": "netapp.projects.locations.backupPolicies.create", "parameters": { "backupPolicyId": { "description": "Required. The ID to use for the backup policy. The ID must be unique within the specified location. 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.", "type": "string", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The location to create the backup policies of, in the format `projects/{project_id}/locations/{location}`", "required": true } }, "path": "v1beta1/{+parent}/backupPolicies", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "BackupPolicy" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies" } } }, "hostGroups": { "methods": { "delete": { "id": "netapp.projects.locations.hostGroups.delete", "description": "Deletes a host group.", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/hostGroups/[^/]+$", "type": "string", "description": "Required. The resource name of the host group. Format: `projects/{project_number}/locations/{location_id}/hostGroups/{host_group_id}`.", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hostGroups/{hostGroupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "description": "Returns a list of host groups in a `location`. Use `-` as location to list host groups across all locations.", "id": "netapp.projects.locations.hostGroups.list", "parameters": { "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results", "type": "string" }, "filter": { "location": "query", "description": "Optional. Filter to apply to the request.", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Parent value for ListHostGroupsRequest", "required": true } }, "path": "v1beta1/{+parent}/hostGroups", "parameterOrder": [ "parent" ], "response": { "$ref": "ListHostGroupsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hostGroups" }, "patch": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "request": { "$ref": "HostGroup" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hostGroups/{hostGroupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an existing host group.", "id": "netapp.projects.locations.hostGroups.patch", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The resource name of the host group. Format: `projects/{project_number}/locations/{location_id}/hostGroups/{host_group_id}`.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/hostGroups/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to update.", "type": "string" } } }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "HostGroup" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hostGroups", "path": "v1beta1/{+parent}/hostGroups", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "parameters": { "hostGroupId": { "location": "query", "description": "Required. ID of the host group to create. Must be unique within the parent resource. Must contain only letters, numbers, and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.", "type": "string" }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Parent value for CreateHostGroupRequest", "required": true } }, "httpMethod": "POST", "description": "Creates a new host group.", "id": "netapp.projects.locations.hostGroups.create" }, "get": { "parameters": { "name": { "description": "Required. The resource name of the host group. Format: `projects/{project_number}/locations/{location_id}/hostGroups/{host_group_id}`.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/hostGroups/[^/]+$" } }, "httpMethod": "GET", "description": "Returns details of the specified host group.", "id": "netapp.projects.locations.hostGroups.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hostGroups/{hostGroupsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "HostGroup" } } } }, "operations": { "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "netapp.projects.locations.operations.delete", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "location": "path" } }, "httpMethod": "POST", "id": "netapp.projects.locations.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "request": { "$ref": "CancelOperationRequest" }, "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "name": { "description": "The name of the operation's parent resource.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" } }, "id": "netapp.projects.locations.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "path": "v1beta1/{+name}/operations" }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "netapp.projects.locations.operations.get", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "volumes": { "methods": { "create": { "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+parent}/volumes", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes", "request": { "$ref": "Volume" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "netapp.projects.locations.volumes.create", "description": "Creates a new Volume in a given project and location.", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. Value for parent.", "required": true }, "volumeId": { "location": "query", "description": "Required. Id of the requesting volume. 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.", "type": "string" } } }, "revert": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}:revert", "request": { "$ref": "RevertVolumeRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:revert", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.", "id": "netapp.projects.locations.volumes.revert", "httpMethod": "POST", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "description": "Required. The resource name of the volume, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}.", "required": true } } }, "restore": { "httpMethod": "POST", "description": "Restore files from a backup to a volume.", "id": "netapp.projects.locations.volumes.restore", "parameters": { "name": { "description": "Required. The volume resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "type": "string", "location": "path" } }, "path": "v1beta1/{+name}:restore", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RestoreBackupFilesRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:restore" }, "get": { "httpMethod": "GET", "description": "Gets details of a single Volume.", "id": "netapp.projects.locations.volumes.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "type": "string", "location": "path", "description": "Required. Name of the volume", "required": true } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Volume" }, "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}" }, "delete": { "parameters": { "name": { "description": "Required. Name of the volume", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "type": "string", "location": "path" }, "force": { "location": "query", "description": "If this field is set as true, CCFE will not block the volume resource deletion even if it has any snapshots resource. (Otherwise, the request will only work if the volume has no snapshots.)", "type": "boolean" } }, "id": "netapp.projects.locations.volumes.delete", "description": "Deletes a single Volume.", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}" }, "list": { "httpMethod": "GET", "description": "Lists Volumes in a given project.", "id": "netapp.projects.locations.volumes.list", "parameters": { "pageToken": { "description": "A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Hint for how to order the results", "type": "string" }, "filter": { "location": "query", "description": "Filtering results", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", "type": "integer" }, "parent": { "description": "Required. Parent value for ListVolumesRequest", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "path": "v1beta1/{+parent}/volumes", "parameterOrder": [ "parent" ], "response": { "$ref": "ListVolumesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes" }, "patch": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", "request": { "$ref": "Volume" }, "httpMethod": "PATCH", "id": "netapp.projects.locations.volumes.patch", "description": "Updates the parameters of a single Volume.", "parameters": { "name": { "description": "Identifier. Name of the volume", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "type": "string", "location": "path" }, "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten in the Volume 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.", "type": "string", "format": "google-fieldmask", "location": "query" } } }, "establishPeering": { "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "description": "Required. The volume resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "required": true } }, "description": "Establish volume peering. This is used to establish cluster and svm peerings between the GCNV and OnPrem clusters.", "id": "netapp.projects.locations.volumes.establishPeering", "httpMethod": "POST", "request": { "$ref": "EstablishVolumePeeringRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:establishPeering", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}:establishPeering" } }, "resources": { "snapshots": { "methods": { "list": { "parameters": { "filter": { "description": "List filter.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", "type": "string" }, "orderBy": { "location": "query", "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "type": "string", "location": "path", "description": "Required. The volume for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`.", "required": true }, "pageSize": { "location": "query", "description": "The maximum number of items to return.", "type": "integer", "format": "int32" } }, "id": "netapp.projects.locations.volumes.snapshots.list", "description": "Returns descriptions of all snapshots for a volume.", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListSnapshotsResponse" }, "path": "v1beta1/{+parent}/snapshots" }, "patch": { "httpMethod": "PATCH", "description": "Updates the settings of a specific snapshot.", "id": "netapp.projects.locations.volumes.snapshots.patch", "parameters": { "name": { "description": "Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", "location": "path" }, "updateMask": { "description": "Required. Mask of fields to update. At least one path must be supplied in this field.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Snapshot" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", "type": "string", "location": "path", "description": "Required. The snapshot resource name, in the format `projects/*/locations/*/volumes/*/snapshots/{snapshot_id}`", "required": true } }, "httpMethod": "DELETE", "description": "Deletes a snapshot.", "id": "netapp.projects.locations.volumes.snapshots.delete" }, "get": { "description": "Describe a snapshot for a volume.", "id": "netapp.projects.locations.volumes.snapshots.get", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", "location": "path", "description": "Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Snapshot" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "httpMethod": "POST", "id": "netapp.projects.locations.volumes.snapshots.create", "description": "Create a new snapshot for a volume.", "parameters": { "snapshotId": { "description": "Required. ID of the snapshot to create. 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.", "type": "string", "location": "query" }, "parent": { "description": "Required. The NetApp volume to create the snapshots of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "type": "string", "location": "path" } }, "path": "v1beta1/{+parent}/snapshots", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", "request": { "$ref": "Snapshot" } } } }, "replications": { "methods": { "establishPeering": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}:establishPeering", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:establishPeering", "request": { "$ref": "EstablishPeeringRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "netapp.projects.locations.volumes.replications.establishPeering", "description": "Establish replication peering.", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "location": "path" } } }, "create": { "parameters": { "parent": { "description": "Required. The NetApp volume to create the replications of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "location": "path" }, "replicationId": { "location": "query", "description": "Required. ID of the replication to create. 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.", "type": "string" } }, "id": "netapp.projects.locations.volumes.replications.create", "description": "Create a new replication for a volume.", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications", "request": { "$ref": "Replication" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+parent}/replications" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Replication" }, "parameters": { "name": { "description": "Required. The replication resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$" } }, "httpMethod": "GET", "description": "Describe a replication for a volume.", "id": "netapp.projects.locations.volumes.replications.get" }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "netapp.projects.locations.volumes.replications.delete", "description": "Deletes a replication.", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The replication resource name, in the format `projects/*/locations/*/volumes/*/replications/{replication_id}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$" } } }, "stop": { "parameters": { "name": { "description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$" } }, "id": "netapp.projects.locations.volumes.replications.stop", "description": "Stop Cross Region Replication.", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:stop", "request": { "$ref": "StopReplicationRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}:stop" }, "resume": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ResumeReplicationRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:resume", "path": "v1beta1/{+name}:resume", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "type": "string" } }, "httpMethod": "POST", "description": "Resume Cross Region Replication.", "id": "netapp.projects.locations.volumes.replications.resume" }, "list": { "parameters": { "pageToken": { "location": "query", "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", "type": "string" }, "orderBy": { "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "List filter.", "type": "string" }, "pageSize": { "description": "The maximum number of items to return.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "description": "Required. The volume for which to retrieve replication information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "type": "string" } }, "httpMethod": "GET", "description": "Returns descriptions of all replications for a volume.", "id": "netapp.projects.locations.volumes.replications.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications", "path": "v1beta1/{+parent}/replications", "parameterOrder": [ "parent" ], "response": { "$ref": "ListReplicationsResponse" } }, "patch": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", "request": { "$ref": "Replication" }, "httpMethod": "PATCH", "id": "netapp.projects.locations.volumes.replications.patch", "description": "Updates the settings of a specific replication.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "type": "string", "location": "path", "description": "Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.", "required": true }, "updateMask": { "location": "query", "description": "Required. Mask of fields to update. At least one path must be supplied in this field.", "type": "string", "format": "google-fieldmask" } } }, "sync": { "path": "v1beta1/{+name}:sync", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "SyncReplicationRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:sync", "httpMethod": "POST", "description": "Syncs the replication. This will invoke one time volume data transfer from source to destination.", "id": "netapp.projects.locations.volumes.replications.sync", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "location": "path", "description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", "required": true } } }, "reverseDirection": { "path": "v1beta1/{+name}:reverseDirection", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:reverseDirection", "request": { "$ref": "ReverseReplicationDirectionRequest" }, "httpMethod": "POST", "id": "netapp.projects.locations.volumes.replications.reverseDirection", "description": "Reverses direction of replication. Source becomes destination and destination becomes source.", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", "required": true } } } } }, "quotaRules": { "methods": { "get": { "httpMethod": "GET", "id": "netapp.projects.locations.volumes.quotaRules.get", "description": "Returns details of the specified quota rule.", "parameters": { "name": { "description": "Required. Name of the quota rule", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/quotaRules/[^/]+$", "type": "string" } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "QuotaRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules/{quotaRulesId}" }, "create": { "id": "netapp.projects.locations.volumes.quotaRules.create", "description": "Creates a new quota rule.", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Parent value for CreateQuotaRuleRequest", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "type": "string" }, "quotaRuleId": { "description": "Required. ID of the quota rule to create. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+parent}/quotaRules", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules", "request": { "$ref": "QuotaRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListQuotaRulesResponse" }, "path": "v1beta1/{+parent}/quotaRules", "parameters": { "filter": { "description": "Optional. Filtering results", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results", "type": "string" }, "parent": { "description": "Required. Parent value for ListQuotaRulesRequest", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "type": "string", "location": "path" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", "type": "integer", "location": "query" } }, "description": "Returns list of all quota rules in a location.", "id": "netapp.projects.locations.volumes.quotaRules.list", "httpMethod": "GET" }, "patch": { "parameters": { "name": { "description": "Identifier. The resource name of the quota rule. Format: `projects/{project_number}/locations/{location_id}/volumes/volumes/{volume_id}/quotaRules/{quota_rule_id}`.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/quotaRules/[^/]+$", "location": "path" }, "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the Quota Rule 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.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "httpMethod": "PATCH", "id": "netapp.projects.locations.volumes.quotaRules.patch", "description": "Updates a quota rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules/{quotaRulesId}", "request": { "$ref": "QuotaRule" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules/{quotaRulesId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "Required. Name of the quota rule.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/quotaRules/[^/]+$", "type": "string" } }, "httpMethod": "DELETE", "id": "netapp.projects.locations.volumes.quotaRules.delete", "description": "Deletes a quota rule." } } } } }, "kmsConfigs": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "Required. Name of the KmsConfig.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "type": "string" } }, "httpMethod": "DELETE", "id": "netapp.projects.locations.kmsConfigs.delete", "description": "Warning! This operation will permanently delete the Kms config." }, "encrypt": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+name}:encrypt", "request": { "$ref": "EncryptVolumesRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}:encrypt", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.", "id": "netapp.projects.locations.kmsConfigs.encrypt", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "type": "string", "location": "path", "description": "Required. Name of the KmsConfig.", "required": true } } }, "list": { "httpMethod": "GET", "description": "Returns descriptions of all KMS configs owned by the caller.", "id": "netapp.projects.locations.kmsConfigs.list", "parameters": { "filter": { "description": "List filter.", "type": "string", "location": "query" }, "pageToken": { "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. Parent value", "required": true }, "pageSize": { "location": "query", "description": "The maximum number of items to return.", "type": "integer", "format": "int32" } }, "path": "v1beta1/{+parent}/kmsConfigs", "parameterOrder": [ "parent" ], "response": { "$ref": "ListKmsConfigsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs" }, "patch": { "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "location": "path", "description": "Identifier. Name of the `KmsConfig`. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "required": true }, "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten in the KmsConfig 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.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "httpMethod": "PATCH", "id": "netapp.projects.locations.kmsConfigs.patch", "description": "Updates the Kms config properties with the full spec", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", "request": { "$ref": "KmsConfig" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } }, "verify": { "parameters": { "name": { "description": "Required. Name of the KMS Config to be verified.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "location": "path" } }, "httpMethod": "POST", "description": "Verifies KMS config reachability.", "id": "netapp.projects.locations.kmsConfigs.verify", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "VerifyKmsConfigRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}:verify", "path": "v1beta1/{+name}:verify", "parameterOrder": [ "name" ], "response": { "$ref": "VerifyKmsConfigResponse" } }, "create": { "id": "netapp.projects.locations.kmsConfigs.create", "description": "Creates a new KMS config.", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Value for parent.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "kmsConfigId": { "location": "query", "description": "Required. Id of the requesting KmsConfig. 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.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "path": "v1beta1/{+parent}/kmsConfigs", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs", "request": { "$ref": "KmsConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "description": "Returns the description of the specified KMS config by kms_config_id.", "id": "netapp.projects.locations.kmsConfigs.get", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "location": "path", "description": "Required. Name of the KmsConfig", "required": true } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "KmsConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}" } } } } } } } }, "description": "Google Cloud NetApp Volumes is a fully-managed, cloud-based data storage service that provides advanced data management capabilities and highly scalable performance with global availability.", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-netapp": { "description": "See, edit, configure, and delete your Google Cloud NetApp data and see the email address for your Google Account" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "schemas": { "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "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}`.", "type": "string" }, "done": { "description": "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.", "type": "boolean" }, "response": { "description": "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`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "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.", "type": "object" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." } } }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {}, "id": "CancelOperationRequest" }, "ExecuteOntapDeleteResponse": { "description": "Response message for `ExecuteOntapDelete` API.", "type": "object", "properties": { "body": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The raw `JSON` body of the response.", "type": "object" } }, "id": "ExecuteOntapDeleteResponse" }, "Volume": { "description": "Volume provides a filesystem that you can mount.", "type": "object", "properties": { "state": { "readOnly": true, "description": "Output only. State of the volume", "enumDescriptions": [ "Unspecified Volume State", "Volume State is Ready", "Volume State is Creating", "Volume State is Deleting", "Volume State is Updating", "Volume State is Restoring", "Volume State is Disabled", "Volume State is Error", "Volume State is Preparing. Note that this is different from CREATING where CREATING means the volume is being created, while PREPARING means the volume is created and now being prepared for the replication.", "Volume State is Read Only" ], "enum": [ "STATE_UNSPECIFIED", "READY", "CREATING", "DELETING", "UPDATING", "RESTORING", "DISABLED", "ERROR", "PREPARING", "READ_ONLY" ], "type": "string" }, "labels": { "description": "Optional. Labels as key value pairs", "type": "object", "additionalProperties": { "type": "string" } }, "unixPermissions": { "description": "Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.", "type": "string" }, "mountOptions": { "items": { "$ref": "MountOption" }, "description": "Output only. Mount options of this volume", "type": "array", "readOnly": true }, "usedGib": { "description": "Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.", "type": "string", "readOnly": true, "format": "int64" }, "capacityGib": { "description": "Required. Capacity in GIB of the volume", "type": "string", "format": "int64" }, "activeDirectory": { "description": "Output only. Specifies the ActiveDirectory name of a SMB volume.", "type": "string", "readOnly": true }, "largeCapacityConfig": { "description": "Optional. Large capacity config for the volume. Enables and configures large capacity for volumes in Unified pools with File protocols. Not applicable for Block protocols in Unified pools. This field and the legacy `large_capacity` boolean field are mutually exclusive.", "$ref": "LargeCapacityConfig" }, "snapshotDirectory": { "description": "Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.", "type": "boolean" }, "restrictedActions": { "items": { "type": "string", "enumDescriptions": [ "Unspecified restricted action", "Prevent volume from being deleted when mounted." ], "enum": [ "RESTRICTED_ACTION_UNSPECIFIED", "DELETE" ] }, "description": "Optional. List of actions that are restricted on this volume.", "type": "array" }, "replicaZone": { "readOnly": true, "description": "Output only. Specifies the replica zone for regional volume.", "type": "string" }, "storagePool": { "description": "Required. StoragePool name of the volume", "type": "string" }, "snapshotPolicy": { "$ref": "SnapshotPolicy", "description": "Optional. SnapshotPolicy for a volume." }, "hasReplication": { "description": "Output only. Indicates whether the volume is part of a replication relationship.", "type": "boolean", "readOnly": true }, "encryptionType": { "enum": [ "ENCRYPTION_TYPE_UNSPECIFIED", "SERVICE_MANAGED", "CLOUD_KMS" ], "type": "string", "readOnly": true, "description": "Output only. Specified the current volume encryption key source.", "enumDescriptions": [ "The source of the encryption key is not specified.", "Google managed encryption key.", "Customer managed encryption key, which is stored in KMS." ] }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Create time of the volume", "type": "string" }, "tieringPolicy": { "$ref": "TieringPolicy", "description": "Tiering policy for the volume." }, "restoreParameters": { "$ref": "RestoreParameters", "description": "Optional. Specifies the source of the volume to be created from." }, "hybridReplicationParameters": { "$ref": "HybridReplicationParameters", "description": "Optional. The Hybrid Replication parameters for the volume." }, "ldapEnabled": { "description": "Output only. Flag indicating if the volume is NFS LDAP enabled or not.", "type": "boolean", "readOnly": true }, "description": { "description": "Optional. Description of the volume", "type": "string" }, "psaRange": { "description": "Output only. This field is not implemented. The values provided in this field are ignored.", "type": "string", "readOnly": true }, "hotTierSizeUsedGib": { "readOnly": true, "format": "int64", "description": "Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level", "type": "string" }, "stateDetails": { "description": "Output only. State details of the volume", "type": "string", "readOnly": true }, "blockDevices": { "items": { "$ref": "BlockDevice" }, "description": "Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.", "type": "array" }, "name": { "description": "Identifier. Name of the volume", "type": "string" }, "backupConfig": { "$ref": "BackupConfig", "description": "BackupConfig of the volume." }, "multipleEndpoints": { "description": "Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.", "type": "boolean" }, "securityStyle": { "enum": [ "SECURITY_STYLE_UNSPECIFIED", "NTFS", "UNIX" ], "description": "Optional. Security Style of the Volume", "type": "string", "enumDescriptions": [ "SecurityStyle is unspecified", "SecurityStyle uses NTFS", "SecurityStyle uses UNIX" ] }, "throughputMibps": { "format": "double", "description": "Optional. Throughput of the volume (in MiB/s)", "type": "number" }, "shareName": { "description": "Required. Share name of the volume", "type": "string" }, "smbSettings": { "items": { "enum": [ "SMB_SETTINGS_UNSPECIFIED", "ENCRYPT_DATA", "BROWSABLE", "CHANGE_NOTIFY", "NON_BROWSABLE", "OPLOCKS", "SHOW_SNAPSHOT", "SHOW_PREVIOUS_VERSIONS", "ACCESS_BASED_ENUMERATION", "CONTINUOUSLY_AVAILABLE" ], "type": "string", "enumDescriptions": [ "Unspecified default option", "SMB setting encrypt data", "SMB setting browsable", "SMB setting notify change", "SMB setting not to notify change", "SMB setting oplocks", "SMB setting to show snapshots", "SMB setting to show previous versions", "SMB setting to access volume based on enumerartion", "Continuously available enumeration" ] }, "description": "Optional. SMB share settings for the volume.", "type": "array" }, "cloneDetails": { "readOnly": true, "$ref": "CloneDetails", "description": "Output only. If this volume is a clone, this field contains details about the clone." }, "kmsConfig": { "description": "Output only. Specifies the KMS config to be used for volume encryption.", "type": "string", "readOnly": true }, "coldTierSizeGib": { "description": "Output only. Size of the volume cold tier data rounded down to the nearest GiB.", "type": "string", "readOnly": true, "format": "int64" }, "serviceLevel": { "readOnly": true, "description": "Output only. Service level of the volume", "enumDescriptions": [ "Unspecified service level.", "Premium service level.", "Extreme service level.", "Standard service level.", "Flex service level." ], "enum": [ "SERVICE_LEVEL_UNSPECIFIED", "PREMIUM", "EXTREME", "STANDARD", "FLEX" ], "type": "string" }, "zone": { "readOnly": true, "description": "Output only. Specifies the active zone for regional volume.", "type": "string" }, "snapReserve": { "format": "double", "description": "Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.", "type": "number" }, "exportPolicy": { "description": "Optional. Export policy of the volume", "$ref": "ExportPolicy" }, "protocols": { "items": { "enum": [ "PROTOCOLS_UNSPECIFIED", "NFSV3", "NFSV4", "SMB", "ISCSI", "NVME" ], "type": "string", "enumDescriptions": [ "Unspecified protocol", "NFS V3 protocol", "NFS V4 protocol", "SMB protocol", "ISCSI protocol", "NVMe protocol" ] }, "description": "Required. Protocols required for the volume", "type": "array" }, "largeCapacity": { "description": "Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive.", "type": "boolean" }, "network": { "readOnly": true, "description": "Output only. VPC Network name. Format: projects/{project}/global/networks/{network}", "type": "string" }, "kerberosEnabled": { "description": "Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).", "type": "boolean" }, "cacheParameters": { "$ref": "CacheParameters", "description": "Optional. Cache parameters for the volume." } }, "id": "Volume" }, "HostGroup": { "description": "Host group is a collection of hosts that can be used for accessing a Block Volume.", "type": "object", "properties": { "type": { "enum": [ "TYPE_UNSPECIFIED", "ISCSI_INITIATOR" ], "description": "Required. Type of the host group.", "type": "string", "enumDescriptions": [ "Unspecified type for host group.", "iSCSI initiator host group." ] }, "state": { "description": "Output only. State of the host group.", "enumDescriptions": [ "Unspecified state for host group.", "Host group is creating.", "Host group is ready.", "Host group is updating.", "Host group is deleting.", "Host group is disabled." ], "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "DELETING", "DISABLED" ] }, "name": { "description": "Identifier. The resource name of the host group. Format: `projects/{project_number}/locations/{location_id}/hostGroups/{host_group_id}`.", "type": "string" }, "createTime": { "description": "Output only. Create time of the host group.", "type": "string", "readOnly": true, "format": "google-datetime" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. Labels of the host group.", "type": "object" }, "hosts": { "items": { "type": "string" }, "description": "Required. The list of hosts associated with the host group.", "type": "array" }, "osType": { "description": "Required. The OS type of the host group. It indicates the type of operating system used by all of the hosts in the HostGroup. All hosts in a HostGroup must be of the same OS type. This can be set only when creating a HostGroup.", "type": "string", "enumDescriptions": [ "Unspecified OS Type", "OS Type is Linux", "OS Type is Windows", "OS Type is VMware ESXi" ], "enum": [ "OS_TYPE_UNSPECIFIED", "LINUX", "WINDOWS", "ESXI" ] }, "description": { "description": "Optional. Description of the host group.", "type": "string" } }, "id": "HostGroup" }, "OntapSource": { "id": "OntapSource", "description": "Represents ONTAP source details.", "type": "object", "properties": { "storagePool": { "description": "Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}`", "type": "string" }, "snapshotUuid": { "description": "Optional. The UUID of the ONTAP source snapshot.", "type": "string" }, "volumeUuid": { "description": "Required. The UUID of the ONTAP source volume.", "type": "string" } } }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "apiVersion": { "readOnly": true, "description": "Output only. API version used to start the operation.", "type": "string" }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "type": "string", "readOnly": true }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true }, "requestedCancellation": { "readOnly": true, "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been canceled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" } } }, "ListActiveDirectoriesResponse": { "description": "ListActiveDirectoriesResponse contains all the active directories requested.", "type": "object", "properties": { "activeDirectories": { "description": "The list of active directories.", "type": "array", "items": { "$ref": "ActiveDirectory" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } }, "id": "ListActiveDirectoriesResponse" }, "SyncReplicationRequest": { "description": "SyncReplicationRequest syncs the replication from source to destination.", "type": "object", "properties": {}, "id": "SyncReplicationRequest" }, "UpdateBackupConfigRequest": { "id": "UpdateBackupConfigRequest", "description": "Request message for UpdateBackupConfig", "type": "object", "properties": { "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten in the BackupConfig for the Volume. 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.", "type": "string", "format": "google-fieldmask" }, "volumeUuid": { "description": "Required. The UUID of the ONTAP-mode volume.", "type": "string" }, "backupConfig": { "description": "Required. Backup configuration to apply.", "$ref": "BackupConfig" } } }, "ListHostGroupsResponse": { "id": "ListHostGroupsResponse", "description": "ListHostGroupsResponse is the response to a ListHostGroupsRequest.", "type": "object", "properties": { "hostGroups": { "description": "The list of host groups.", "type": "array", "items": { "$ref": "HostGroup" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "ExecuteOntapPostRequest": { "id": "ExecuteOntapPostRequest", "description": "Request message for `ExecuteOntapPost` API.", "type": "object", "properties": { "body": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Required. The raw `JSON` body of the request. The body should be in the format of the ONTAP resource. For example: ``` { \"body\": { \"field1\": \"value1\", \"field2\": \"value2\", } } ```", "type": "object" } } }, "SnapshotPolicy": { "id": "SnapshotPolicy", "description": "Snapshot Policy for a volume.", "type": "object", "properties": { "weeklySchedule": { "description": "Weekly schedule policy.", "$ref": "WeeklySchedule" }, "enabled": { "description": "If enabled, make snapshots automatically according to the schedules. Default is false.", "type": "boolean" }, "hourlySchedule": { "description": "Hourly schedule policy.", "$ref": "HourlySchedule" }, "monthlySchedule": { "description": "Monthly schedule policy.", "$ref": "MonthlySchedule" }, "dailySchedule": { "description": "Daily schedule policy.", "$ref": "DailySchedule" } } }, "VerifyKmsConfigResponse": { "description": "VerifyKmsConfigResponse contains the information if the config is correctly and error message.", "type": "object", "properties": { "instructions": { "description": "Output only. Instructions for the customers to provide the access to the encryption key.", "type": "string", "readOnly": true }, "healthy": { "description": "Output only. If the customer key configured correctly to the encrypt volume.", "type": "boolean", "readOnly": true }, "healthError": { "readOnly": true, "description": "Output only. Error message if config is not healthy.", "type": "string" } }, "id": "VerifyKmsConfigResponse" }, "Backup": { "description": "A NetApp Backup.", "type": "object", "properties": { "chainStorageBytes": { "description": "Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)", "type": "string", "readOnly": true, "format": "int64" }, "backupRegion": { "readOnly": true, "description": "Output only. Region in which backup is stored. Format: `projects/{project_id}/locations/{location}`", "type": "string" }, "backupType": { "enum": [ "TYPE_UNSPECIFIED", "MANUAL", "SCHEDULED" ], "type": "string", "readOnly": true, "description": "Output only. Type of backup, manually created or created by a backup policy.", "enumDescriptions": [ "Unspecified backup type.", "Manual backup type.", "Scheduled backup type." ] }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time when the backup was created.", "type": "string" }, "enforcedRetentionEndTime": { "description": "Output only. The time until which the backup is not deletable.", "type": "string", "readOnly": true, "format": "google-datetime" }, "sourceSnapshot": { "description": "If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`", "type": "string" }, "volumeRegion": { "readOnly": true, "description": "Output only. Region of the volume from which the backup was created. Format: `projects/{project_id}/locations/{location}`", "type": "string" }, "volumeUsageBytes": { "readOnly": true, "format": "int64", "description": "Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.", "type": "string" }, "ontapSource": { "description": "Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided.", "$ref": "OntapSource" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Resource labels to represent user provided metadata.", "type": "object" }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "UPLOADING", "READY", "DELETING", "ERROR", "UPDATING" ], "type": "string", "readOnly": true, "description": "Output only. The backup state.", "enumDescriptions": [ "State not set.", "Backup is being created. While in this state, the snapshot for the backup point-in-time may not have been created yet, and so the point-in-time may not have been fixed.", "Backup is being uploaded. While in this state, none of the writes to the volume will be included in the backup.", "Backup is available for use.", "Backup is being deleted.", "Backup is not valid and cannot be used for creating new volumes or restoring existing volumes.", "Backup is being updated." ] }, "name": { "description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", "type": "string" }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Reserved for future use", "type": "boolean" }, "sourceVolume": { "description": "The resource name of the volume that this backup belongs to. You must provide either `source_volume` or `ontap_source`. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "type": "string" }, "satisfiesPzs": { "description": "Output only. Reserved for future use", "type": "boolean", "readOnly": true }, "description": { "description": "A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.", "type": "string" } }, "id": "Backup" }, "ListBackupConfigsResponse": { "id": "ListBackupConfigsResponse", "description": "Message for response to listing BackupConfigs in an ONTAP StoragePool.", "type": "object", "properties": { "volumeBackupConfigs": { "items": { "$ref": "VolumeBackupConfig" }, "description": "A list of backup configurations for volumes in the pool.", "type": "array" }, "nextPageToken": { "description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Locations that could not be reached.", "type": "array" } } }, "HybridReplicationParameters": { "id": "HybridReplicationParameters", "description": "The Hybrid Replication parameters for the volume.", "type": "object", "properties": { "replication": { "description": "Required. Desired name for the replication of this volume.", "type": "string" }, "peerClusterName": { "description": "Required. Name of the user's local source cluster to be peered with the destination cluster.", "type": "string" }, "description": { "description": "Optional. Description of the replication.", "type": "string" }, "replicationSchedule": { "description": "Optional. Replication Schedule for the replication created.", "type": "string", "enumDescriptions": [ "Unspecified HybridReplicationSchedule", "Replication happens once every 10 minutes.", "Replication happens once every hour.", "Replication happens once every day." ], "enum": [ "HYBRID_REPLICATION_SCHEDULE_UNSPECIFIED", "EVERY_10_MINUTES", "HOURLY", "DAILY" ] }, "peerSvmName": { "description": "Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.", "type": "string" }, "hybridReplicationType": { "description": "Optional. Type of the hybrid replication.", "type": "string", "enumDescriptions": [ "Unspecified hybrid replication type.", "Hybrid replication type for migration.", "Hybrid replication type for continuous replication.", "New field for reversible OnPrem replication, to be used for data protection.", "New field for reversible OnPrem replication, to be used for data protection." ], "enum": [ "VOLUME_HYBRID_REPLICATION_TYPE_UNSPECIFIED", "MIGRATION", "CONTINUOUS_REPLICATION", "ONPREM_REPLICATION", "REVERSE_ONPREM_REPLICATION" ] }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. Labels to be added to the replication as the key value pairs.", "type": "object" }, "largeVolumeConstituentCount": { "format": "int32", "description": "Optional. Constituent volume count for large volume.", "type": "integer" }, "peerVolumeName": { "description": "Required. Name of the user's local source volume to be peered with the destination volume.", "type": "string" }, "peerIpAddresses": { "description": "Required. List of node ip addresses to be peered with.", "type": "array", "items": { "type": "string" } }, "clusterLocation": { "description": "Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only.", "type": "string" } } }, "ListReplicationsResponse": { "id": "ListReplicationsResponse", "description": "ListReplicationsResponse is the result of ListReplicationsRequest.", "type": "object", "properties": { "replications": { "items": { "$ref": "Replication" }, "description": "A list of replications in the project for the specified volume.", "type": "array" }, "nextPageToken": { "description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "ListBackupsResponse": { "id": "ListBackupsResponse", "description": "ListBackupsResponse is the result of ListBackupsRequest.", "type": "object", "properties": { "backups": { "description": "A list of backups in the project.", "type": "array", "items": { "$ref": "Backup" } }, "nextPageToken": { "description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "SwitchActiveReplicaZoneRequest": { "id": "SwitchActiveReplicaZoneRequest", "description": "SwitchActiveReplicaZoneRequest switch the active/replica zone for a regional storagePool.", "type": "object", "properties": {} }, "DestinationVolumeParameters": { "id": "DestinationVolumeParameters", "description": "DestinationVolumeParameters specify input parameters used for creating destination volume.", "type": "object", "properties": { "storagePool": { "description": "Required. Existing destination StoragePool name.", "type": "string" }, "tieringPolicy": { "$ref": "TieringPolicy", "description": "Optional. Tiering policy for the volume." }, "description": { "description": "Description for the destination volume.", "type": "string" }, "volumeId": { "description": "Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.", "type": "string" }, "shareName": { "description": "Destination volume's share name. If not specified, source volume's share name will be used.", "type": "string" } } }, "RevertVolumeRequest": { "description": "RevertVolumeRequest reverts the given volume to the specified snapshot.", "type": "object", "properties": { "snapshotId": { "description": "Required. The snapshot resource ID, in the format 'my-snapshot', where the specified ID is the {snapshot_id} of the fully qualified name like projects/{project_id}/locations/{location_id}/volumes/{volume_id}/snapshots/{snapshot_id}", "type": "string" } }, "id": "RevertVolumeRequest" }, "RestoreBackupFilesRequest": { "description": "RestoreBackupFilesRequest restores files from a backup to a volume.", "type": "object", "properties": { "backup": { "description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", "type": "string" }, "fileList": { "description": "Required. List of files to be restored, specified by their absolute path in the source volume.", "type": "array", "items": { "type": "string" } }, "restoreDestinationPath": { "description": "Optional. Absolute directory path in the destination volume. This is required if the `file_list` is provided.", "type": "string" } }, "id": "RestoreBackupFilesRequest" }, "LocationMetadata": { "description": "Metadata for a given google.cloud.location.Location.", "type": "object", "properties": { "supportedServiceLevels": { "description": "Output only. Supported service levels in a location.", "type": "array", "readOnly": true, "items": { "enum": [ "SERVICE_LEVEL_UNSPECIFIED", "PREMIUM", "EXTREME", "STANDARD", "FLEX" ], "type": "string", "enumDescriptions": [ "Unspecified service level.", "Premium service level.", "Extreme service level.", "Standard service level.", "Flex service level." ] } }, "supportedFlexPerformance": { "readOnly": true, "description": "Output only. Supported flex performance in a location.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Unspecified flex performance.", "Flex Storage Pool with default performance.", "Flex Storage Pool with custom performance." ], "enum": [ "FLEX_PERFORMANCE_UNSPECIFIED", "FLEX_PERFORMANCE_DEFAULT", "FLEX_PERFORMANCE_CUSTOM" ] } }, "hasOntapProxy": { "readOnly": true, "description": "Output only. Indicates if the location has ONTAP Proxy support.", "type": "boolean" }, "hasVcp": { "readOnly": true, "description": "Output only. Indicates if the location has VCP support.", "type": "boolean" } }, "id": "LocationMetadata" }, "EstablishPeeringRequest": { "id": "EstablishPeeringRequest", "description": "EstablishPeeringRequest establishes cluster and svm peerings between the source and the destination replications.", "type": "object", "properties": { "peerClusterName": { "description": "Required. Name of the user's local source cluster to be peered with the destination cluster.", "type": "string" }, "peerIpAddresses": { "description": "Optional. List of IPv4 ip addresses to be used for peering.", "type": "array", "items": { "type": "string" } }, "peerVolumeName": { "description": "Required. Name of the user's local source volume to be peered with the destination volume.", "type": "string" }, "peerSvmName": { "description": "Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.", "type": "string" } } }, "RestoreVolumeRequest": { "description": "Request message for `RestoreVolume` API.", "type": "object", "properties": { "backupSource": { "description": "The backup source of the restore operation.", "$ref": "BackupSource" }, "ontapVolumeTarget": { "$ref": "OntapVolumeTarget", "description": "The ONTAP volume target of the restore operation." } }, "id": "RestoreVolumeRequest" }, "ListKmsConfigsResponse": { "id": "ListKmsConfigsResponse", "description": "ListKmsConfigsResponse is the response to a ListKmsConfigsRequest.", "type": "object", "properties": { "kmsConfigs": { "items": { "$ref": "KmsConfig" }, "description": "The list of KmsConfigs", "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "CloneDetails": { "id": "CloneDetails", "description": "Details about a clone volume.", "type": "object", "properties": { "sourceVolume": { "readOnly": true, "description": "Output only. Full name of the source volume resource. Format: projects/{project}/locations/{location}/volumes/{volume}", "type": "string" }, "sourceSnapshot": { "readOnly": true, "description": "Output only. Specifies the full resource name of the source snapshot from which this volume was cloned. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}", "type": "string" }, "sharedSpaceGib": { "description": "Output only. Shared space in GiB. Determined at volume creation time based on size of source snapshot.", "type": "string", "readOnly": true, "format": "int64" } } }, "ExecuteOntapPatchResponse": { "description": "Response message for `ExecuteOntapPatch` API.", "type": "object", "properties": { "body": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The raw `JSON` body of the response.", "type": "object" } }, "id": "ExecuteOntapPatchResponse" }, "ExecuteOntapPostResponse": { "id": "ExecuteOntapPostResponse", "description": "Response message for `ExecuteOntapPost` API.", "type": "object", "properties": { "body": { "description": "The raw `JSON` body of the response.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "ListStoragePoolsResponse": { "description": "ListStoragePoolsResponse is the response to a ListStoragePoolsRequest.", "type": "object", "properties": { "storagePools": { "items": { "$ref": "StoragePool" }, "description": "The list of StoragePools", "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } }, "id": "ListStoragePoolsResponse" }, "Snapshot": { "description": "Snapshot is a point-in-time version of a Volume's content.", "type": "object", "properties": { "description": { "description": "A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.", "type": "string" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "READY", "CREATING", "DELETING", "UPDATING", "DISABLED", "ERROR" ], "description": "Output only. The snapshot state.", "enumDescriptions": [ "Unspecified Snapshot State", "Snapshot State is Ready", "Snapshot State is Creating", "Snapshot State is Deleting", "Snapshot State is Updating", "Snapshot State is Disabled", "Snapshot State is Error" ], "readOnly": true }, "stateDetails": { "description": "Output only. State details of the storage pool", "type": "string", "readOnly": true }, "name": { "description": "Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.", "type": "string" }, "usedBytes": { "readOnly": true, "format": "double", "description": "Output only. Current storage usage for the snapshot in bytes.", "type": "number" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time when the snapshot was created.", "type": "string" }, "labels": { "description": "Resource labels to represent user provided metadata.", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "Snapshot" }, "ExecuteOntapGetResponse": { "id": "ExecuteOntapGetResponse", "description": "Response message for `ExecuteOntapGet` API.", "type": "object", "properties": { "body": { "description": "The raw `JSON` body of the response.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "ListVolumesResponse": { "description": "Message for response to listing Volumes", "type": "object", "properties": { "volumes": { "description": "The list of Volume", "type": "array", "items": { "$ref": "Volume" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } }, "id": "ListVolumesResponse" }, "WeeklySchedule": { "id": "WeeklySchedule", "description": "Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50", "type": "object", "properties": { "minute": { "format": "double", "description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", "type": "number" }, "hour": { "format": "double", "description": "Set the hour to start the snapshot (0-23), defaults to midnight (0).", "type": "number" }, "day": { "description": "Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.", "type": "string" }, "snapshotsToKeep": { "format": "double", "description": "The maximum number of Snapshots to keep for the hourly schedule", "type": "number" } } }, "ExecuteOntapPatchRequest": { "description": "Request message for `ExecuteOntapPatch` API.", "type": "object", "properties": { "body": { "description": "Required. The raw `JSON` body of the request. The body should be in the format of the ONTAP resource. For example: ``` { \"body\": { \"field1\": \"value1\", \"field2\": \"value2\", } } ```", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "ExecuteOntapPatchRequest" }, "BackupConfig": { "description": "BackupConfig contains backup related config on a volume.", "type": "object", "properties": { "backupPolicies": { "description": "Optional. When specified, schedule backups will be created based on the policy configuration.", "type": "array", "items": { "type": "string" } }, "backupVault": { "description": "Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}", "type": "string" }, "scheduledBackupEnabled": { "description": "Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.", "type": "boolean" }, "backupChainBytes": { "description": "Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).", "type": "string", "readOnly": true, "format": "int64" } }, "id": "BackupConfig" }, "OntapVolumeTarget": { "description": "Represents the ONTAP volume target of the restore operation.", "type": "object", "properties": { "restoreDestinationPath": { "description": "Optional. Absolute directory path in the destination volume.", "type": "string" }, "volumeUuid": { "description": "Required. The UUID of the ONTAP volume to restore to.", "type": "string" } }, "id": "OntapVolumeTarget" }, "TieringPolicy": { "description": "Defines tiering policy for the volume.", "type": "object", "properties": { "coolingThresholdDays": { "description": "Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.", "type": "integer", "format": "int32" }, "tierAction": { "description": "Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.", "type": "string", "enumDescriptions": [ "Unspecified.", "When tiering is enabled, new cold data will be tiered.", "When paused, tiering won't be performed on new data. Existing data stays tiered until accessed." ], "enum": [ "TIER_ACTION_UNSPECIFIED", "ENABLED", "PAUSED" ] }, "hotTierBypassModeEnabled": { "description": "Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.", "type": "boolean" } }, "id": "TieringPolicy" }, "ListBackupPoliciesResponse": { "description": "ListBackupPoliciesResponse contains all the backup policies requested.", "type": "object", "properties": { "backupPolicies": { "items": { "$ref": "BackupPolicy" }, "description": "The list of backup policies.", "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "id": "ListBackupPoliciesResponse" }, "BackupSource": { "id": "BackupSource", "description": "Represents the backup source of the restore operation.", "type": "object", "properties": { "backup": { "description": "Required. The backup resource name.", "type": "string" }, "fileList": { "description": "Optional. List of files to be restored in the form of their absolute path as in source volume. If provided, only these files will be restored. If not provided, the entire backup will be restored (Full Backup Restore)", "type": "array", "items": { "type": "string" } } } }, "EncryptVolumesRequest": { "description": "EncryptVolumesRequest specifies the KMS config to encrypt existing volumes.", "type": "object", "properties": {}, "id": "EncryptVolumesRequest" }, "RestoreParameters": { "description": "The RestoreParameters if volume is created from a snapshot or backup.", "type": "object", "properties": { "sourceSnapshot": { "description": "Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}", "type": "string" }, "sourceBackup": { "description": "Full name of the backup resource. Format for standard backup: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}. Format for BackupDR backup: projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}", "type": "string" } }, "id": "RestoreParameters" }, "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array" }, "operations": { "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" } } }, "TransferStats": { "id": "TransferStats", "description": "TransferStats reports all statistics related to replication transfer.", "type": "object", "properties": { "updateTime": { "description": "Time when progress was updated last.", "type": "string", "format": "google-datetime" }, "lastTransferDuration": { "format": "google-duration", "description": "Time taken during last transfer.", "type": "string" }, "transferBytes": { "format": "int64", "description": "Cumulative bytes transferred so far for the replication relationship.", "type": "string" }, "lastTransferEndTime": { "format": "google-datetime", "description": "Time when last transfer completed.", "type": "string" }, "lastTransferError": { "description": "A message describing the cause of the last transfer failure.", "type": "string" }, "lastTransferBytes": { "format": "int64", "description": "Last transfer size in bytes.", "type": "string" }, "totalTransferDuration": { "description": "Cumulative time taken across all transfers for the replication relationship.", "type": "string", "format": "google-duration" }, "lagDuration": { "format": "google-duration", "description": "Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.", "type": "string" } } }, "LargeCapacityConfig": { "description": "Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB; it is composed of multiple internal constituents, and must be created in a large capacity pool.", "type": "object", "properties": { "constituentCount": { "format": "int32", "description": "Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2.", "type": "integer" } }, "id": "LargeCapacityConfig" }, "ActiveDirectory": { "description": "ActiveDirectory is the public representation of the active directory config.", "type": "object", "properties": { "kdcIp": { "description": "KDC server IP address for the active directory machine.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels for the active directory.", "type": "object" }, "state": { "readOnly": true, "description": "Output only. The state of the AD.", "enumDescriptions": [ "Unspecified Active Directory State", "Active Directory State is Creating", "Active Directory State is Ready", "Active Directory State is Updating", "Active Directory State is In use", "Active Directory State is Deleting", "Active Directory State is Error", "Active Directory State is Diagnosing." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "IN_USE", "DELETING", "ERROR", "DIAGNOSING" ], "type": "string" }, "dns": { "description": "Required. Comma separated list of DNS server IP addresses for the Active Directory domain.", "type": "string" }, "description": { "description": "Description of the active directory.", "type": "string" }, "name": { "description": "Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.", "type": "string" }, "domain": { "description": "Required. Name of the Active Directory domain", "type": "string" }, "kdcHostname": { "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", "type": "string" }, "stateDetails": { "readOnly": true, "description": "Output only. The state details of the Active Directory.", "type": "string" }, "nfsUsersWithLdap": { "description": "If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.", "type": "boolean" }, "securityOperators": { "items": { "type": "string" }, "description": "Optional. Domain users to be given the SeSecurityPrivilege.", "type": "array" }, "backupOperators": { "description": "Optional. Users to be added to the Built-in Backup Operator active directory group.", "type": "array", "items": { "type": "string" } }, "ldapSigning": { "description": "Specifies whether or not the LDAP traffic needs to be signed.", "type": "boolean" }, "site": { "description": "The Active Directory site the service will limit Domain Controller discovery too.", "type": "string" }, "aesEncryption": { "description": "If enabled, AES encryption will be enabled for SMB communication.", "type": "boolean" }, "password": { "description": "Required. Password of the Active Directory domain administrator.", "type": "string" }, "username": { "description": "Required. Username of the Active Directory domain administrator.", "type": "string" }, "organizationalUnit": { "description": "The Organizational Unit (OU) within the Windows Active Directory the user belongs to.", "type": "string" }, "encryptDcConnections": { "description": "If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.", "type": "boolean" }, "createTime": { "description": "Output only. Create time of the active directory.", "type": "string", "readOnly": true, "format": "google-datetime" }, "netBiosPrefix": { "description": "Required. NetBIOSPrefix is used as a prefix for SMB server name.", "type": "string" }, "administrators": { "items": { "type": "string" }, "description": "Optional. Users to be added to the Built-in Admininstrators group.", "type": "array" } }, "id": "ActiveDirectory" }, "HourlySchedule": { "description": "Make a snapshot every hour e.g. at 04:00, 05:00, 06:00.", "type": "object", "properties": { "snapshotsToKeep": { "description": "The maximum number of Snapshots to keep for the hourly schedule", "type": "number", "format": "double" }, "minute": { "format": "double", "description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", "type": "number" } }, "id": "HourlySchedule" }, "CacheConfig": { "id": "CacheConfig", "description": "Configuration of the cache volume.", "type": "object", "properties": { "writebackEnabled": { "description": "Optional. Flag indicating whether writeback is enabled for the FlexCache volume.", "type": "boolean" }, "cachePrePopulateState": { "description": "Output only. State of the prepopulation job indicating how the prepopulation is progressing.", "enumDescriptions": [ "Default unspecified state.", "State representing when the most recent create or update request did not require a prepopulation job.", "State representing when the most recent update request requested a prepopulation job but it has not yet completed.", "State representing when the most recent update request requested a prepopulation job and it has completed successfully.", "State representing when the most recent update request requested a prepopulation job but the prepopulate job failed." ], "readOnly": true, "type": "string", "enum": [ "CACHE_PRE_POPULATE_STATE_UNSPECIFIED", "NOT_NEEDED", "IN_PROGRESS", "COMPLETE", "ERROR" ] }, "cachePrePopulate": { "description": "Optional. Pre-populate cache volume with data from the origin volume.", "$ref": "CachePrePopulate" }, "cifsChangeNotifyEnabled": { "description": "Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume.", "type": "boolean" } } }, "StoragePool": { "description": "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.", "type": "object", "properties": { "network": { "description": "Required. VPC Network name. Format: projects/{project}/global/networks/{network}", "type": "string" }, "scaleType": { "enum": [ "SCALE_TYPE_UNSPECIFIED", "SCALE_TYPE_DEFAULT", "SCALE_TYPE_SCALEOUT" ], "description": "Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified.", "type": "string", "enumDescriptions": [ "Unspecified scale type.", "Represents standard capacity and performance scale-type. Suitable for general purpose workloads.", "Represents higher capacity and performance scale-type. Suitable for more demanding workloads." ] }, "customPerformanceEnabled": { "description": "Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false", "type": "boolean" }, "volumeCount": { "readOnly": true, "format": "int32", "description": "Output only. Volume count of the storage pool", "type": "integer" }, "mode": { "description": "Optional. Mode of the storage pool. This field is used to control whether the user can perform ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`.", "type": "string", "enumDescriptions": [ "The `Mode` is not specified.", "The resource is managed by the GCNV APIs.", "The resource is managed by the GCNV ONTAP Mode APIs." ], "enum": [ "MODE_UNSPECIFIED", "DEFAULT", "ONTAP" ] }, "kmsConfig": { "description": "Optional. Specifies the KMS config to be used for volume encryption.", "type": "string" }, "serviceLevel": { "description": "Required. Service level of the storage pool", "type": "string", "enumDescriptions": [ "Unspecified service level.", "Premium service level.", "Extreme service level.", "Standard service level.", "Flex service level." ], "enum": [ "SERVICE_LEVEL_UNSPECIFIED", "PREMIUM", "EXTREME", "STANDARD", "FLEX" ] }, "zone": { "description": "Optional. Specifies the active zone for regional storagePool.", "type": "string" }, "stateDetails": { "description": "Output only. State details of the storage pool", "type": "string", "readOnly": true }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Reserved for future use", "type": "boolean" }, "name": { "description": "Identifier. Name of the storage pool", "type": "string" }, "satisfiesPzs": { "description": "Output only. Reserved for future use", "type": "boolean", "readOnly": true }, "description": { "description": "Optional. Description of the storage pool", "type": "string" }, "scaleTier": { "deprecated": true, "enum": [ "SCALE_TIER_UNSPECIFIED", "SCALE_TIER_STANDARD", "SCALE_TIER_ENTERPRISE" ], "type": "string", "description": "Optional. Deprecated: Use scale_type instead. The effective scale tier of the storage pool. If `scale_tier` is not specified during creation, this defaults to `SCALE_TIER_STANDARD`.", "enumDescriptions": [ "Deprecated: Use ScaleType instead. The default value. This value is unused.", "Deprecated: Use ScaleType instead. The standard capacity and performance tier. Suitable for general purpose workloads.", "Deprecated: Use ScaleType instead. A higher capacity and performance tier. Suitable for more demanding workloads." ] }, "psaRange": { "description": "Optional. This field is not implemented. The values provided in this field are ignored.", "type": "string" }, "hotTierSizeUsedGib": { "readOnly": true, "format": "int64", "description": "Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.", "type": "string" }, "totalThroughputMibps": { "description": "Optional. Custom Performance Total Throughput of the pool (in MiBps)", "type": "string", "format": "int64" }, "coldTierSizeUsedGib": { "description": "Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool.", "type": "string", "readOnly": true, "format": "int64" }, "ldapEnabled": { "description": "Optional. Flag indicating if the pool is NFS LDAP enabled or not.", "type": "boolean" }, "availableThroughputMibps": { "readOnly": true, "format": "double", "description": "Output only. Available throughput of the storage pool (in MiB/s).", "type": "number" }, "type": { "description": "Optional. Type of the storage pool. This field is used to control whether the pool supports `FILE` based volumes only or `UNIFIED` (both `FILE` and `BLOCK`) volumes. If not specified during creation, it defaults to `FILE`.", "type": "string", "enumDescriptions": [ "Storage pool type is not specified.", "Storage pool type is file.", "Storage pool type is unified." ], "enum": [ "STORAGE_POOL_TYPE_UNSPECIFIED", "FILE", "UNIFIED" ] }, "encryptionType": { "enum": [ "ENCRYPTION_TYPE_UNSPECIFIED", "SERVICE_MANAGED", "CLOUD_KMS" ], "type": "string", "readOnly": true, "description": "Output only. Specifies the current pool encryption key source.", "enumDescriptions": [ "The source of the encryption key is not specified.", "Google managed encryption key.", "Customer managed encryption key, which is stored in KMS." ] }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Create time of the storage pool", "type": "string" }, "volumeCapacityGib": { "readOnly": true, "format": "int64", "description": "Output only. Allocated size of all volumes in GIB in the storage pool", "type": "string" }, "enableHotTierAutoResize": { "description": "Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size.", "type": "boolean" }, "capacityGib": { "format": "int64", "description": "Required. Capacity in GIB of the pool", "type": "string" }, "activeDirectory": { "description": "Optional. Specifies the Active Directory to be used for creating a SMB volume.", "type": "string" }, "replicaZone": { "description": "Optional. Specifies the replica zone for regional storagePool.", "type": "string" }, "qosType": { "enum": [ "QOS_TYPE_UNSPECIFIED", "AUTO", "MANUAL" ], "description": "Optional. QoS (Quality of Service) Type of the storage pool", "type": "string", "enumDescriptions": [ "Unspecified QoS Type", "QoS Type is Auto", "QoS Type is Manual" ] }, "state": { "enum": [ "STATE_UNSPECIFIED", "READY", "CREATING", "DELETING", "UPDATING", "RESTORING", "DISABLED", "ERROR" ], "type": "string", "readOnly": true, "description": "Output only. State of the storage pool", "enumDescriptions": [ "Unspecified Storage Pool State", "Storage Pool State is Ready", "Storage Pool State is Creating", "Storage Pool State is Deleting", "Storage Pool State is Updating", "Storage Pool State is Restoring", "Storage Pool State is Disabled", "Storage Pool State is Error" ] }, "hotTierSizeGib": { "description": "Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set.", "type": "string", "format": "int64" }, "labels": { "description": "Optional. Labels as key value pairs", "type": "object", "additionalProperties": { "type": "string" } }, "allowAutoTiering": { "description": "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.", "type": "boolean" }, "globalAccessAllowed": { "description": "Deprecated. Used to allow SO pool to access AD or DNS server from other regions.", "type": "boolean", "deprecated": true }, "totalIops": { "format": "int64", "description": "Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps", "type": "string" } }, "id": "StoragePool" }, "BlockDevice": { "id": "BlockDevice", "description": "Block device represents the device(s) which are stored in the block volume.", "type": "object", "properties": { "identifier": { "description": "Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes.", "type": "string", "readOnly": true }, "hostGroups": { "description": "Optional. A list of host groups that identify hosts that can mount the block volume. Format: `projects/{project_id}/locations/{location}/hostGroups/{host_group_id}` This field can be updated after the block device is created.", "type": "array", "items": { "type": "string" } }, "name": { "description": "Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: \"-\", \"_\", \"}\", \"{\", \".\". * Spaces are not allowed.", "type": "string" }, "sizeGib": { "format": "int64", "description": "Optional. The size of the block device in GiB. Any value provided for the `size_gib` field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's `capacity_gib`.", "type": "string" }, "osType": { "enum": [ "OS_TYPE_UNSPECIFIED", "LINUX", "WINDOWS", "ESXI" ], "description": "Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created.", "type": "string", "enumDescriptions": [ "Unspecified OS Type", "OS Type is Linux", "OS Type is Windows", "OS Type is VMware ESXi" ] } } }, "ListBackupVaultsResponse": { "description": "ListBackupVaultsResponse is the result of ListBackupVaultsRequest.", "type": "object", "properties": { "nextPageToken": { "description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "backupVaults": { "items": { "$ref": "BackupVault" }, "description": "A list of backupVaults in the project for the specified location.", "type": "array" } }, "id": "ListBackupVaultsResponse" }, "ValidateDirectoryServiceRequest": { "description": "ValidateDirectoryServiceRequest validates the directory service policy attached to the storage pool.", "type": "object", "properties": { "directoryServiceType": { "enum": [ "DIRECTORY_SERVICE_TYPE_UNSPECIFIED", "ACTIVE_DIRECTORY" ], "description": "Type of directory service policy attached to the storage pool.", "type": "string", "enumDescriptions": [ "Directory service type is not specified.", "Active directory policy attached to the storage pool." ] } }, "id": "ValidateDirectoryServiceRequest" }, "VolumeBackupConfig": { "description": "Backup configuration for a volume in a pool.", "type": "object", "properties": { "volumeUuid": { "description": "Provides the Ontap UUID of the volume within the pool.", "type": "string" }, "backupConfig": { "description": "Backup configuration for the volume.", "$ref": "BackupConfig" } }, "id": "VolumeBackupConfig" }, "ListQuotaRulesResponse": { "description": "ListQuotaRulesResponse is the response to a ListQuotaRulesRequest.", "type": "object", "properties": { "quotaRules": { "description": "List of quota rules", "type": "array", "items": { "$ref": "QuotaRule" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "id": "ListQuotaRulesResponse" }, "ExportPolicy": { "description": "Defines the export policy for the volume.", "type": "object", "properties": { "rules": { "description": "Required. List of export policy rules", "type": "array", "items": { "$ref": "SimpleExportPolicyRule" } } }, "id": "ExportPolicy" }, "Status": { "description": "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).", "type": "object", "properties": { "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "message": { "description": "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.", "type": "string" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" } }, "id": "Status" }, "Replication": { "description": "Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.", "type": "object", "properties": { "hybridReplicationUserCommands": { "readOnly": true, "$ref": "UserCommands", "description": "Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer." }, "healthy": { "readOnly": true, "description": "Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.", "type": "boolean" }, "transferStats": { "readOnly": true, "$ref": "TransferStats", "description": "Output only. Replication transfer statistics." }, "replicationSchedule": { "enum": [ "REPLICATION_SCHEDULE_UNSPECIFIED", "EVERY_10_MINUTES", "HOURLY", "DAILY" ], "description": "Required. Indicates the schedule for replication.", "type": "string", "enumDescriptions": [ "Unspecified ReplicationSchedule", "Replication happens once every 10 minutes.", "Replication happens once every hour.", "Replication happens once every day." ] }, "destinationVolumeParameters": { "description": "Required. Input only. Destination volume parameters", "$ref": "DestinationVolumeParameters" }, "role": { "enum": [ "REPLICATION_ROLE_UNSPECIFIED", "SOURCE", "DESTINATION" ], "type": "string", "readOnly": true, "description": "Output only. Indicates whether this points to source or destination.", "enumDescriptions": [ "Unspecified replication role", "Indicates Source volume.", "Indicates Destination volume." ] }, "createTime": { "description": "Output only. Replication create time.", "type": "string", "readOnly": true, "format": "google-datetime" }, "hybridReplicationType": { "type": "string", "enum": [ "HYBRID_REPLICATION_TYPE_UNSPECIFIED", "MIGRATION", "CONTINUOUS_REPLICATION", "ONPREM_REPLICATION", "REVERSE_ONPREM_REPLICATION" ], "description": "Output only. Type of the hybrid replication.", "enumDescriptions": [ "Unspecified hybrid replication type.", "Hybrid replication type for migration.", "Hybrid replication type for continuous replication.", "New field for reversible OnPrem replication, to be used for data protection.", "Hybrid replication type for incremental Transfer in the reverse direction (GCNV is source and Onprem is destination)" ], "readOnly": true }, "hybridPeeringDetails": { "description": "Output only. Hybrid peering details.", "readOnly": true, "$ref": "HybridPeeringDetails" }, "destinationVolume": { "description": "Output only. Full name of destination volume resource. Example : \"projects/{project}/locations/{location}/volumes/{volume_id}\"", "type": "string", "readOnly": true }, "labels": { "additionalProperties": { "type": "string" }, "description": "Resource labels to represent user provided metadata.", "type": "object" }, "state": { "readOnly": true, "description": "Output only. State of the replication.", "enumDescriptions": [ "Unspecified replication State", "Replication is creating.", "Replication is ready.", "Replication is updating.", "Replication is deleting.", "Replication is in error state.", "Replication is waiting for cluster peering to be established.", "Replication is waiting for SVM peering to be established.", "Replication is waiting for Commands to be executed on Onprem ONTAP.", "Onprem ONTAP is destination and Replication can only be managed from Onprem." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "DELETING", "ERROR", "PENDING_CLUSTER_PEERING", "PENDING_SVM_PEERING", "PENDING_REMOTE_RESYNC", "EXTERNALLY_MANAGED_REPLICATION" ], "type": "string" }, "clusterLocation": { "description": "Optional. Location of the user cluster.", "type": "string" }, "sourceVolume": { "readOnly": true, "description": "Output only. Full name of source volume resource. Example : \"projects/{project}/locations/{location}/volumes/{volume_id}\"", "type": "string" }, "description": { "description": "A description about this replication relationship.", "type": "string" }, "name": { "description": "Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.", "type": "string" }, "stateDetails": { "readOnly": true, "description": "Output only. State details of the replication.", "type": "string" }, "mirrorState": { "readOnly": true, "description": "Output only. Indicates the state of mirroring.", "enumDescriptions": [ "Unspecified MirrorState", "Destination volume is being prepared.", "Destination volume has been initialized and is ready to receive replication transfers.", "Destination volume is not receiving replication transfers.", "Incremental replication is in progress.", "Baseline replication is in progress.", "Replication is aborted.", "Replication is being managed from Onprem ONTAP.", "Peering is yet to be established." ], "enum": [ "MIRROR_STATE_UNSPECIFIED", "PREPARING", "MIRRORED", "STOPPED", "TRANSFERRING", "BASELINE_TRANSFERRING", "ABORTED", "EXTERNALLY_MANAGED", "PENDING_PEERING" ], "type": "string" } }, "id": "Replication" }, "BackupPolicy": { "id": "BackupPolicy", "description": "Backup Policy.", "type": "object", "properties": { "weeklyBackupLimit": { "description": "Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.", "type": "integer", "format": "int32" }, "description": { "description": "Description of the backup policy.", "type": "string" }, "dailyBackupLimit": { "format": "int32", "description": "Number of daily backups to keep. Note that the minimum daily backup limit is 2.", "type": "integer" }, "name": { "description": "Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.", "type": "string" }, "monthlyBackupLimit": { "format": "int32", "description": "Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.", "type": "integer" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time when the backup policy was created.", "type": "string" }, "assignedVolumeCount": { "readOnly": true, "format": "int32", "description": "Output only. The total number of volumes assigned by this backup policy.", "type": "integer" }, "state": { "description": "Output only. The backup policy state.", "enumDescriptions": [ "State not set.", "BackupPolicy is being created.", "BackupPolicy is available for use.", "BackupPolicy is being deleted.", "BackupPolicy is not valid and cannot be used.", "BackupPolicy is being updated." ], "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING", "ERROR", "UPDATING" ] }, "enabled": { "description": "If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.", "type": "boolean" }, "labels": { "description": "Resource labels to represent user provided metadata.", "type": "object", "additionalProperties": { "type": "string" } } } }, "BackupRetentionPolicy": { "description": "Retention policy for backups in the backup vault", "type": "object", "properties": { "dailyBackupImmutable": { "description": "Optional. Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", "type": "boolean" }, "weeklyBackupImmutable": { "description": "Optional. Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", "type": "boolean" }, "monthlyBackupImmutable": { "description": "Optional. Indicates if the monthly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", "type": "boolean" }, "backupMinimumEnforcedRetentionDays": { "description": "Required. Minimum retention duration in days for backups in the backup vault.", "type": "integer", "format": "int32" }, "manualBackupImmutable": { "description": "Optional. Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", "type": "boolean" } }, "id": "BackupRetentionPolicy" }, "DailySchedule": { "description": "Make a snapshot every day e.g. at 04:00, 05:20, 23:50", "type": "object", "properties": { "minute": { "description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", "type": "number", "format": "double" }, "hour": { "format": "double", "description": "Set the hour to start the snapshot (0-23), defaults to midnight (0).", "type": "number" }, "snapshotsToKeep": { "format": "double", "description": "The maximum number of Snapshots to keep for the hourly schedule", "type": "number" } }, "id": "DailySchedule" }, "MonthlySchedule": { "description": "Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50", "type": "object", "properties": { "snapshotsToKeep": { "description": "The maximum number of Snapshots to keep for the hourly schedule", "type": "number", "format": "double" }, "minute": { "format": "double", "description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", "type": "number" }, "hour": { "description": "Set the hour to start the snapshot (0-23), defaults to midnight (0).", "type": "number", "format": "double" }, "daysOfMonth": { "description": "Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.", "type": "string" } }, "id": "MonthlySchedule" }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "BackupVault": { "description": "A NetApp BackupVault.", "type": "object", "properties": { "name": { "description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", "type": "string" }, "sourceBackupVault": { "readOnly": true, "description": "Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", "type": "string" }, "crossProjectVault": { "description": "Optional. Indicates if the backup vault is a cross project vault.", "type": "boolean" }, "description": { "description": "Description of the backup vault.", "type": "string" }, "backupRetentionPolicy": { "$ref": "BackupRetentionPolicy", "description": "Optional. Backup retention policy defining the retention of backups." }, "labels": { "description": "Resource labels to represent user provided metadata.", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "description": "Output only. The backup vault state.", "enumDescriptions": [ "State not set.", "BackupVault is being created.", "BackupVault is available for use.", "BackupVault is being deleted.", "BackupVault is not valid and cannot be used.", "BackupVault is being updated." ], "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING", "ERROR", "UPDATING" ] }, "backupsCryptoKeyVersion": { "readOnly": true, "description": "Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`", "type": "string" }, "createTime": { "description": "Output only. Create time of the backup vault.", "type": "string", "readOnly": true, "format": "google-datetime" }, "sourceRegion": { "description": "Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`", "type": "string", "readOnly": true }, "backupRegion": { "description": "Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`", "type": "string" }, "encryptionState": { "type": "string", "enum": [ "ENCRYPTION_STATE_UNSPECIFIED", "ENCRYPTION_STATE_PENDING", "ENCRYPTION_STATE_COMPLETED", "ENCRYPTION_STATE_IN_PROGRESS", "ENCRYPTION_STATE_FAILED" ], "description": "Output only. Field indicating encryption state of CMEK backups.", "enumDescriptions": [ "Encryption state not set.", "Encryption state is pending.", "Encryption is complete.", "Encryption is in progress.", "Encryption has failed." ], "readOnly": true }, "kmsConfig": { "description": "Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "type": "string" }, "backupVaultType": { "description": "Optional. Type of backup vault to be created. Default is IN_REGION.", "type": "string", "enumDescriptions": [ "BackupVault type not set.", "BackupVault type is IN_REGION.", "BackupVault type is CROSS_REGION." ], "enum": [ "BACKUP_VAULT_TYPE_UNSPECIFIED", "IN_REGION", "CROSS_REGION" ] }, "destinationBackupVault": { "readOnly": true, "description": "Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", "type": "string" } }, "id": "BackupVault" }, "KmsConfig": { "id": "KmsConfig", "description": "KmsConfig is the customer-managed encryption key(CMEK) configuration.", "type": "object", "properties": { "cryptoKeyName": { "description": "Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels as key value pairs", "type": "object" }, "serviceAccount": { "description": "Output only. The Service account which will have access to the customer provided encryption key.", "type": "string", "readOnly": true }, "state": { "enum": [ "STATE_UNSPECIFIED", "READY", "CREATING", "DELETING", "UPDATING", "IN_USE", "ERROR", "KEY_CHECK_PENDING", "KEY_NOT_REACHABLE", "DISABLING", "DISABLED", "MIGRATING" ], "type": "string", "readOnly": true, "description": "Output only. State of the KmsConfig.", "enumDescriptions": [ "Unspecified KmsConfig State", "KmsConfig State is Ready", "KmsConfig State is Creating", "KmsConfig State is Deleting", "KmsConfig State is Updating", "KmsConfig State is In Use.", "KmsConfig State is Error", "KmsConfig State is Pending to verify crypto key access.", "KmsConfig State is Not accessbile by the SDE service account to the crypto key.", "KmsConfig State is Disabling.", "KmsConfig State is Disabled.", "KmsConfig State is Migrating. The existing volumes are migrating from SMEK to CMEK." ] }, "name": { "description": "Identifier. Name of the `KmsConfig`. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Create time of the KmsConfig.", "type": "string" }, "stateDetails": { "readOnly": true, "description": "Output only. State details of the KmsConfig.", "type": "string" }, "instructions": { "description": "Output only. Instructions to provide the access to the customer provided encryption key.", "type": "string", "readOnly": true }, "description": { "description": "Description of the KmsConfig.", "type": "string" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } } }, "CacheParameters": { "description": "Cache Parameters for the volume.", "type": "object", "properties": { "passphrase": { "readOnly": true, "description": "Output only. Temporary passphrase generated to accept cluster peering command.", "type": "string" }, "command": { "description": "Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.", "type": "string", "readOnly": true }, "peerVolumeName": { "description": "Required. Name of the origin volume for the cache volume.", "type": "string" }, "cacheConfig": { "$ref": "CacheConfig", "description": "Optional. Configuration of the cache volume." }, "peerIpAddresses": { "description": "Required. List of IC LIF addresses of the origin volume's ONTAP cluster.", "type": "array", "items": { "type": "string" } }, "peerClusterName": { "description": "Required. Name of the origin volume's ONTAP cluster.", "type": "string" }, "enableGlobalFileLock": { "description": "Optional. Indicates whether the cache volume has global file lock enabled.", "type": "boolean" }, "peerSvmName": { "description": "Required. Name of the origin volume's SVM.", "type": "string" }, "peeringCommandExpiryTime": { "description": "Optional. Expiration time for the peering command to be executed on user's ONTAP.", "type": "string", "format": "google-datetime" }, "stateDetails": { "description": "Output only. Detailed description of the current cache state.", "type": "string", "readOnly": true }, "cacheState": { "enum": [ "CACHE_STATE_UNSPECIFIED", "PENDING_CLUSTER_PEERING", "PENDING_SVM_PEERING", "PEERED", "ERROR" ], "type": "string", "readOnly": true, "description": "Output only. State of the cache volume indicating the peering status.", "enumDescriptions": [ "Default unspecified state.", "State indicating waiting for cluster peering to be established.", "State indicating waiting for SVM peering to be established.", "State indicating successful establishment of peering with origin volumes's ONTAP cluster.", "Terminal state wherein peering with origin volume's ONTAP cluster has failed." ] } }, "id": "CacheParameters" }, "VerifyKmsConfigRequest": { "id": "VerifyKmsConfigRequest", "description": "VerifyKmsConfigRequest specifies the KMS config to be validated.", "type": "object", "properties": {} }, "HybridPeeringDetails": { "description": "HybridPeeringDetails contains details about the hybrid peering.", "type": "object", "properties": { "command": { "readOnly": true, "description": "Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.", "type": "string" }, "peerClusterName": { "readOnly": true, "description": "Output only. Name of the user's local source cluster to be peered with the destination cluster.", "type": "string" }, "passphrase": { "description": "Output only. Temporary passphrase generated to accept cluster peering command.", "type": "string", "readOnly": true }, "subnetIp": { "readOnly": true, "description": "Output only. IP address of the subnet.", "type": "string" }, "commandExpiryTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Expiration time for the peering command to be executed on user's ONTAP.", "type": "string" }, "peerSvmName": { "readOnly": true, "description": "Output only. Name of the user's local source vserver svm to be peered with the destination vserver svm.", "type": "string" }, "peerVolumeName": { "description": "Output only. Name of the user's local source volume to be peered with the destination volume.", "type": "string", "readOnly": true } }, "id": "HybridPeeringDetails" }, "ListSnapshotsResponse": { "description": "ListSnapshotsResponse is the result of ListSnapshotsRequest.", "type": "object", "properties": { "nextPageToken": { "description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "snapshots": { "description": "A list of snapshots in the project for the specified volume.", "type": "array", "items": { "$ref": "Snapshot" } } }, "id": "ListSnapshotsResponse" }, "StopReplicationRequest": { "id": "StopReplicationRequest", "description": "StopReplicationRequest stops a replication until resumed.", "type": "object", "properties": { "force": { "description": "Indicates whether to stop replication forcefully while data transfer is in progress. Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.", "type": "boolean" } } }, "UserCommands": { "id": "UserCommands", "description": "UserCommands contains the commands to be executed by the customer.", "type": "object", "properties": { "commands": { "description": "Output only. List of commands to be executed by the customer.", "type": "array", "readOnly": true, "items": { "type": "string" } } } }, "ReverseReplicationDirectionRequest": { "description": "ReverseReplicationDirectionRequest reverses direction of replication. Source becomes destination and destination becomes source.", "type": "object", "properties": {}, "id": "ReverseReplicationDirectionRequest" }, "CachePrePopulate": { "id": "CachePrePopulate", "description": "Pre-populate cache volume with data from the origin volume.", "type": "object", "properties": { "recursion": { "description": "Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated.", "type": "boolean" }, "pathList": { "description": "Optional. List of directory-paths to be pre-populated for the FlexCache volume.", "type": "array", "items": { "type": "string" } }, "excludePathList": { "items": { "type": "string" }, "description": "Optional. List of directory-paths to be excluded for pre-population for the FlexCache volume.", "type": "array" } } }, "MountOption": { "description": "View only mount options for a volume.", "type": "object", "properties": { "exportFull": { "description": "Full export string", "type": "string" }, "instructions": { "description": "Instructions for mounting", "type": "string" }, "export": { "description": "Export string", "type": "string" }, "protocol": { "description": "Protocol to mount with.", "type": "string", "enumDescriptions": [ "Unspecified protocol", "NFS V3 protocol", "NFS V4 protocol", "SMB protocol", "ISCSI protocol", "NVMe protocol" ], "enum": [ "PROTOCOLS_UNSPECIFIED", "NFSV3", "NFSV4", "SMB", "ISCSI", "NVME" ] }, "ipAddress": { "readOnly": true, "description": "Output only. IP Address.", "type": "string" } }, "id": "MountOption" }, "EstablishVolumePeeringRequest": { "id": "EstablishVolumePeeringRequest", "description": "EstablishVolumePeeringRequest establishes cluster and svm peerings between the source and destination clusters.", "type": "object", "properties": { "peerVolumeName": { "description": "Required. Name of the user's local source volume to be peered with the destination volume.", "type": "string" }, "peerSvmName": { "description": "Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.", "type": "string" }, "peerClusterName": { "description": "Required. Name of the user's local source cluster to be peered with the destination cluster.", "type": "string" }, "peerIpAddresses": { "items": { "type": "string" }, "description": "Optional. List of IPv4 IP addresses to be used for peering.", "type": "array" } } }, "QuotaRule": { "id": "QuotaRule", "description": "QuotaRule specifies the maximum disk space a user or group can use within a volume. They can be used for creating default and individual quota rules.", "type": "object", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "UPDATING", "DELETING", "READY", "ERROR" ], "type": "string", "readOnly": true, "description": "Output only. State of the quota rule", "enumDescriptions": [ "Unspecified state for quota rule", "Quota rule is creating", "Quota rule is updating", "Quota rule is deleting", "Quota rule is ready", "Quota rule is in error state." ] }, "labels": { "description": "Optional. Labels of the quota rule", "type": "object", "additionalProperties": { "type": "string" } }, "stateDetails": { "readOnly": true, "description": "Output only. State details of the quota rule", "type": "string" }, "type": { "enum": [ "TYPE_UNSPECIFIED", "INDIVIDUAL_USER_QUOTA", "INDIVIDUAL_GROUP_QUOTA", "DEFAULT_USER_QUOTA", "DEFAULT_GROUP_QUOTA" ], "description": "Required. The type of quota rule.", "type": "string", "enumDescriptions": [ "Unspecified type for quota rule", "Individual user quota rule", "Individual group quota rule", "Default user quota rule", "Default group quota rule" ] }, "target": { "description": "Optional. The quota rule applies to the specified user or group, identified by a Unix UID/GID, Windows SID, or null for default.", "type": "string" }, "name": { "description": "Identifier. The resource name of the quota rule. Format: `projects/{project_number}/locations/{location_id}/volumes/volumes/{volume_id}/quotaRules/{quota_rule_id}`.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Create time of the quota rule", "type": "string" }, "diskLimitMib": { "format": "int32", "description": "Required. The maximum allowed disk space in MiB.", "type": "integer" }, "description": { "description": "Optional. Description of the quota rule", "type": "string" } } }, "ResumeReplicationRequest": { "id": "ResumeReplicationRequest", "description": "ResumeReplicationRequest resumes a stopped replication.", "type": "object", "properties": {} }, "SimpleExportPolicyRule": { "id": "SimpleExportPolicyRule", "description": "An export policy rule describing various export options.", "type": "object", "properties": { "squashMode": { "description": "Optional. Defines how user identity squashing is applied for this export rule. This field is the preferred way to configure squashing behavior and takes precedence over `has_root_access` if both are provided.", "type": "string", "enumDescriptions": [ "Defaults to `NO_ROOT_SQUASH`.", "The root user (UID 0) retains full access. Other users are unaffected.", "The root user (UID 0) is squashed to anonymous user ID. Other users are unaffected.", "All users are squashed to anonymous user ID." ], "enum": [ "SQUASH_MODE_UNSPECIFIED", "NO_ROOT_SQUASH", "ROOT_SQUASH", "ALL_SQUASH" ] }, "hasRootAccess": { "description": "Whether Unix root access will be granted.", "type": "string" }, "kerberos5ReadWrite": { "description": "If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.", "type": "boolean" }, "kerberos5iReadWrite": { "description": "If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.", "type": "boolean" }, "nfsv4": { "description": "NFS V4 protocol.", "type": "boolean" }, "anonUid": { "description": "Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`.", "type": "string", "format": "int64" }, "kerberos5ReadOnly": { "description": "If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.", "type": "boolean" }, "kerberos5iReadOnly": { "description": "If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.", "type": "boolean" }, "accessType": { "description": "Access type (ReadWrite, ReadOnly, None)", "type": "string", "enumDescriptions": [ "Unspecified Access Type", "Read Only", "Read Write", "None" ], "enum": [ "ACCESS_TYPE_UNSPECIFIED", "READ_ONLY", "READ_WRITE", "READ_NONE" ] }, "kerberos5pReadWrite": { "description": "If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.", "type": "boolean" }, "kerberos5pReadOnly": { "description": "If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.", "type": "boolean" }, "allowedClients": { "description": "Comma separated list of allowed clients IP addresses", "type": "string" }, "nfsv3": { "description": "NFS V3 protocol.", "type": "boolean" } } } }, "documentationLink": "https://cloud.google.com/netapp/", "endpoints": [ { "location": "africa-south1", "endpointUrl": "https://netapp.africa-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.asia-east1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-east1" }, { "endpointUrl": "https://netapp.asia-east2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-east2" }, { "endpointUrl": "https://netapp.asia-northeast1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-northeast1" }, { "endpointUrl": "https://netapp.asia-northeast2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-northeast2" }, { "endpointUrl": "https://netapp.asia-northeast3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-northeast3" }, { "endpointUrl": "https://netapp.asia-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-south1" }, { "location": "asia-south2", "endpointUrl": "https://netapp.asia-south2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-southeast1", "endpointUrl": "https://netapp.asia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-southeast2", "endpointUrl": "https://netapp.asia-southeast2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "australia-southeast1", "endpointUrl": "https://netapp.australia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "australia-southeast2", "endpointUrl": "https://netapp.australia-southeast2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.europe-central2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-central2" }, { "endpointUrl": "https://netapp.europe-north1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-north1" }, { "endpointUrl": "https://netapp.europe-north2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-north2" }, { "location": "europe-southwest1", "endpointUrl": "https://netapp.europe-southwest1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "europe-west1", "endpointUrl": "https://netapp.europe-west1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.europe-west10.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west10" }, { "endpointUrl": "https://netapp.europe-west12.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west12" }, { "location": "europe-west2", "endpointUrl": "https://netapp.europe-west2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "europe-west3", "endpointUrl": "https://netapp.europe-west3.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.europe-west4.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west4" }, { "location": "europe-west6", "endpointUrl": "https://netapp.europe-west6.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "europe-west8", "endpointUrl": "https://netapp.europe-west8.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.europe-west9.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west9" }, { "location": "me-central1", "endpointUrl": "https://netapp.me-central1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.me-central2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "me-central2" }, { "endpointUrl": "https://netapp.me-west1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "me-west1" }, { "location": "northamerica-northeast1", "endpointUrl": "https://netapp.northamerica-northeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "northamerica-northeast2", "endpointUrl": "https://netapp.northamerica-northeast2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "northamerica-south1", "endpointUrl": "https://netapp.northamerica-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "southamerica-east1", "endpointUrl": "https://netapp.southamerica-east1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "southamerica-west1", "endpointUrl": "https://netapp.southamerica-west1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.us-central1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-central1" }, { "endpointUrl": "https://netapp.us-east1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-east1" }, { "location": "us-east4", "endpointUrl": "https://netapp.us-east4.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.us-east5.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-east5" }, { "location": "us-east7", "endpointUrl": "https://netapp.us-east7.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.us-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-south1" }, { "endpointUrl": "https://netapp.us-west1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west1" }, { "endpointUrl": "https://netapp.us-west2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west2" }, { "endpointUrl": "https://netapp.us-west3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west3" }, { "endpointUrl": "https://netapp.us-west4.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west4" } ], "discoveryVersion": "v1", "title": "NetApp API", "version": "v1beta1", "id": "netapp:v1beta1", "revision": "20260614", "servicePath": "", "parameters": { "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "$.xgafv": { "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "enum": [ "1", "2" ], "type": "string" }, "prettyPrint": { "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "alt": { "type": "string", "enum": [ "json", "media", "proto" ], "location": "query", "description": "Data format for response.", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] } }, "ownerName": "Google", "protocol": "rest", "fullyEncodeReservedExpansion": true, "ownerDomain": "google.com", "baseUrl": "https://netapp.googleapis.com/", "kind": "discovery#restDescription", "batchPath": "batch", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "basePath": "", "rootUrl": "https://netapp.googleapis.com/", "canonicalName": "NetApp Files", "version_module": true, "mtlsRootUrl": "https://netapp.mtls.googleapis.com/" }