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