{ "title": "NetApp API", "parameters": { "alt": { "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" ], "type": "string", "enum": [ "json", "media", "proto" ], "description": "Data format for response.", "location": "query" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "prettyPrint": { "type": "boolean", "location": "query", "default": "true", "description": "Returns response with indentations and line breaks." }, "key": { "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.", "type": "string", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "quotaUser": { "type": "string", "location": "query", "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." }, "$.xgafv": { "description": "V1 error format.", "location": "query", "type": "string", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." } }, "batchPath": "batch", "schemas": { "OntapSource": { "id": "OntapSource", "type": "object", "description": "Represents ONTAP source details.", "properties": { "volumeUuid": { "description": "Required. The UUID of the ONTAP source volume.", "type": "string" }, "snapshotUuid": { "description": "Optional. The UUID of the ONTAP source snapshot.", "type": "string" }, "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" } } }, "HybridReplicationParameters": { "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels to be added to the replication as the key value pairs." }, "replicationSchedule": { "enumDescriptions": [ "Unspecified HybridReplicationSchedule", "Replication happens once every 10 minutes.", "Replication happens once every hour.", "Replication happens once every day." ], "type": "string", "enum": [ "HYBRID_REPLICATION_SCHEDULE_UNSPECIFIED", "EVERY_10_MINUTES", "HOURLY", "DAILY" ], "description": "Optional. Replication Schedule for the replication created." }, "peerVolumeName": { "description": "Required. Name of the user's local source volume to be peered with the destination volume.", "type": "string" }, "description": { "description": "Optional. Description of the replication.", "type": "string" }, "peerSvmName": { "description": "Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.", "type": "string" }, "peerIpAddresses": { "items": { "type": "string" }, "description": "Required. List of node ip addresses to be peered with.", "type": "array" }, "hybridReplicationType": { "type": "string", "enum": [ "VOLUME_HYBRID_REPLICATION_TYPE_UNSPECIFIED", "MIGRATION", "CONTINUOUS_REPLICATION", "ONPREM_REPLICATION", "REVERSE_ONPREM_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.", "New field for reversible OnPrem replication, to be used for data protection." ], "description": "Optional. Type of the hybrid replication." }, "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" }, "peerClusterName": { "description": "Required. Name of the user's local source cluster to be peered with the destination cluster.", "type": "string" }, "largeVolumeConstituentCount": { "description": "Optional. Constituent volume count for large volume.", "type": "integer", "format": "int32" }, "replication": { "description": "Required. Desired name for the replication of this volume.", "type": "string" } }, "description": "The Hybrid Replication parameters for the volume.", "id": "HybridReplicationParameters", "type": "object" }, "ListSnapshotsResponse": { "id": "ListSnapshotsResponse", "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.", "items": { "$ref": "Snapshot" }, "type": "array" } }, "description": "ListSnapshotsResponse is the result of ListSnapshotsRequest." }, "KmsConfig": { "properties": { "state": { "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." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "READY", "CREATING", "DELETING", "UPDATING", "IN_USE", "ERROR", "KEY_CHECK_PENDING", "KEY_NOT_REACHABLE", "DISABLING", "DISABLED", "MIGRATING" ], "description": "Output only. State of the KmsConfig.", "readOnly": true }, "name": { "description": "Identifier. Name of the `KmsConfig`. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "type": "string" }, "cryptoKeyName": { "description": "Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`", "type": "string" }, "instructions": { "type": "string", "description": "Output only. Instructions to provide the access to the customer provided encryption key.", "readOnly": true }, "description": { "description": "Description of the KmsConfig.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Create time of the KmsConfig.", "readOnly": true }, "stateDetails": { "type": "string", "description": "Output only. State details of the KmsConfig.", "readOnly": true }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Labels as key value pairs" }, "serviceAccount": { "description": "Output only. The Service account which will have access to the customer provided encryption key.", "readOnly": true, "type": "string" } }, "description": "KmsConfig is the customer-managed encryption key(CMEK) configuration.", "id": "KmsConfig", "type": "object" }, "Snapshot": { "id": "Snapshot", "type": "object", "description": "Snapshot is a point-in-time version of a Volume's content.", "properties": { "stateDetails": { "description": "Output only. State details of the storage pool", "readOnly": true, "type": "string" }, "labels": { "description": "Resource labels to represent user provided metadata.", "type": "object", "additionalProperties": { "type": "string" } }, "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" ], "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" ], "description": "Output only. The snapshot state.", "readOnly": true }, "usedBytes": { "description": "Output only. Current storage usage for the snapshot in bytes.", "readOnly": true, "format": "double", "type": "number" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time when the snapshot was created.", "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" } } }, "SnapshotPolicy": { "properties": { "enabled": { "description": "If enabled, make snapshots automatically according to the schedules. Default is false.", "type": "boolean" }, "weeklySchedule": { "description": "Weekly schedule policy.", "$ref": "WeeklySchedule" }, "dailySchedule": { "description": "Daily schedule policy.", "$ref": "DailySchedule" }, "monthlySchedule": { "description": "Monthly schedule policy.", "$ref": "MonthlySchedule" }, "hourlySchedule": { "description": "Hourly schedule policy.", "$ref": "HourlySchedule" } }, "description": "Snapshot Policy for a volume.", "id": "SnapshotPolicy", "type": "object" }, "CacheConfig": { "properties": { "cachePrePopulate": { "description": "Optional. Pre-populate cache volume with data from the origin volume.", "$ref": "CachePrePopulate" }, "writebackEnabled": { "description": "Optional. Flag indicating whether writeback is enabled for the FlexCache volume.", "type": "boolean" }, "cifsChangeNotifyEnabled": { "description": "Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume.", "type": "boolean" }, "cachePrePopulateState": { "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." ], "type": "string", "enum": [ "CACHE_PRE_POPULATE_STATE_UNSPECIFIED", "NOT_NEEDED", "IN_PROGRESS", "COMPLETE", "ERROR" ], "description": "Output only. State of the prepopulation job indicating how the prepopulation is progressing.", "readOnly": true } }, "description": "Configuration of the cache volume.", "id": "CacheConfig", "type": "object" }, "ListBackupsResponse": { "properties": { "backups": { "description": "A list of backups in the project.", "items": { "$ref": "Backup" }, "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": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } } }, "description": "ListBackupsResponse is the result of ListBackupsRequest.", "id": "ListBackupsResponse", "type": "object" }, "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.", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels of the quota rule" }, "stateDetails": { "description": "Output only. State details of the quota rule", "readOnly": true, "type": "string" }, "description": { "description": "Optional. Description of the quota rule", "type": "string" }, "createTime": { "description": "Output only. Create time of the quota rule", "readOnly": true, "format": "google-datetime", "type": "string" }, "type": { "description": "Required. The type of quota rule.", "enumDescriptions": [ "Unspecified type for quota rule", "Individual user quota rule", "Individual group quota rule", "Default user quota rule", "Default group quota rule" ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "INDIVIDUAL_USER_QUOTA", "INDIVIDUAL_GROUP_QUOTA", "DEFAULT_USER_QUOTA", "DEFAULT_GROUP_QUOTA" ] }, "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" }, "diskLimitMib": { "type": "integer", "format": "int32", "description": "Required. The maximum allowed disk space in MiB." }, "state": { "description": "Output only. State of the quota rule", "readOnly": true, "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." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "UPDATING", "DELETING", "READY", "ERROR" ] } }, "id": "QuotaRule", "type": "object" }, "ActiveDirectory": { "id": "ActiveDirectory", "type": "object", "description": "ActiveDirectory is the public representation of the active directory config.", "properties": { "dns": { "description": "Required. Comma separated list of DNS server IP addresses for the Active Directory domain.", "type": "string" }, "username": { "description": "Required. Username of the Active Directory domain administrator.", "type": "string" }, "kdcIp": { "description": "KDC server IP address for the active directory machine.", "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" }, "aesEncryption": { "description": "If enabled, AES encryption will be enabled for SMB communication.", "type": "boolean" }, "encryptDcConnections": { "description": "If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.", "type": "boolean" }, "backupOperators": { "description": "Optional. Users to be added to the Built-in Backup Operator active directory group.", "items": { "type": "string" }, "type": "array" }, "ldapSigning": { "description": "Specifies whether or not the LDAP traffic needs to be signed.", "type": "boolean" }, "description": { "description": "Description of the active directory.", "type": "string" }, "organizationalUnit": { "description": "The Organizational Unit (OU) within the Windows Active Directory the user belongs to.", "type": "string" }, "netBiosPrefix": { "description": "Required. NetBIOSPrefix is used as a prefix for SMB server name.", "type": "string" }, "securityOperators": { "items": { "type": "string" }, "description": "Optional. Domain users to be given the SeSecurityPrivilege.", "type": "array" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Labels for the active directory." }, "state": { "description": "Output only. The state of the AD.", "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "IN_USE", "DELETING", "ERROR", "DIAGNOSING" ], "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." ] }, "site": { "description": "The Active Directory site the service will limit Domain Controller discovery too.", "type": "string" }, "administrators": { "description": "Optional. Users to be added to the Built-in Admininstrators group.", "items": { "type": "string" }, "type": "array" }, "kdcHostname": { "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", "type": "string" }, "domain": { "description": "Required. Name of the Active Directory domain", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Create time of the active directory.", "readOnly": true }, "password": { "description": "Required. Password of the Active Directory domain administrator.", "type": "string" }, "stateDetails": { "description": "Output only. The state details of the Active Directory.", "readOnly": true, "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" } } }, "HybridPeeringDetails": { "properties": { "peerVolumeName": { "description": "Output only. Name of the user's local source volume to be peered with the destination volume.", "readOnly": true, "type": "string" }, "passphrase": { "type": "string", "description": "Output only. Temporary passphrase generated to accept cluster peering command.", "readOnly": true }, "peerClusterName": { "description": "Output only. Name of the user's local source cluster to be peered with the destination cluster.", "readOnly": true, "type": "string" }, "peerSvmName": { "description": "Output only. Name of the user's local source vserver svm to be peered with the destination vserver svm.", "readOnly": true, "type": "string" }, "subnetIp": { "description": "Output only. IP address of the subnet.", "readOnly": true, "type": "string" }, "commandExpiryTime": { "type": "string", "format": "google-datetime", "description": "Output only. Expiration time for the peering command to be executed on user's ONTAP.", "readOnly": true }, "command": { "description": "Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.", "readOnly": true, "type": "string" } }, "description": "HybridPeeringDetails contains details about the hybrid peering.", "id": "HybridPeeringDetails", "type": "object" }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "properties": {}, "id": "CancelOperationRequest", "type": "object" }, "Backup": { "id": "Backup", "type": "object", "properties": { "satisfiesPzs": { "type": "boolean", "description": "Output only. Reserved for future use", "readOnly": true }, "state": { "description": "Output only. The backup state.", "readOnly": true, "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." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "UPLOADING", "READY", "DELETING", "ERROR", "UPDATING" ] }, "enforcedRetentionEndTime": { "description": "Output only. The time until which the backup is not deletable.", "readOnly": true, "type": "string", "format": "google-datetime" }, "ontapSource": { "description": "Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided.", "$ref": "OntapSource" }, "backupType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "MANUAL", "SCHEDULED" ], "enumDescriptions": [ "Unspecified backup type.", "Manual backup type.", "Scheduled backup type." ], "description": "Output only. Type of backup, manually created or created by a backup policy.", "readOnly": true }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time when the backup was created.", "readOnly": true }, "chainStorageBytes": { "format": "int64", "type": "string", "description": "Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)", "readOnly": true }, "backupRegion": { "type": "string", "description": "Output only. Region in which backup is stored. Format: `projects/{project_id}/locations/{location}`", "readOnly": true }, "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" }, "name": { "description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", "type": "string" }, "volumeUsageBytes": { "format": "int64", "type": "string", "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.", "readOnly": true }, "volumeRegion": { "type": "string", "description": "Output only. Region of the volume from which the backup was created. Format: `projects/{project_id}/locations/{location}`", "readOnly": true }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Reserved for future use", "readOnly": true }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource labels to represent user provided metadata." }, "description": { "description": "A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.", "type": "string" }, "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" } }, "description": "A NetApp Backup." }, "ListHostGroupsResponse": { "description": "ListHostGroupsResponse is the response to a ListHostGroupsRequest.", "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "hostGroups": { "type": "array", "items": { "$ref": "HostGroup" }, "description": "The list of host groups." }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } } }, "id": "ListHostGroupsResponse", "type": "object" }, "ListActiveDirectoriesResponse": { "properties": { "activeDirectories": { "type": "array", "description": "The list of active directories.", "items": { "$ref": "ActiveDirectory" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" } }, "description": "ListActiveDirectoriesResponse contains all the active directories requested.", "id": "ListActiveDirectoriesResponse", "type": "object" }, "ReverseReplicationDirectionRequest": { "description": "ReverseReplicationDirectionRequest reverses direction of replication. Source becomes destination and destination becomes source.", "properties": {}, "id": "ReverseReplicationDirectionRequest", "type": "object" }, "Replication": { "id": "Replication", "type": "object", "description": "Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.", "properties": { "clusterLocation": { "description": "Optional. Location of the user cluster.", "type": "string" }, "transferStats": { "$ref": "TransferStats", "description": "Output only. Replication transfer statistics.", "readOnly": true }, "destinationVolume": { "type": "string", "description": "Output only. Full name of destination volume resource. Example : \"projects/{project}/locations/{location}/volumes/{volume_id}\"", "readOnly": true }, "state": { "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." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "DELETING", "ERROR", "PENDING_CLUSTER_PEERING", "PENDING_SVM_PEERING", "PENDING_REMOTE_RESYNC", "EXTERNALLY_MANAGED_REPLICATION" ], "description": "Output only. State of the replication.", "readOnly": true }, "replicationSchedule": { "enumDescriptions": [ "Unspecified ReplicationSchedule", "Replication happens once every 10 minutes.", "Replication happens once every hour.", "Replication happens once every day." ], "type": "string", "enum": [ "REPLICATION_SCHEDULE_UNSPECIFIED", "EVERY_10_MINUTES", "HOURLY", "DAILY" ], "description": "Required. Indicates the schedule for replication." }, "mirrorState": { "type": "string", "enum": [ "MIRROR_STATE_UNSPECIFIED", "PREPARING", "MIRRORED", "STOPPED", "TRANSFERRING", "BASELINE_TRANSFERRING", "ABORTED", "EXTERNALLY_MANAGED", "PENDING_PEERING" ], "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." ], "description": "Output only. Indicates the state of mirroring.", "readOnly": true }, "stateDetails": { "description": "Output only. State details of the replication.", "readOnly": true, "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Replication create time.", "readOnly": true }, "destinationVolumeParameters": { "description": "Required. Input only. Destination volume parameters", "$ref": "DestinationVolumeParameters" }, "hybridReplicationUserCommands": { "description": "Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.", "readOnly": true, "$ref": "UserCommands" }, "role": { "enumDescriptions": [ "Unspecified replication role", "Indicates Source volume.", "Indicates Destination volume." ], "type": "string", "enum": [ "REPLICATION_ROLE_UNSPECIFIED", "SOURCE", "DESTINATION" ], "description": "Output only. Indicates whether this points to source or destination.", "readOnly": true }, "healthy": { "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.", "readOnly": true, "type": "boolean" }, "sourceVolume": { "description": "Output only. Full name of source volume resource. Example : \"projects/{project}/locations/{location}/volumes/{volume_id}\"", "readOnly": true, "type": "string" }, "hybridReplicationType": { "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)" ], "type": "string", "enum": [ "HYBRID_REPLICATION_TYPE_UNSPECIFIED", "MIGRATION", "CONTINUOUS_REPLICATION", "ONPREM_REPLICATION", "REVERSE_ONPREM_REPLICATION" ], "description": "Output only. Type of the hybrid replication.", "readOnly": true }, "name": { "description": "Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.", "type": "string" }, "hybridPeeringDetails": { "$ref": "HybridPeeringDetails", "description": "Output only. Hybrid peering details.", "readOnly": true }, "labels": { "description": "Resource labels to represent user provided metadata.", "type": "object", "additionalProperties": { "type": "string" } }, "description": { "description": "A description about this replication relationship.", "type": "string" } } }, "SyncReplicationRequest": { "properties": {}, "description": "SyncReplicationRequest syncs the replication from source to destination.", "id": "SyncReplicationRequest", "type": "object" }, "HostGroup": { "id": "HostGroup", "type": "object", "properties": { "type": { "description": "Required. Type of the host group.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "ISCSI_INITIATOR" ], "enumDescriptions": [ "Unspecified type for host group.", "iSCSI initiator host group." ] }, "labels": { "description": "Optional. Labels of the host group.", "type": "object", "additionalProperties": { "type": "string" } }, "hosts": { "items": { "type": "string" }, "description": "Required. The list of hosts associated with the host group.", "type": "array" }, "name": { "description": "Identifier. The resource name of the host group. Format: `projects/{project_number}/locations/{location_id}/hostGroups/{host_group_id}`.", "type": "string" }, "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", "enum": [ "OS_TYPE_UNSPECIFIED", "LINUX", "WINDOWS", "ESXI" ], "enumDescriptions": [ "Unspecified OS Type", "OS Type is Linux", "OS Type is Windows", "OS Type is VMware ESXi" ] }, "description": { "description": "Optional. Description of the host group.", "type": "string" }, "state": { "description": "Output only. State of the host group.", "readOnly": true, "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." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "DELETING", "DISABLED" ] }, "createTime": { "description": "Output only. Create time of the host group.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "description": "Host group is a collection of hosts that can be used for accessing a Block Volume." }, "Location": { "id": "Location", "type": "object", "properties": { "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "type": "object", "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." }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" } }, "description": "A resource that represents a Google Cloud location." }, "TieringPolicy": { "properties": { "coolingThresholdDays": { "type": "integer", "format": "int32", "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." }, "tierAction": { "description": "Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.", "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." ], "type": "string", "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" } }, "description": "Defines tiering policy for the volume.", "id": "TieringPolicy", "type": "object" }, "ListStoragePoolsResponse": { "id": "ListStoragePoolsResponse", "type": "object", "description": "ListStoragePoolsResponse is the response to a ListStoragePoolsRequest.", "properties": { "storagePools": { "description": "The list of StoragePools", "items": { "$ref": "StoragePool" }, "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } } }, "StoragePool": { "id": "StoragePool", "type": "object", "properties": { "scaleType": { "description": "Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified.", "type": "string", "enum": [ "SCALE_TYPE_UNSPECIFIED", "SCALE_TYPE_DEFAULT", "SCALE_TYPE_SCALEOUT" ], "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." ] }, "network": { "description": "Required. VPC Network name. Format: projects/{project}/global/networks/{network}", "type": "string" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "READY", "CREATING", "DELETING", "UPDATING", "RESTORING", "DISABLED", "ERROR" ], "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" ], "description": "Output only. State of the storage pool", "readOnly": true }, "activeDirectory": { "description": "Optional. Specifies the Active Directory to be used for creating a SMB volume.", "type": "string" }, "satisfiesPzs": { "type": "boolean", "description": "Output only. Reserved for future use", "readOnly": true }, "totalThroughputMibps": { "type": "string", "format": "int64", "description": "Optional. Custom Performance Total Throughput of the pool (in MiBps)" }, "zone": { "description": "Optional. Specifies the active zone for regional storagePool.", "type": "string" }, "createTime": { "description": "Output only. Create time of the storage pool", "readOnly": true, "type": "string", "format": "google-datetime" }, "capacityGib": { "type": "string", "format": "int64", "description": "Required. Capacity in GIB of the pool" }, "globalAccessAllowed": { "type": "boolean", "deprecated": true, "description": "Deprecated. Used to allow SO pool to access AD or DNS server from other regions." }, "name": { "description": "Identifier. Name of the storage pool", "type": "string" }, "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", "enum": [ "MODE_UNSPECIFIED", "DEFAULT", "ONTAP" ], "enumDescriptions": [ "The `Mode` is not specified.", "The resource is managed by the GCNV APIs.", "The resource is managed by the GCNV ONTAP Mode APIs." ] }, "ldapEnabled": { "description": "Optional. Flag indicating if the pool is NFS LDAP enabled or not.", "type": "boolean" }, "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" }, "hotTierSizeGib": { "type": "string", "format": "int64", "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." }, "totalIops": { "description": "Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps", "format": "int64", "type": "string" }, "encryptionType": { "description": "Output only. Specifies the current pool encryption key source.", "readOnly": true, "type": "string", "enum": [ "ENCRYPTION_TYPE_UNSPECIFIED", "SERVICE_MANAGED", "CLOUD_KMS" ], "enumDescriptions": [ "The source of the encryption key is not specified.", "Google managed encryption key.", "Customer managed encryption key, which is stored in KMS." ] }, "availableThroughputMibps": { "description": "Output only. Available throughput of the storage pool (in MiB/s).", "readOnly": true, "format": "double", "type": "number" }, "volumeCount": { "description": "Output only. Volume count of the storage pool", "readOnly": true, "format": "int32", "type": "integer" }, "serviceLevel": { "description": "Required. Service level of the storage pool", "enumDescriptions": [ "Unspecified service level.", "Premium service level.", "Extreme service level.", "Standard service level.", "Flex service level." ], "type": "string", "enum": [ "SERVICE_LEVEL_UNSPECIFIED", "PREMIUM", "EXTREME", "STANDARD", "FLEX" ] }, "stateDetails": { "description": "Output only. State details of the storage pool", "readOnly": true, "type": "string" }, "hotTierSizeUsedGib": { "description": "Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.", "readOnly": true, "format": "int64", "type": "string" }, "customPerformanceEnabled": { "description": "Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false", "type": "boolean" }, "psaRange": { "description": "Optional. This field is not implemented. The values provided in this field are ignored.", "type": "string" }, "coldTierSizeUsedGib": { "description": "Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool.", "readOnly": true, "format": "int64", "type": "string" }, "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`.", "enumDescriptions": [ "Storage pool type is not specified.", "Storage pool type is file.", "Storage pool type is unified." ], "type": "string", "enum": [ "STORAGE_POOL_TYPE_UNSPECIFIED", "FILE", "UNIFIED" ] }, "qosType": { "type": "string", "enum": [ "QOS_TYPE_UNSPECIFIED", "AUTO", "MANUAL" ], "enumDescriptions": [ "Unspecified QoS Type", "QoS Type is Auto", "QoS Type is Manual" ], "description": "Optional. QoS (Quality of Service) Type of the storage pool" }, "volumeCapacityGib": { "description": "Output only. Allocated size of all volumes in GIB in the storage pool", "readOnly": true, "type": "string", "format": "int64" }, "labels": { "description": "Optional. Labels as key value pairs", "type": "object", "additionalProperties": { "type": "string" } }, "kmsConfig": { "description": "Optional. Specifies the KMS config to be used for volume encryption.", "type": "string" }, "replicaZone": { "description": "Optional. Specifies the replica zone for regional storagePool.", "type": "string" }, "satisfiesPzi": { "description": "Output only. Reserved for future use", "readOnly": true, "type": "boolean" }, "description": { "description": "Optional. Description of 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" } }, "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." }, "ValidateDirectoryServiceRequest": { "id": "ValidateDirectoryServiceRequest", "type": "object", "description": "ValidateDirectoryServiceRequest validates the directory service policy attached to the storage pool.", "properties": { "directoryServiceType": { "type": "string", "enum": [ "DIRECTORY_SERVICE_TYPE_UNSPECIFIED", "ACTIVE_DIRECTORY" ], "enumDescriptions": [ "Directory service type is not specified.", "Active directory policy attached to the storage pool." ], "description": "Type of directory service policy attached to the storage pool." } } }, "Status": { "id": "Status", "type": "object", "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).", "properties": { "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "type": "array" }, "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" } } }, "MountOption": { "description": "View only mount options for a volume.", "properties": { "protocol": { "enumDescriptions": [ "Unspecified protocol", "NFS V3 protocol", "NFS V4 protocol", "SMB protocol", "ISCSI protocol", "NVMe protocol" ], "type": "string", "enum": [ "PROTOCOLS_UNSPECIFIED", "NFSV3", "NFSV4", "SMB", "ISCSI", "NVME" ], "description": "Protocol to mount with." }, "exportFull": { "description": "Full export string", "type": "string" }, "instructions": { "description": "Instructions for mounting", "type": "string" }, "ipAddress": { "type": "string", "description": "Output only. IP Address.", "readOnly": true }, "export": { "description": "Export string", "type": "string" } }, "id": "MountOption", "type": "object" }, "BackupVault": { "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Create time of the backup vault.", "readOnly": true }, "backupRegion": { "description": "Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`", "type": "string" }, "backupVaultType": { "type": "string", "enum": [ "BACKUP_VAULT_TYPE_UNSPECIFIED", "IN_REGION", "CROSS_REGION" ], "enumDescriptions": [ "BackupVault type not set.", "BackupVault type is IN_REGION.", "BackupVault type is CROSS_REGION." ], "description": "Optional. Type of backup vault to be created. Default is IN_REGION." }, "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." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING", "ERROR", "UPDATING" ], "description": "Output only. The backup vault state.", "readOnly": true }, "encryptionState": { "enumDescriptions": [ "Encryption state not set.", "Encryption state is pending.", "Encryption is complete.", "Encryption is in progress.", "Encryption has failed." ], "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.", "readOnly": true }, "backupRetentionPolicy": { "description": "Optional. Backup retention policy defining the retention of backups.", "$ref": "BackupRetentionPolicy" }, "destinationBackupVault": { "type": "string", "description": "Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", "readOnly": true }, "sourceBackupVault": { "type": "string", "description": "Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", "readOnly": true }, "description": { "description": "Description of the backup vault.", "type": "string" }, "labels": { "description": "Resource labels to represent user provided metadata.", "type": "object", "additionalProperties": { "type": "string" } }, "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" }, "backupsCryptoKeyVersion": { "type": "string", "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}`", "readOnly": true }, "name": { "description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", "type": "string" }, "sourceRegion": { "description": "Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`", "readOnly": true, "type": "string" } }, "description": "A NetApp BackupVault.", "id": "BackupVault", "type": "object" }, "EstablishVolumePeeringRequest": { "properties": { "peerSvmName": { "description": "Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.", "type": "string" }, "peerIpAddresses": { "items": { "type": "string" }, "description": "Optional. List of IPv4 IP addresses to be used for peering.", "type": "array" }, "peerVolumeName": { "description": "Required. Name of the user's local source volume to be peered with the destination volume.", "type": "string" }, "peerClusterName": { "description": "Required. Name of the user's local source cluster to be peered with the destination cluster.", "type": "string" } }, "description": "EstablishVolumePeeringRequest establishes cluster and svm peerings between the source and destination clusters.", "id": "EstablishVolumePeeringRequest", "type": "object" }, "VerifyKmsConfigRequest": { "properties": {}, "description": "VerifyKmsConfigRequest specifies the KMS config to be validated.", "id": "VerifyKmsConfigRequest", "type": "object" }, "CachePrePopulate": { "properties": { "recursion": { "description": "Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated.", "type": "boolean" }, "excludePathList": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of directory-paths to be excluded for pre-population for the FlexCache volume." }, "pathList": { "items": { "type": "string" }, "description": "Optional. List of directory-paths to be pre-populated for the FlexCache volume.", "type": "array" } }, "description": "Pre-populate cache volume with data from the origin volume.", "id": "CachePrePopulate", "type": "object" }, "ExecuteOntapDeleteResponse": { "properties": { "body": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The raw `JSON` body of the response." } }, "description": "Response message for `ExecuteOntapDelete` API.", "id": "ExecuteOntapDeleteResponse", "type": "object" }, "ListVolumesResponse": { "description": "Message for response to listing Volumes", "properties": { "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "volumes": { "type": "array", "items": { "$ref": "Volume" }, "description": "The list of Volume" } }, "id": "ListVolumesResponse", "type": "object" }, "SimpleExportPolicyRule": { "id": "SimpleExportPolicyRule", "type": "object", "description": "An export policy rule describing various export options.", "properties": { "hasRootAccess": { "description": "Whether Unix root access will be granted.", "type": "string" }, "allowedClients": { "description": "Comma separated list of allowed clients IP addresses", "type": "string" }, "accessType": { "enumDescriptions": [ "Unspecified Access Type", "Read Only", "Read Write", "None" ], "type": "string", "enum": [ "ACCESS_TYPE_UNSPECIFIED", "READ_ONLY", "READ_WRITE", "READ_NONE" ], "description": "Access type (ReadWrite, ReadOnly, None)" }, "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" }, "nfsv3": { "description": "NFS V3 protocol.", "type": "boolean" }, "nfsv4": { "description": "NFS V4 protocol.", "type": "boolean" }, "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" }, "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" }, "anonUid": { "type": "string", "format": "int64", "description": "Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`." }, "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" }, "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.", "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." ], "type": "string", "enum": [ "SQUASH_MODE_UNSPECIFIED", "NO_ROOT_SQUASH", "ROOT_SQUASH", "ALL_SQUASH" ] }, "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" }, "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" } } }, "MonthlySchedule": { "description": "Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50", "properties": { "snapshotsToKeep": { "description": "The maximum number of Snapshots to keep for the hourly schedule", "format": "double", "type": "number" }, "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" }, "hour": { "type": "number", "format": "double", "description": "Set the hour to start the snapshot (0-23), defaults to midnight (0)." }, "minute": { "description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", "format": "double", "type": "number" } }, "id": "MonthlySchedule", "type": "object" }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" }, "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "description": "The response message for Locations.ListLocations." }, "BlockDevice": { "id": "BlockDevice", "type": "object", "description": "Block device represents the device(s) which are stored in the block volume.", "properties": { "osType": { "enumDescriptions": [ "Unspecified OS Type", "OS Type is Linux", "OS Type is Windows", "OS Type is VMware ESXi" ], "type": "string", "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." }, "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" }, "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.", "items": { "type": "string" }, "type": "array" }, "identifier": { "description": "Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes.", "readOnly": true, "type": "string" }, "sizeGib": { "type": "string", "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`." } } }, "UserCommands": { "description": "UserCommands contains the commands to be executed by the customer.", "properties": { "commands": { "type": "array", "description": "Output only. List of commands to be executed by the customer.", "readOnly": true, "items": { "type": "string" } } }, "id": "UserCommands", "type": "object" }, "ExecuteOntapPostRequest": { "id": "ExecuteOntapPostRequest", "type": "object", "description": "Request message for `ExecuteOntapPost` API.", "properties": { "body": { "type": "object", "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\", } } ```" } } }, "ExecuteOntapPostResponse": { "id": "ExecuteOntapPostResponse", "type": "object", "description": "Response message for `ExecuteOntapPost` API.", "properties": { "body": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The raw `JSON` body of the response." } } }, "DestinationVolumeParameters": { "id": "DestinationVolumeParameters", "type": "object", "description": "DestinationVolumeParameters specify input parameters used for creating destination volume.", "properties": { "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" }, "description": { "description": "Description for the destination volume.", "type": "string" }, "storagePool": { "description": "Required. Existing destination StoragePool name.", "type": "string" }, "shareName": { "description": "Destination volume's share name. If not specified, source volume's share name will be used.", "type": "string" }, "tieringPolicy": { "description": "Optional. Tiering policy for the volume.", "$ref": "TieringPolicy" } } }, "UpdateBackupConfigRequest": { "id": "UpdateBackupConfigRequest", "type": "object", "properties": { "volumeUuid": { "description": "Required. The UUID of the ONTAP-mode volume.", "type": "string" }, "backupConfig": { "description": "Required. Backup configuration to apply.", "$ref": "BackupConfig" }, "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.", "format": "google-fieldmask", "type": "string" } }, "description": "Request message for UpdateBackupConfig" }, "VerifyKmsConfigResponse": { "id": "VerifyKmsConfigResponse", "type": "object", "properties": { "instructions": { "type": "string", "description": "Output only. Instructions for the customers to provide the access to the encryption key.", "readOnly": true }, "healthy": { "type": "boolean", "description": "Output only. If the customer key configured correctly to the encrypt volume.", "readOnly": true }, "healthError": { "type": "string", "description": "Output only. Error message if config is not healthy.", "readOnly": true } }, "description": "VerifyKmsConfigResponse contains the information if the config is correctly and error message." }, "OntapVolumeTarget": { "id": "OntapVolumeTarget", "type": "object", "properties": { "volumeUuid": { "description": "Required. The UUID of the ONTAP volume to restore to.", "type": "string" }, "restoreDestinationPath": { "description": "Optional. Absolute directory path in the destination volume.", "type": "string" } }, "description": "Represents the ONTAP volume target of the restore operation." }, "RestoreParameters": { "id": "RestoreParameters", "type": "object", "description": "The RestoreParameters if volume is created from a snapshot or backup.", "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" } } }, "BackupConfig": { "properties": { "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" }, "backupPolicies": { "type": "array", "description": "Optional. When specified, schedule backups will be created based on the policy configuration.", "items": { "type": "string" } }, "backupChainBytes": { "description": "Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).", "readOnly": true, "format": "int64", "type": "string" } }, "description": "BackupConfig contains backup related config on a volume.", "id": "BackupConfig", "type": "object" }, "CacheParameters": { "description": "Cache Parameters for the volume.", "properties": { "enableGlobalFileLock": { "description": "Optional. Indicates whether the cache volume has global file lock enabled.", "type": "boolean" }, "command": { "type": "string", "description": "Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.", "readOnly": true }, "stateDetails": { "description": "Output only. Detailed description of the current cache state.", "readOnly": true, "type": "string" }, "peerVolumeName": { "description": "Required. Name of the origin volume for the cache volume.", "type": "string" }, "peeringCommandExpiryTime": { "type": "string", "format": "google-datetime", "description": "Optional. Expiration time for the peering command to be executed on user's ONTAP." }, "cacheState": { "description": "Output only. State of the cache volume indicating the peering status.", "readOnly": true, "type": "string", "enum": [ "CACHE_STATE_UNSPECIFIED", "PENDING_CLUSTER_PEERING", "PENDING_SVM_PEERING", "PEERED", "ERROR" ], "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." ] }, "peerSvmName": { "description": "Required. Name of the origin volume's SVM.", "type": "string" }, "peerIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "Required. List of IC LIF addresses of the origin volume's ONTAP cluster." }, "peerClusterName": { "description": "Required. Name of the origin volume's ONTAP cluster.", "type": "string" }, "passphrase": { "type": "string", "description": "Output only. Temporary passphrase generated to accept cluster peering command.", "readOnly": true }, "cacheConfig": { "description": "Optional. Configuration of the cache volume.", "$ref": "CacheConfig" } }, "id": "CacheParameters", "type": "object" }, "ListQuotaRulesResponse": { "description": "ListQuotaRulesResponse is the response to a ListQuotaRulesRequest.", "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "quotaRules": { "type": "array", "description": "List of quota rules", "items": { "$ref": "QuotaRule" } }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" } }, "id": "ListQuotaRulesResponse", "type": "object" }, "BackupSource": { "description": "Represents the backup source of the restore operation.", "properties": { "fileList": { "type": "array", "items": { "type": "string" }, "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)" }, "backup": { "description": "Required. The backup resource name.", "type": "string" } }, "id": "BackupSource", "type": "object" }, "CloneDetails": { "id": "CloneDetails", "type": "object", "description": "Details about a clone volume.", "properties": { "sharedSpaceGib": { "description": "Output only. Shared space in GiB. Determined at volume creation time based on size of source snapshot.", "readOnly": true, "type": "string", "format": "int64" }, "sourceVolume": { "description": "Output only. Full name of the source volume resource. Format: projects/{project}/locations/{location}/volumes/{volume}", "readOnly": true, "type": "string" }, "sourceSnapshot": { "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}", "readOnly": true, "type": "string" } } }, "LocationMetadata": { "properties": { "supportedServiceLevels": { "description": "Output only. Supported service levels in a location.", "readOnly": true, "items": { "enumDescriptions": [ "Unspecified service level.", "Premium service level.", "Extreme service level.", "Standard service level.", "Flex service level." ], "type": "string", "enum": [ "SERVICE_LEVEL_UNSPECIFIED", "PREMIUM", "EXTREME", "STANDARD", "FLEX" ] }, "type": "array" }, "supportedFlexPerformance": { "type": "array", "description": "Output only. Supported flex performance in a location.", "readOnly": true, "items": { "enumDescriptions": [ "Unspecified flex performance.", "Flex Storage Pool with default performance.", "Flex Storage Pool with custom performance." ], "type": "string", "enum": [ "FLEX_PERFORMANCE_UNSPECIFIED", "FLEX_PERFORMANCE_DEFAULT", "FLEX_PERFORMANCE_CUSTOM" ] } }, "hasVcp": { "description": "Output only. Indicates if the location has VCP support.", "readOnly": true, "type": "boolean" }, "hasOntapProxy": { "type": "boolean", "description": "Output only. Indicates if the location has ONTAP Proxy support.", "readOnly": true } }, "description": "Metadata for a given google.cloud.location.Location.", "id": "LocationMetadata", "type": "object" }, "ListBackupPoliciesResponse": { "id": "ListBackupPoliciesResponse", "type": "object", "properties": { "backupPolicies": { "items": { "$ref": "BackupPolicy" }, "description": "The list of backup policies.", "type": "array" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "description": "ListBackupPoliciesResponse contains all the backup policies requested." }, "VolumeBackupConfig": { "id": "VolumeBackupConfig", "type": "object", "properties": { "backupConfig": { "description": "Backup configuration for the volume.", "$ref": "BackupConfig" }, "volumeUuid": { "description": "Provides the Ontap UUID of the volume within the pool.", "type": "string" } }, "description": "Backup configuration for a volume in a pool." }, "ExecuteOntapPatchRequest": { "description": "Request message for `ExecuteOntapPatch` API.", "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", "type": "object" }, "BackupPolicy": { "description": "Backup Policy.", "properties": { "labels": { "description": "Resource labels to represent user provided metadata.", "type": "object", "additionalProperties": { "type": "string" } }, "monthlyBackupLimit": { "type": "integer", "format": "int32", "description": "Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1." }, "createTime": { "description": "Output only. The time when the backup policy was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "dailyBackupLimit": { "description": "Number of daily backups to keep. Note that the minimum daily backup limit is 2.", "format": "int32", "type": "integer" }, "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" }, "name": { "description": "Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.", "type": "string" }, "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" }, "state": { "description": "Output only. The backup policy state.", "readOnly": true, "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." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING", "ERROR", "UPDATING" ] }, "assignedVolumeCount": { "description": "Output only. The total number of volumes assigned by this backup policy.", "readOnly": true, "type": "integer", "format": "int32" } }, "id": "BackupPolicy", "type": "object" }, "TransferStats": { "properties": { "transferBytes": { "format": "int64", "type": "string", "description": "Cumulative bytes transferred so far for the replication relationship." }, "lagDuration": { "format": "google-duration", "type": "string", "description": "Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content." }, "totalTransferDuration": { "type": "string", "format": "google-duration", "description": "Cumulative time taken across all transfers for the replication relationship." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Time when progress was updated last." }, "lastTransferEndTime": { "description": "Time when last transfer completed.", "format": "google-datetime", "type": "string" }, "lastTransferError": { "description": "A message describing the cause of the last transfer failure.", "type": "string" }, "lastTransferDuration": { "description": "Time taken during last transfer.", "format": "google-duration", "type": "string" }, "lastTransferBytes": { "description": "Last transfer size in bytes.", "type": "string", "format": "int64" } }, "description": "TransferStats reports all statistics related to replication transfer.", "id": "TransferStats", "type": "object" }, "OperationMetadata": { "id": "OperationMetadata", "type": "object", "description": "Represents the metadata of the long-running operation.", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "verb": { "type": "string", "description": "Output only. Name of the verb executed by the operation.", "readOnly": true }, "statusMessage": { "type": "string", "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true }, "requestedCancellation": { "type": "boolean", "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`.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "target": { "type": "string", "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" } } }, "WeeklySchedule": { "id": "WeeklySchedule", "type": "object", "description": "Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50", "properties": { "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": { "description": "The maximum number of Snapshots to keep for the hourly schedule", "type": "number", "format": "double" }, "hour": { "type": "number", "format": "double", "description": "Set the hour to start the snapshot (0-23), defaults to midnight (0)." }, "minute": { "format": "double", "type": "number", "description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0)." } } }, "EstablishPeeringRequest": { "id": "EstablishPeeringRequest", "type": "object", "properties": { "peerSvmName": { "description": "Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.", "type": "string" }, "peerIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of IPv4 ip addresses to be used for peering." }, "peerVolumeName": { "description": "Required. Name of the user's local source volume to be peered with the destination volume.", "type": "string" }, "peerClusterName": { "description": "Required. Name of the user's local source cluster to be peered with the destination cluster.", "type": "string" } }, "description": "EstablishPeeringRequest establishes cluster and svm peerings between the source and the destination replications." }, "HourlySchedule": { "id": "HourlySchedule", "type": "object", "description": "Make a snapshot every hour e.g. at 04:00, 05:00, 06:00.", "properties": { "snapshotsToKeep": { "description": "The maximum number of Snapshots to keep for the hourly schedule", "type": "number", "format": "double" }, "minute": { "type": "number", "format": "double", "description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0)." } } }, "ExecuteOntapGetResponse": { "properties": { "body": { "description": "The raw `JSON` body of the response.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "description": "Response message for `ExecuteOntapGet` API.", "id": "ExecuteOntapGetResponse", "type": "object" }, "ListBackupVaultsResponse": { "id": "ListBackupVaultsResponse", "type": "object", "description": "ListBackupVaultsResponse is the result of ListBackupVaultsRequest.", "properties": { "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." }, "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" }, "backupVaults": { "description": "A list of backupVaults in the project for the specified location.", "items": { "$ref": "BackupVault" }, "type": "array" } } }, "ExportPolicy": { "id": "ExportPolicy", "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "SimpleExportPolicyRule" }, "description": "Required. List of export policy rules" } }, "description": "Defines the export policy for the volume." }, "Volume": { "properties": { "stateDetails": { "type": "string", "description": "Output only. State details of the volume", "readOnly": true }, "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" }, "tieringPolicy": { "description": "Tiering policy for the volume.", "$ref": "TieringPolicy" }, "hotTierSizeUsedGib": { "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", "readOnly": true, "format": "int64", "type": "string" }, "encryptionType": { "description": "Output only. Specified the current volume encryption key source.", "readOnly": true, "type": "string", "enum": [ "ENCRYPTION_TYPE_UNSPECIFIED", "SERVICE_MANAGED", "CLOUD_KMS" ], "enumDescriptions": [ "The source of the encryption key is not specified.", "Google managed encryption key.", "Customer managed encryption key, which is stored in KMS." ] }, "usedGib": { "type": "string", "format": "int64", "description": "Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.", "readOnly": true }, "restoreParameters": { "description": "Optional. Specifies the source of the volume to be created from.", "$ref": "RestoreParameters" }, "serviceLevel": { "description": "Output only. Service level of the volume", "readOnly": true, "enumDescriptions": [ "Unspecified service level.", "Premium service level.", "Extreme service level.", "Standard service level.", "Flex service level." ], "type": "string", "enum": [ "SERVICE_LEVEL_UNSPECIFIED", "PREMIUM", "EXTREME", "STANDARD", "FLEX" ] }, "cloneDetails": { "description": "Output only. If this volume is a clone, this field contains details about the clone.", "readOnly": true, "$ref": "CloneDetails" }, "restrictedActions": { "items": { "type": "string", "enum": [ "RESTRICTED_ACTION_UNSPECIFIED", "DELETE" ], "enumDescriptions": [ "Unspecified restricted action", "Prevent volume from being deleted when mounted." ] }, "description": "Optional. List of actions that are restricted on this volume.", "type": "array" }, "mountOptions": { "type": "array", "description": "Output only. Mount options of this volume", "readOnly": true, "items": { "$ref": "MountOption" } }, "coldTierSizeGib": { "description": "Output only. Size of the volume cold tier data rounded down to the nearest GiB.", "readOnly": true, "type": "string", "format": "int64" }, "labels": { "description": "Optional. Labels as key value pairs", "type": "object", "additionalProperties": { "type": "string" } }, "kmsConfig": { "type": "string", "description": "Output only. Specifies the KMS config to be used for volume encryption.", "readOnly": true }, "replicaZone": { "type": "string", "description": "Output only. Specifies the replica zone for regional volume.", "readOnly": true }, "description": { "description": "Optional. Description of the volume", "type": "string" }, "smbSettings": { "description": "Optional. SMB share settings for the volume.", "items": { "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" ], "type": "string", "enum": [ "SMB_SETTINGS_UNSPECIFIED", "ENCRYPT_DATA", "BROWSABLE", "CHANGE_NOTIFY", "NON_BROWSABLE", "OPLOCKS", "SHOW_SNAPSHOT", "SHOW_PREVIOUS_VERSIONS", "ACCESS_BASED_ENUMERATION", "CONTINUOUSLY_AVAILABLE" ] }, "type": "array" }, "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" }, "snapReserve": { "description": "Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.", "format": "double", "type": "number" }, "hybridReplicationParameters": { "description": "Optional. The Hybrid Replication parameters for the volume.", "$ref": "HybridReplicationParameters" }, "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" }, "psaRange": { "description": "Output only. This field is not implemented. The values provided in this field are ignored.", "readOnly": true, "type": "string" }, "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" }, "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" }, "shareName": { "description": "Required. Share name of the volume", "type": "string" }, "throughputMibps": { "description": "Optional. Throughput of the volume (in MiB/s)", "type": "number", "format": "double" }, "createTime": { "description": "Output only. Create time of the volume", "readOnly": true, "type": "string", "format": "google-datetime" }, "storagePool": { "description": "Required. StoragePool name of the volume", "type": "string" }, "cacheParameters": { "description": "Optional. Cache parameters for the volume.", "$ref": "CacheParameters" }, "securityStyle": { "enumDescriptions": [ "SecurityStyle is unspecified", "SecurityStyle uses NTFS", "SecurityStyle uses UNIX" ], "type": "string", "enum": [ "SECURITY_STYLE_UNSPECIFIED", "NTFS", "UNIX" ], "description": "Optional. Security Style of the Volume" }, "hasReplication": { "type": "boolean", "description": "Output only. Indicates whether the volume is part of a replication relationship.", "readOnly": true }, "network": { "type": "string", "description": "Output only. VPC Network name. Format: projects/{project}/global/networks/{network}", "readOnly": true }, "state": { "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" ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "READY", "CREATING", "DELETING", "UPDATING", "RESTORING", "DISABLED", "ERROR", "PREPARING", "READ_ONLY" ], "description": "Output only. State of the volume", "readOnly": true }, "activeDirectory": { "description": "Output only. Specifies the ActiveDirectory name of a SMB volume.", "readOnly": true, "type": "string" }, "snapshotPolicy": { "description": "Optional. SnapshotPolicy for a volume.", "$ref": "SnapshotPolicy" }, "zone": { "description": "Output only. Specifies the active zone for regional volume.", "readOnly": true, "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" }, "ldapEnabled": { "type": "boolean", "description": "Output only. Flag indicating if the volume is NFS LDAP enabled or not.", "readOnly": true }, "exportPolicy": { "description": "Optional. Export policy of the volume", "$ref": "ExportPolicy" }, "capacityGib": { "type": "string", "format": "int64", "description": "Required. Capacity in GIB of the volume" }, "protocols": { "items": { "enumDescriptions": [ "Unspecified protocol", "NFS V3 protocol", "NFS V4 protocol", "SMB protocol", "ISCSI protocol", "NVMe protocol" ], "type": "string", "enum": [ "PROTOCOLS_UNSPECIFIED", "NFSV3", "NFSV4", "SMB", "ISCSI", "NVME" ] }, "description": "Required. Protocols required for the volume", "type": "array" }, "backupConfig": { "description": "BackupConfig of the volume.", "$ref": "BackupConfig" }, "name": { "description": "Identifier. Name of the volume", "type": "string" }, "blockDevices": { "description": "Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.", "items": { "$ref": "BlockDevice" }, "type": "array" } }, "description": "Volume provides a filesystem that you can mount.", "id": "Volume", "type": "object" }, "ListKmsConfigsResponse": { "id": "ListKmsConfigsResponse", "type": "object", "properties": { "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "kmsConfigs": { "type": "array", "description": "The list of KmsConfigs", "items": { "$ref": "KmsConfig" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "description": "ListKmsConfigsResponse is the response to a ListKmsConfigsRequest." }, "ResumeReplicationRequest": { "id": "ResumeReplicationRequest", "type": "object", "description": "ResumeReplicationRequest resumes a stopped replication.", "properties": {} }, "EncryptVolumesRequest": { "id": "EncryptVolumesRequest", "type": "object", "properties": {}, "description": "EncryptVolumesRequest specifies the KMS config to encrypt existing volumes." }, "ListBackupConfigsResponse": { "description": "Message for response to listing BackupConfigs in an ONTAP StoragePool.", "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" }, "volumeBackupConfigs": { "description": "A list of backup configurations for volumes in the pool.", "items": { "$ref": "VolumeBackupConfig" }, "type": "array" }, "unreachable": { "description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, "type": "array" } }, "id": "ListBackupConfigsResponse", "type": "object" }, "BackupRetentionPolicy": { "id": "BackupRetentionPolicy", "type": "object", "description": "Retention policy for backups in the backup vault", "properties": { "backupMinimumEnforcedRetentionDays": { "description": "Required. Minimum retention duration in days for backups in the backup vault.", "format": "int32", "type": "integer" }, "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" }, "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" } } }, "RestoreVolumeRequest": { "id": "RestoreVolumeRequest", "type": "object", "properties": { "backupSource": { "description": "The backup source of the restore operation.", "$ref": "BackupSource" }, "ontapVolumeTarget": { "description": "The ONTAP volume target of the restore operation.", "$ref": "OntapVolumeTarget" } }, "description": "Request message for `RestoreVolume` API." }, "RestoreBackupFilesRequest": { "id": "RestoreBackupFilesRequest", "type": "object", "properties": { "fileList": { "type": "array", "items": { "type": "string" }, "description": "Required. List of files to be restored, specified by their absolute path in the source volume." }, "restoreDestinationPath": { "description": "Optional. Absolute directory path in the destination volume. This is required if the `file_list` is provided.", "type": "string" }, "backup": { "description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", "type": "string" } }, "description": "RestoreBackupFilesRequest restores files from a backup to a volume." }, "ListReplicationsResponse": { "description": "ListReplicationsResponse is the result of ListReplicationsRequest.", "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" }, "replications": { "type": "array", "items": { "$ref": "Replication" }, "description": "A list of replications in the project for the specified volume." }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" } }, "id": "ListReplicationsResponse", "type": "object" }, "ExecuteOntapPatchResponse": { "description": "Response message for `ExecuteOntapPatch` API.", "properties": { "body": { "description": "The raw `JSON` body of the response.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "ExecuteOntapPatchResponse", "type": "object" }, "LargeCapacityConfig": { "id": "LargeCapacityConfig", "type": "object", "properties": { "constituentCount": { "format": "int32", "type": "integer", "description": "Optional. The number of internal constituents (e.g., FlexVols) for this large volume. The minimum number of constituents is 2." } }, "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." }, "ListOperationsResponse": { "id": "ListOperationsResponse", "type": "object", "description": "The response message for Operations.ListOperations.", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "type": "array", "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" } }, "unreachable": { "type": "array", "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.", "items": { "type": "string" } } } }, "DailySchedule": { "id": "DailySchedule", "type": "object", "description": "Make a snapshot every day e.g. at 04:00, 05:20, 23:50", "properties": { "snapshotsToKeep": { "description": "The maximum number of Snapshots to keep for the hourly schedule", "type": "number", "format": "double" }, "minute": { "format": "double", "type": "number", "description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0)." }, "hour": { "type": "number", "format": "double", "description": "Set the hour to start the snapshot (0-23), defaults to midnight (0)." } } }, "StopReplicationRequest": { "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" } }, "description": "StopReplicationRequest stops a replication until resumed.", "id": "StopReplicationRequest", "type": "object" }, "GoogleProtobufEmpty": { "properties": {}, "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); }", "id": "GoogleProtobufEmpty", "type": "object" }, "SwitchActiveReplicaZoneRequest": { "properties": {}, "description": "SwitchActiveReplicaZoneRequest switch the active/replica zone for a regional storagePool.", "id": "SwitchActiveReplicaZoneRequest", "type": "object" }, "RevertVolumeRequest": { "id": "RevertVolumeRequest", "type": "object", "description": "RevertVolumeRequest reverts the given volume to the specified snapshot.", "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" } } }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "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": { "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", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } }, "id": "Operation", "type": "object" } }, "version": "v1", "baseUrl": "https://netapp.googleapis.com/", "ownerName": "Google", "auth": { "oauth2": { "scopes": { "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." } } } }, "endpoints": [ { "endpointUrl": "https://netapp.africa-south1.rep.googleapis.com/", "location": "africa-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.asia-east1.rep.googleapis.com/", "location": "asia-east1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.asia-east2.rep.googleapis.com/", "location": "asia-east2" }, { "endpointUrl": "https://netapp.asia-northeast1.rep.googleapis.com/", "location": "asia-northeast1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.asia-northeast3.rep.googleapis.com/", "location": "asia-northeast3" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.asia-south1.rep.googleapis.com/", "location": "asia-south1" }, { "endpointUrl": "https://netapp.asia-south2.rep.googleapis.com/", "location": "asia-south2", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.asia-southeast1.rep.googleapis.com/", "location": "asia-southeast1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2" }, { "endpointUrl": "https://netapp.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.europe-central2.rep.googleapis.com/", "location": "europe-central2", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, { "endpointUrl": "https://netapp.europe-north2.rep.googleapis.com/", "location": "europe-north2", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.europe-west1.rep.googleapis.com/", "location": "europe-west1" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.europe-west10.rep.googleapis.com/", "location": "europe-west10" }, { "endpointUrl": "https://netapp.europe-west12.rep.googleapis.com/", "location": "europe-west12", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.europe-west2.rep.googleapis.com/", "location": "europe-west2", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.europe-west3.rep.googleapis.com/", "location": "europe-west3", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.europe-west4.rep.googleapis.com/", "location": "europe-west4", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.europe-west6.rep.googleapis.com/", "location": "europe-west6" }, { "endpointUrl": "https://netapp.europe-west8.rep.googleapis.com/", "location": "europe-west8", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.europe-west9.rep.googleapis.com/", "location": "europe-west9" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.me-central1.rep.googleapis.com/", "location": "me-central1" }, { "endpointUrl": "https://netapp.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.me-west1.rep.googleapis.com/", "location": "me-west1" }, { "endpointUrl": "https://netapp.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.northamerica-south1.rep.googleapis.com/", "location": "northamerica-south1" }, { "endpointUrl": "https://netapp.southamerica-east1.rep.googleapis.com/", "location": "southamerica-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.us-central1.rep.googleapis.com/", "location": "us-central1", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.us-east1.rep.googleapis.com/", "location": "us-east1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.us-east4.rep.googleapis.com/", "location": "us-east4" }, { "endpointUrl": "https://netapp.us-east5.rep.googleapis.com/", "location": "us-east5", "description": "Regional Endpoint" }, { "endpointUrl": "https://netapp.us-east7.rep.googleapis.com/", "location": "us-east7", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.us-south1.rep.googleapis.com/", "location": "us-south1" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.us-west1.rep.googleapis.com/", "location": "us-west1" }, { "endpointUrl": "https://netapp.us-west2.rep.googleapis.com/", "location": "us-west2", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.us-west3.rep.googleapis.com/", "location": "us-west3" }, { "description": "Regional Endpoint", "endpointUrl": "https://netapp.us-west4.rep.googleapis.com/", "location": "us-west4" } ], "fullyEncodeReservedExpansion": true, "servicePath": "", "rootUrl": "https://netapp.googleapis.com/", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+$", "required": true, "type": "string", "description": "The resource that owns the locations collection, if applicable.", "location": "path" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "filter": { "location": "query", "type": "string", "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)." }, "extraLocationTypes": { "location": "query", "repeated": true, "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage." } }, "response": { "$ref": "ListLocationsResponse" }, "httpMethod": "GET", "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.", "path": "v1/{+name}/locations", "id": "netapp.projects.locations.list", "flatPath": "v1/projects/{projectsId}/locations" }, "get": { "id": "netapp.projects.locations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "path": "v1/{+name}", "httpMethod": "GET", "description": "Gets information about a location.", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "volumes": { "resources": { "replications": { "methods": { "patch": { "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "required": true, "type": "string" }, "updateMask": { "description": "Required. Mask of fields to update. At least one path must be supplied in this field.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Replication" }, "id": "netapp.projects.locations.volumes.replications.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", "path": "v1/{+name}", "httpMethod": "PATCH", "description": "Updates the settings of a specific replication." }, "create": { "parameters": { "replicationId": { "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.", "location": "query", "type": "string" }, "parent": { "location": "path", "description": "Required. The NetApp volume to create the replications of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "Replication" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/replications", "id": "netapp.projects.locations.volumes.replications.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications", "description": "Create a new replication for a volume.", "httpMethod": "POST" }, "reverseDirection": { "description": "Reverses direction of replication. Source becomes destination and destination becomes source.", "httpMethod": "POST", "id": "netapp.projects.locations.volumes.replications.reverseDirection", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:reverseDirection", "path": "v1/{+name}:reverseDirection", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ReverseReplicationDirectionRequest" }, "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}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ] }, "establishPeering": { "id": "netapp.projects.locations.volumes.replications.establishPeering", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:establishPeering", "path": "v1/{+name}:establishPeering", "description": "Establish replication peering.", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", "location": "path" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "EstablishPeeringRequest" } }, "resume": { "description": "Resume Cross Region Replication.", "httpMethod": "POST", "id": "netapp.projects.locations.volumes.replications.resume", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:resume", "path": "v1/{+name}:resume", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ResumeReplicationRequest" }, "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}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "description": "Returns descriptions of all replications for a volume.", "path": "v1/{+parent}/replications", "id": "netapp.projects.locations.volumes.replications.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "location": "query", "type": "string", "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted)." }, "pageSize": { "description": "The maximum number of items to return.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", "location": "query", "type": "string" }, "parent": { "description": "Required. The volume for which to retrieve replication information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string" }, "filter": { "description": "List filter.", "location": "query", "type": "string" } }, "response": { "$ref": "ListReplicationsResponse" } }, "sync": { "id": "netapp.projects.locations.volumes.replications.sync", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:sync", "path": "v1/{+name}:sync", "httpMethod": "POST", "description": "Syncs the replication. This will invoke one time volume data transfer from source to destination.", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "required": true, "type": "string", "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}." } }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "SyncReplicationRequest" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "required": true, "type": "string", "description": "Required. The replication resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`", "location": "path" } }, "response": { "$ref": "Replication" }, "httpMethod": "GET", "description": "Describe a replication for a volume.", "path": "v1/{+name}", "id": "netapp.projects.locations.volumes.replications.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}" }, "delete": { "path": "v1/{+name}", "id": "netapp.projects.locations.volumes.replications.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", "description": "Deletes a replication.", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "required": true, "type": "string", "description": "Required. The replication resource name, in the format `projects/*/locations/*/volumes/*/replications/{replication_id}`", "location": "path" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "stop": { "request": { "$ref": "StopReplicationRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "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}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "description": "Stop Cross Region Replication.", "path": "v1/{+name}:stop", "id": "netapp.projects.locations.volumes.replications.stop", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:stop" } } }, "snapshots": { "methods": { "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", "required": true, "type": "string", "description": "Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`", "location": "path" } }, "response": { "$ref": "Snapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "netapp.projects.locations.volumes.snapshots.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", "httpMethod": "GET", "description": "Describe a snapshot for a volume." }, "delete": { "httpMethod": "DELETE", "description": "Deletes a snapshot.", "id": "netapp.projects.locations.volumes.snapshots.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The snapshot resource name, in the format `projects/*/locations/*/volumes/*/snapshots/{snapshot_id}`" } }, "response": { "$ref": "Operation" } }, "create": { "path": "v1/{+parent}/snapshots", "id": "netapp.projects.locations.volumes.snapshots.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", "description": "Create a new snapshot for a volume.", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The NetApp volume to create the snapshots of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`" }, "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.", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "Snapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", "required": true, "type": "string" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. Mask of fields to update. At least one path must be supplied in this field." } }, "response": { "$ref": "Operation" }, "request": { "$ref": "Snapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "netapp.projects.locations.volumes.snapshots.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", "httpMethod": "PATCH", "description": "Updates the settings of a specific snapshot." }, "list": { "httpMethod": "GET", "description": "Returns descriptions of all snapshots for a volume.", "id": "netapp.projects.locations.volumes.snapshots.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", "path": "v1/{+parent}/snapshots", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of items to return." }, "orderBy": { "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", "location": "query", "type": "string" }, "filter": { "description": "List filter.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "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}`." }, "pageToken": { "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", "location": "query", "type": "string" } }, "response": { "$ref": "ListSnapshotsResponse" } } } }, "quotaRules": { "methods": { "list": { "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default." }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token identifying a page of results the server should return." }, "filter": { "location": "query", "type": "string", "description": "Optional. Filtering results" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. Parent value for ListQuotaRulesRequest" } }, "response": { "$ref": "ListQuotaRulesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/quotaRules", "id": "netapp.projects.locations.volumes.quotaRules.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules", "httpMethod": "GET", "description": "Returns list of all quota rules in a location." }, "patch": { "id": "netapp.projects.locations.volumes.quotaRules.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules/{quotaRulesId}", "path": "v1/{+name}", "httpMethod": "PATCH", "description": "Updates a quota rule.", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/quotaRules/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Identifier. The resource name of the quota rule. Format: `projects/{project_number}/locations/{location_id}/volumes/volumes/{volume_id}/quotaRules/{quota_rule_id}`." }, "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "QuotaRule" } }, "create": { "parameters": { "parent": { "location": "path", "description": "Required. Parent value for CreateQuotaRuleRequest", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string" }, "quotaRuleId": { "location": "query", "type": "string", "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." } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "QuotaRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/quotaRules", "id": "netapp.projects.locations.volumes.quotaRules.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules", "description": "Creates a new quota rule.", "httpMethod": "POST" }, "delete": { "parameters": { "name": { "location": "path", "description": "Required. Name of the quota rule.", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/quotaRules/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "netapp.projects.locations.volumes.quotaRules.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules/{quotaRulesId}", "description": "Deletes a quota rule.", "httpMethod": "DELETE" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/quotaRules/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. Name of the quota rule" } }, "response": { "$ref": "QuotaRule" }, "httpMethod": "GET", "description": "Returns details of the specified quota rule.", "path": "v1/{+name}", "id": "netapp.projects.locations.volumes.quotaRules.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules/{quotaRulesId}" } } } }, "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "filter": { "location": "query", "type": "string", "description": "Filtering results" }, "parent": { "location": "path", "description": "Required. Parent value for ListVolumesRequest", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "pageToken": { "description": "A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default." }, "orderBy": { "description": "Hint for how to order the results", "location": "query", "type": "string" } }, "response": { "$ref": "ListVolumesResponse" }, "httpMethod": "GET", "description": "Lists Volumes in a given project.", "path": "v1/{+parent}/volumes", "id": "netapp.projects.locations.volumes.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes" }, "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string", "description": "Identifier. Name of the volume", "location": "path" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "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." } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "request": { "$ref": "Volume" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "netapp.projects.locations.volumes.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", "description": "Updates the parameters of a single Volume.", "httpMethod": "PATCH" }, "restore": { "httpMethod": "POST", "description": "Restore files from a backup to a volume.", "id": "netapp.projects.locations.volumes.restore", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:restore", "path": "v1/{+name}:restore", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RestoreBackupFilesRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The volume resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" } }, "create": { "path": "v1/{+parent}/volumes", "id": "netapp.projects.locations.volumes.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes", "description": "Creates a new Volume in a given project and location.", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. Value for parent." }, "volumeId": { "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.", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "Volume" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "id": "netapp.projects.locations.volumes.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", "path": "v1/{+name}", "description": "Deletes a single Volume.", "httpMethod": "DELETE", "parameters": { "force": { "location": "query", "type": "boolean", "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.)" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. Name of the volume" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "establishPeering": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string", "description": "Required. The volume resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "location": "path" } }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "EstablishVolumePeeringRequest" }, "id": "netapp.projects.locations.volumes.establishPeering", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:establishPeering", "path": "v1/{+name}:establishPeering", "httpMethod": "POST", "description": "Establish volume peering. This is used to establish cluster and svm peerings between the GCNV and OnPrem clusters." }, "revert": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the volume, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}.", "location": "path" } }, "response": { "$ref": "Operation" }, "request": { "$ref": "RevertVolumeRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:revert", "id": "netapp.projects.locations.volumes.revert", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:revert", "httpMethod": "POST", "description": "Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created." }, "get": { "httpMethod": "GET", "description": "Gets details of a single Volume.", "id": "netapp.projects.locations.volumes.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. Name of the volume", "pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Volume" } } } }, "backupVaults": { "methods": { "list": { "id": "netapp.projects.locations.backupVaults.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults", "path": "v1/{+parent}/backupVaults", "httpMethod": "GET", "description": "Returns list of all available backup vaults.", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", "location": "query", "type": "string" }, "parent": { "location": "path", "description": "Required. The location for which to retrieve backupVault information, in the format `projects/{project_id}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "filter": { "location": "query", "type": "string", "description": "List filter." }, "orderBy": { "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The maximum number of items to return." } }, "response": { "$ref": "ListBackupVaultsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "description": "Updates the settings of a specific backup vault.", "httpMethod": "PATCH", "id": "netapp.projects.locations.backupVaults.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "BackupVault" }, "parameters": { "name": { "location": "path", "description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "required": true, "type": "string" }, "updateMask": { "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ] }, "create": { "request": { "$ref": "BackupVault" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "description": "Required. The location to create the backup vaults, in the format `projects/{project_id}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "backupVaultId": { "location": "query", "type": "string", "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." } }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "description": "Creates new backup vault", "path": "v1/{+parent}/backupVaults", "id": "netapp.projects.locations.backupVaults.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults" }, "delete": { "parameters": { "name": { "location": "path", "description": "Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "netapp.projects.locations.backupVaults.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", "description": "Warning! This operation will permanently delete the backup vault.", "httpMethod": "DELETE" }, "get": { "httpMethod": "GET", "description": "Returns the description of the specified backup vault", "path": "v1/{+name}", "id": "netapp.projects.locations.backupVaults.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "required": true, "type": "string", "description": "Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", "location": "path" } }, "response": { "$ref": "BackupVault" } } }, "resources": { "backups": { "methods": { "patch": { "httpMethod": "PATCH", "description": "Update backup with full spec.", "path": "v1/{+name}", "id": "netapp.projects.locations.backupVaults.backups.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", "request": { "$ref": "Backup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", "required": true, "type": "string" }, "updateMask": { "location": "query", "type": "string", "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." } }, "response": { "$ref": "Operation" } }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "required": true, "type": "string", "description": "Required. The NetApp backupVault to create the backups of, in the format `projects/*/locations/*/backupVaults/{backup_vault_id}`", "location": "path" }, "backupId": { "location": "query", "type": "string", "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." } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "Backup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/backups", "id": "netapp.projects.locations.backupVaults.backups.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups", "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.", "httpMethod": "POST" }, "list": { "description": "Returns descriptions of all backups for a backupVault.", "httpMethod": "GET", "id": "netapp.projects.locations.backupVaults.backups.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups", "path": "v1/{+parent}/backups", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "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.", "format": "int32", "location": "query", "type": "integer" }, "orderBy": { "location": "query", "type": "string", "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted)." }, "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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "required": true, "type": "string" }, "filter": { "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", "location": "query", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "The next_page_token value to use if there are additional results to retrieve for this list request." } }, "response": { "$ref": "ListBackupsResponse" }, "parameterOrder": [ "parent" ] }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", "required": true, "type": "string", "description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", "location": "path" } }, "response": { "$ref": "Backup" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "netapp.projects.locations.backupVaults.backups.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", "path": "v1/{+name}", "description": "Returns the description of the specified backup", "httpMethod": "GET" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`" } }, "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "description": "Warning! This operation will permanently delete the backup.", "path": "v1/{+name}", "id": "netapp.projects.locations.backupVaults.backups.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}" } } } } }, "activeDirectories": { "methods": { "get": { "id": "netapp.projects.locations.activeDirectories.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", "path": "v1/{+name}", "httpMethod": "GET", "description": "Describes a specified active directory.", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. Name of the active directory." } }, "response": { "$ref": "ActiveDirectory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. Name of the active directory.", "pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "description": "Delete the active directory specified in the request.", "id": "netapp.projects.locations.activeDirectories.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", "path": "v1/{+name}" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ActiveDirectory" }, "parameters": { "activeDirectoryId": { "location": "query", "type": "string", "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." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. Value for parent.", "location": "path" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "description": "CreateActiveDirectory Creates the active directory specified in the request.", "httpMethod": "POST", "id": "netapp.projects.locations.activeDirectories.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories", "path": "v1/{+parent}/activeDirectories" }, "patch": { "httpMethod": "PATCH", "description": "Update the parameters of an active directories.", "id": "netapp.projects.locations.activeDirectories.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ActiveDirectory" }, "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`." }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "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." } }, "response": { "$ref": "Operation" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "filter": { "location": "query", "type": "string", "description": "Filtering results" }, "parent": { "location": "path", "description": "Required. Parent value for ListActiveDirectoriesRequest", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return." }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "location": "query", "type": "string", "description": "Hint for how to order the results" } }, "response": { "$ref": "ListActiveDirectoriesResponse" }, "httpMethod": "GET", "description": "Lists active directories.", "id": "netapp.projects.locations.activeDirectories.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories", "path": "v1/{+parent}/activeDirectories" } } }, "operations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "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.", "httpMethod": "GET", "id": "netapp.projects.locations.operations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1/{+name}" }, "list": { "path": "v1/{+name}/operations", "id": "netapp.projects.locations.operations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The standard list page size." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "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.", "location": "query", "type": "boolean" } }, "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be deleted." } }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "netapp.projects.locations.operations.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "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`.", "httpMethod": "DELETE" }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CancelOperationRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled." } }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "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`.", "httpMethod": "POST", "id": "netapp.projects.locations.operations.cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "path": "v1/{+name}:cancel" } } }, "kmsConfigs": { "methods": { "verify": { "path": "v1/{+name}:verify", "id": "netapp.projects.locations.kmsConfigs.verify", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}:verify", "description": "Verifies KMS config reachability.", "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "Required. Name of the KMS Config to be verified.", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "VerifyKmsConfigResponse" }, "parameterOrder": [ "name" ], "request": { "$ref": "VerifyKmsConfigRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Warning! This operation will permanently delete the Kms config.", "httpMethod": "DELETE", "path": "v1/{+name}", "id": "netapp.projects.locations.kmsConfigs.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "Required. Name of the KmsConfig.", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ] }, "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. Name of the KmsConfig" } }, "response": { "$ref": "KmsConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "netapp.projects.locations.kmsConfigs.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", "httpMethod": "GET", "description": "Returns the description of the specified KMS config by kms_config_id." }, "list": { "description": "Returns descriptions of all KMS configs owned by the caller.", "httpMethod": "GET", "path": "v1/{+parent}/kmsConfigs", "id": "netapp.projects.locations.kmsConfigs.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "orderBy": { "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of items to return.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", "location": "query", "type": "string" }, "filter": { "description": "List filter.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. Parent value", "location": "path" } }, "response": { "$ref": "ListKmsConfigsResponse" }, "parameterOrder": [ "parent" ] }, "patch": { "request": { "$ref": "KmsConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Identifier. Name of the `KmsConfig`. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "required": true, "type": "string" }, "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "description": "Updates the Kms config properties with the full spec", "path": "v1/{+name}", "id": "netapp.projects.locations.kmsConfigs.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}" }, "encrypt": { "request": { "$ref": "EncryptVolumesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. Name of the KmsConfig.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "description": "Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.", "httpMethod": "POST", "path": "v1/{+name}:encrypt", "id": "netapp.projects.locations.kmsConfigs.encrypt", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}:encrypt" }, "create": { "id": "netapp.projects.locations.kmsConfigs.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs", "path": "v1/{+parent}/kmsConfigs", "description": "Creates a new KMS config.", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Value for parent.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "kmsConfigId": { "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.", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "KmsConfig" } } } }, "backupPolicies": { "methods": { "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", "required": true, "type": "string", "description": "Required. The backupPolicy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`", "location": "path" } }, "response": { "$ref": "BackupPolicy" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "netapp.projects.locations.backupPolicies.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", "description": "Returns the description of the specified backup policy by backup_policy_id.", "httpMethod": "GET" }, "delete": { "description": "Warning! This operation will permanently delete the backup policy.", "httpMethod": "DELETE", "id": "netapp.projects.locations.backupPolicies.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The backup policy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ] }, "create": { "parameters": { "backupPolicyId": { "location": "query", "type": "string", "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." }, "parent": { "description": "Required. The location to create the backup policies of, in the format `projects/{project_id}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "BackupPolicy" }, "id": "netapp.projects.locations.backupPolicies.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies", "path": "v1/{+parent}/backupPolicies", "description": "Creates new backup policy", "httpMethod": "POST" }, "patch": { "path": "v1/{+name}", "id": "netapp.projects.locations.backupPolicies.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", "description": "Updates settings of a specific backup policy.", "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`." }, "updateMask": { "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.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "request": { "$ref": "BackupPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "description": "Returns list of all available backup policies.", "path": "v1/{+parent}/backupPolicies", "id": "netapp.projects.locations.backupPolicies.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "location": "query", "type": "string", "description": "A token identifying a page of results the server should return." }, "filter": { "description": "Filtering results", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. Parent value for ListBackupPoliciesRequest" }, "orderBy": { "location": "query", "type": "string", "description": "Hint for how to order the results" }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" } }, "response": { "$ref": "ListBackupPoliciesResponse" } } } }, "hostGroups": { "methods": { "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/hostGroups/[^/]+$", "required": true, "type": "string", "description": "Identifier. The resource name of the host group. Format: `projects/{project_number}/locations/{location_id}/hostGroups/{host_group_id}`.", "location": "path" }, "updateMask": { "description": "Optional. The list of fields to update.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "HostGroup" }, "id": "netapp.projects.locations.hostGroups.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hostGroups/{hostGroupsId}", "path": "v1/{+name}", "description": "Updates an existing host group.", "httpMethod": "PATCH" }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. Parent value for CreateHostGroupRequest", "location": "path" }, "hostGroupId": { "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.", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "HostGroup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/hostGroups", "id": "netapp.projects.locations.hostGroups.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hostGroups", "description": "Creates a new host group.", "httpMethod": "POST" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. Parent value for ListHostGroupsRequest", "location": "path" }, "filter": { "description": "Optional. Filter to apply to the request.", "location": "query", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token identifying a page of results the server should return." }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "orderBy": { "description": "Optional. Hint for how to order the results", "location": "query", "type": "string" } }, "response": { "$ref": "ListHostGroupsResponse" }, "parameterOrder": [ "parent" ], "description": "Returns a list of host groups in a `location`. Use `-` as location to list host groups across all locations.", "httpMethod": "GET", "id": "netapp.projects.locations.hostGroups.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hostGroups", "path": "v1/{+parent}/hostGroups" }, "get": { "id": "netapp.projects.locations.hostGroups.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hostGroups/{hostGroupsId}", "path": "v1/{+name}", "description": "Returns details of the specified host group.", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the host group. Format: `projects/{project_number}/locations/{location_id}/hostGroups/{host_group_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/hostGroups/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "HostGroup" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "id": "netapp.projects.locations.hostGroups.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hostGroups/{hostGroupsId}", "path": "v1/{+name}", "httpMethod": "DELETE", "description": "Deletes a host group.", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The resource name of the host group. Format: `projects/{project_number}/locations/{location_id}/hostGroups/{host_group_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/hostGroups/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "storagePools": { "resources": { "ontap": { "methods": { "executeOntapGet": { "parameters": { "ontapPath": { "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "required": true, "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`.", "location": "path" } }, "response": { "$ref": "ExecuteOntapGetResponse" }, "parameterOrder": [ "ontapPath" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "netapp.projects.locations.storagePools.ontap.executeOntapGet", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "path": "v1/{+ontapPath}", "description": "`ExecuteOntapGet` sends the ONTAP `GET` request to the `StoragePool` cluster.", "httpMethod": "GET" }, "executeOntapDelete": { "httpMethod": "DELETE", "description": "`ExecuteOntapDelete` sends the ONTAP `DELETE` request to the `StoragePool` cluster.", "path": "v1/{+ontapPath}", "id": "netapp.projects.locations.storagePools.ontap.executeOntapDelete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "ontapPath" ], "parameters": { "ontapPath": { "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "required": true, "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`.", "location": "path" } }, "response": { "$ref": "ExecuteOntapDeleteResponse" } }, "executeOntapPost": { "id": "netapp.projects.locations.storagePools.ontap.executeOntapPost", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "path": "v1/{+ontapPath}", "description": "`ExecuteOntapPost` sends the ONTAP `POST` request to the `StoragePool` cluster.", "httpMethod": "POST", "parameters": { "ontapPath": { "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`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "required": true, "type": "string" } }, "response": { "$ref": "ExecuteOntapPostResponse" }, "parameterOrder": [ "ontapPath" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ExecuteOntapPostRequest" } }, "executeOntapPatch": { "request": { "$ref": "ExecuteOntapPatchRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "ontapPath" ], "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`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "required": true, "type": "string" } }, "response": { "$ref": "ExecuteOntapPatchResponse" }, "httpMethod": "PATCH", "description": "`ExecuteOntapPatch` sends the ONTAP `PATCH` request to the `StoragePool` cluster.", "path": "v1/{+ontapPath}", "id": "netapp.projects.locations.storagePools.ontap.executeOntapPatch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}" } } }, "backupConfigs": { "methods": { "list": { "httpMethod": "GET", "description": "Lists backup configurations for all volumes in an ONTAP-mode Storage Pool.", "id": "netapp.projects.locations.storagePools.backupConfigs.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/backupConfigs", "path": "v1/{+parent}/backupConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "location": "query", "type": "string", "description": "Optional. Sort results. Supported values are \"volume_id\" or \"\"" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "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." }, "pageToken": { "description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "required": true, "type": "string", "description": "Required. The ONTAP StoragePool for which to retrieve backup configuration information, in the format `projects/{project}/locations/{location}/storagePools/{storage_pool}`.", "location": "path" }, "filter": { "location": "query", "type": "string", "description": "Optional. The standard list filter." } }, "response": { "$ref": "ListBackupConfigsResponse" } } } } }, "methods": { "restoreVolume": { "description": "Restores a backup to an ONTAP-mode volume.", "httpMethod": "POST", "id": "netapp.projects.locations.storagePools.restoreVolume", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:restoreVolume", "path": "v1/{+name}:restoreVolume", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RestoreVolumeRequest" }, "parameters": { "name": { "description": "Required. The resource name of the ONTAP mode storage pool, in the format of `projects/{project}/locations/{location}/storagePools/{storage_pool}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ] }, "create": { "description": "Creates a new storage pool.", "httpMethod": "POST", "id": "netapp.projects.locations.storagePools.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools", "path": "v1/{+parent}/storagePools", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "StoragePool" }, "parameters": { "storagePoolId": { "location": "query", "type": "string", "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." }, "parent": { "location": "path", "description": "Required. Value for parent.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ] }, "patch": { "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Identifier. Name of the storage pool", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "required": true, "type": "string" }, "updateMask": { "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "StoragePool" }, "id": "netapp.projects.locations.storagePools.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", "path": "v1/{+name}", "httpMethod": "PATCH", "description": "Updates the storage pool properties with the full spec" }, "switch": { "httpMethod": "POST", "description": "This operation will switch the active/replica zone for a regional storagePool.", "id": "netapp.projects.locations.storagePools.switch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:switch", "path": "v1/{+name}:switch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "SwitchActiveReplicaZoneRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Name of the storage pool", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" } }, "updateBackupConfig": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "UpdateBackupConfigRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the StoragePool, in the format: projects/{projectNumber}/locations/{locationId}/storagePools/{poolId}", "location": "path" } }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "description": "Updates the backup configuration for an ONTAP-mode volume.", "id": "netapp.projects.locations.storagePools.updateBackupConfig", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:updateBackupConfig", "path": "v1/{+name}:updateBackupConfig" }, "get": { "parameters": { "name": { "description": "Required. Name of the storage pool", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "StoragePool" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "netapp.projects.locations.storagePools.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", "path": "v1/{+name}", "description": "Returns the description of the specified storage pool by poolId.", "httpMethod": "GET" }, "delete": { "httpMethod": "DELETE", "description": "Warning! This operation will permanently delete the storage pool.", "path": "v1/{+name}", "id": "netapp.projects.locations.storagePools.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Name of the storage pool", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" } }, "validateDirectoryService": { "path": "v1/{+name}:validateDirectoryService", "id": "netapp.projects.locations.storagePools.validateDirectoryService", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:validateDirectoryService", "httpMethod": "POST", "description": "ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. Name of the storage pool", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "request": { "$ref": "ValidateDirectoryServiceRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. Parent value" }, "filter": { "location": "query", "type": "string", "description": "Optional. List filter." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted)." }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The maximum number of items to return." } }, "response": { "$ref": "ListStoragePoolsResponse" }, "parameterOrder": [ "parent" ], "description": "Returns descriptions of all storage pools owned by the caller.", "httpMethod": "GET", "id": "netapp.projects.locations.storagePools.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools", "path": "v1/{+parent}/storagePools" } } } } } } } }, "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.", "canonicalName": "NetApp Files", "version_module": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerDomain": "google.com", "revision": "20260518", "kind": "discovery#restDescription", "mtlsRootUrl": "https://netapp.mtls.googleapis.com/", "basePath": "", "name": "netapp", "id": "netapp:v1", "protocol": "rest", "documentationLink": "https://cloud.google.com/netapp/", "discoveryVersion": "v1" }