NetApp V1 API - Class Google::Cloud::NetApp::V1::NetApp::Client (v0.5.2)

Reference documentation and code samples for the NetApp V1 API class Google::Cloud::NetApp::V1::NetApp::Client.

Client for the NetApp service.

NetApp Files Google Cloud Service

Inherits

Object

Includes

Google::Cloud::NetApp::V1::NetApp::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the NetApp Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all NetApp clients
::Google::Cloud::NetApp::V1::NetApp::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the NetApp Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_active_directory

def create_active_directory(request, options = nil) -> ::Gapic::Operation
def create_active_directory(parent: nil, active_directory: nil, active_directory_id: nil) -> ::Gapic::Operation

CreateActiveDirectory Creates the active directory specified in the request.

Overloads

def create_active_directory(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_active_directory via a request object, either of type CreateActiveDirectoryRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::CreateActiveDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_active_directory(parent: nil, active_directory: nil, active_directory_id: nil) -> ::Gapic::Operation

Pass arguments to create_active_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Value for parent.
active_directory (::Google::Cloud::NetApp::V1::ActiveDirectory, ::Hash) — Required. Fields of the to be created active directory.
active_directory_id (::String) — Required. ID of the active directory to create.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::CreateActiveDirectoryRequest.new

# Call the create_active_directory method.
result = client.create_active_directory request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_backup

def create_backup(request, options = nil) -> ::Gapic::Operation
def create_backup(parent: nil, backup_id: nil, backup: nil) -> ::Gapic::Operation

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.

Overloads

def create_backup(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_backup via a request object, either of type CreateBackupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::CreateBackupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_backup(parent: nil, backup_id: nil, backup: nil) -> ::Gapic::Operation

Pass arguments to create_backup via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The NetApp backupVault to create the backups of, in the format projects/*/locations/*/backupVaults/{backup_vault_id}
backup_id (::String) — Required. The ID to use for the backup. The ID must be unique within the specified backupVault. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
backup (::Google::Cloud::NetApp::V1::Backup, ::Hash) — Required. A backup resource

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::CreateBackupRequest.new

# Call the create_backup method.
result = client.create_backup request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_backup_policy

def create_backup_policy(request, options = nil) -> ::Gapic::Operation
def create_backup_policy(parent: nil, backup_policy: nil, backup_policy_id: nil) -> ::Gapic::Operation

Creates new backup policy

Overloads

def create_backup_policy(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_backup_policy via a request object, either of type CreateBackupPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::CreateBackupPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_backup_policy(parent: nil, backup_policy: nil, backup_policy_id: nil) -> ::Gapic::Operation

Pass arguments to create_backup_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The location to create the backup policies of, in the format projects/{project_id}/locations/{location}
backup_policy (::Google::Cloud::NetApp::V1::BackupPolicy, ::Hash) — Required. A backupPolicy resource
backup_policy_id (::String) — Required. The ID to use for the backup policy. The ID must be unique within the specified location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::CreateBackupPolicyRequest.new

# Call the create_backup_policy method.
result = client.create_backup_policy request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_backup_vault

def create_backup_vault(request, options = nil) -> ::Gapic::Operation
def create_backup_vault(parent: nil, backup_vault_id: nil, backup_vault: nil) -> ::Gapic::Operation

Creates new backup vault

Overloads

def create_backup_vault(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_backup_vault via a request object, either of type CreateBackupVaultRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::CreateBackupVaultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_backup_vault(parent: nil, backup_vault_id: nil, backup_vault: nil) -> ::Gapic::Operation

Pass arguments to create_backup_vault via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The location to create the backup vaults, in the format projects/{project_id}/locations/{location}
backup_vault_id (::String) — Required. The ID to use for the backupVault. The ID must be unique within the specified location. The max supported length is 63 characters. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
backup_vault (::Google::Cloud::NetApp::V1::BackupVault, ::Hash) — Required. A backupVault resource

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::CreateBackupVaultRequest.new

# Call the create_backup_vault method.
result = client.create_backup_vault request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_kms_config

def create_kms_config(request, options = nil) -> ::Gapic::Operation
def create_kms_config(parent: nil, kms_config_id: nil, kms_config: nil) -> ::Gapic::Operation

Creates a new KMS config.

Overloads

def create_kms_config(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_kms_config via a request object, either of type CreateKmsConfigRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::CreateKmsConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_kms_config(parent: nil, kms_config_id: nil, kms_config: nil) -> ::Gapic::Operation

Pass arguments to create_kms_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Value for parent.
kms_config_id (::String) — Required. Id of the requesting KmsConfig If auto-generating Id server-side, remove this field and id from the method_signature of Create RPC
kms_config (::Google::Cloud::NetApp::V1::KmsConfig, ::Hash) — Required. The required parameters to create a new KmsConfig.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::CreateKmsConfigRequest.new

# Call the create_kms_config method.
result = client.create_kms_config request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_replication

def create_replication(request, options = nil) -> ::Gapic::Operation
def create_replication(parent: nil, replication: nil, replication_id: nil) -> ::Gapic::Operation

Create a new replication for a volume.

Overloads

def create_replication(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_replication via a request object, either of type CreateReplicationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::CreateReplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_replication(parent: nil, replication: nil, replication_id: nil) -> ::Gapic::Operation

Pass arguments to create_replication via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The NetApp volume to create the replications of, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}
replication (::Google::Cloud::NetApp::V1::Replication, ::Hash) — Required. A replication resource
replication_id (::String) — Required. ID of the replication to create. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::CreateReplicationRequest.new

# Call the create_replication method.
result = client.create_replication request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_snapshot

def create_snapshot(request, options = nil) -> ::Gapic::Operation
def create_snapshot(parent: nil, snapshot: nil, snapshot_id: nil) -> ::Gapic::Operation

Create a new snapshot for a volume.

Overloads

def create_snapshot(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_snapshot via a request object, either of type CreateSnapshotRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::CreateSnapshotRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_snapshot(parent: nil, snapshot: nil, snapshot_id: nil) -> ::Gapic::Operation

Pass arguments to create_snapshot via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The NetApp volume to create the snapshots of, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}
snapshot (::Google::Cloud::NetApp::V1::Snapshot, ::Hash) — Required. A snapshot resource
snapshot_id (::String) — Required. ID of the snapshot to create. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::CreateSnapshotRequest.new

# Call the create_snapshot method.
result = client.create_snapshot request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_storage_pool

def create_storage_pool(request, options = nil) -> ::Gapic::Operation
def create_storage_pool(parent: nil, storage_pool_id: nil, storage_pool: nil) -> ::Gapic::Operation

Creates a new storage pool.

Overloads

def create_storage_pool(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_storage_pool via a request object, either of type CreateStoragePoolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::CreateStoragePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_storage_pool(parent: nil, storage_pool_id: nil, storage_pool: nil) -> ::Gapic::Operation

Pass arguments to create_storage_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Value for parent.
storage_pool_id (::String) — Required. Id of the requesting storage pool If auto-generating Id server-side, remove this field and id from the method_signature of Create RPC
storage_pool (::Google::Cloud::NetApp::V1::StoragePool, ::Hash) — Required. The required parameters to create a new storage pool.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::CreateStoragePoolRequest.new

# Call the create_storage_pool method.
result = client.create_storage_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_volume

def create_volume(request, options = nil) -> ::Gapic::Operation
def create_volume(parent: nil, volume_id: nil, volume: nil) -> ::Gapic::Operation

Creates a new Volume in a given project and location.

Overloads

def create_volume(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_volume via a request object, either of type CreateVolumeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::CreateVolumeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_volume(parent: nil, volume_id: nil, volume: nil) -> ::Gapic::Operation

Pass arguments to create_volume via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Value for parent.
volume_id (::String) — Required. Id of the requesting volume If auto-generating Id server-side, remove this field and Id from the method_signature of Create RPC
volume (::Google::Cloud::NetApp::V1::Volume, ::Hash) — Required. The volume being created.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::CreateVolumeRequest.new

# Call the create_volume method.
result = client.create_volume request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_active_directory

def delete_active_directory(request, options = nil) -> ::Gapic::Operation
def delete_active_directory(name: nil) -> ::Gapic::Operation

Delete the active directory specified in the request.

Overloads

def delete_active_directory(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_active_directory via a request object, either of type DeleteActiveDirectoryRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::DeleteActiveDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_active_directory(name: nil) -> ::Gapic::Operation

Pass arguments to delete_active_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the active directory.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::DeleteActiveDirectoryRequest.new

# Call the delete_active_directory method.
result = client.delete_active_directory request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_backup

def delete_backup(request, options = nil) -> ::Gapic::Operation
def delete_backup(name: nil) -> ::Gapic::Operation

Warning! This operation will permanently delete the backup.

Overloads

def delete_backup(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_backup via a request object, either of type DeleteBackupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::DeleteBackupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_backup(name: nil) -> ::Gapic::Operation

Pass arguments to delete_backup via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::DeleteBackupRequest.new

# Call the delete_backup method.
result = client.delete_backup request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_backup_policy

def delete_backup_policy(request, options = nil) -> ::Gapic::Operation
def delete_backup_policy(name: nil) -> ::Gapic::Operation

Warning! This operation will permanently delete the backup policy.

Overloads

def delete_backup_policy(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_backup_policy via a request object, either of type DeleteBackupPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::DeleteBackupPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_backup_policy(name: nil) -> ::Gapic::Operation

Pass arguments to delete_backup_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The backup policy resource name, in the format projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::DeleteBackupPolicyRequest.new

# Call the delete_backup_policy method.
result = client.delete_backup_policy request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_backup_vault

def delete_backup_vault(request, options = nil) -> ::Gapic::Operation
def delete_backup_vault(name: nil) -> ::Gapic::Operation

Warning! This operation will permanently delete the backup vault.

Overloads

def delete_backup_vault(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_backup_vault via a request object, either of type DeleteBackupVaultRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::DeleteBackupVaultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_backup_vault(name: nil) -> ::Gapic::Operation

Pass arguments to delete_backup_vault via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The backupVault resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::DeleteBackupVaultRequest.new

# Call the delete_backup_vault method.
result = client.delete_backup_vault request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_kms_config

def delete_kms_config(request, options = nil) -> ::Gapic::Operation
def delete_kms_config(name: nil) -> ::Gapic::Operation

Warning! This operation will permanently delete the Kms config.

Overloads

def delete_kms_config(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_kms_config via a request object, either of type DeleteKmsConfigRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::DeleteKmsConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_kms_config(name: nil) -> ::Gapic::Operation

Pass arguments to delete_kms_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the KmsConfig.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::DeleteKmsConfigRequest.new

# Call the delete_kms_config method.
result = client.delete_kms_config request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_replication

def delete_replication(request, options = nil) -> ::Gapic::Operation
def delete_replication(name: nil) -> ::Gapic::Operation

Deletes a replication.

Overloads

def delete_replication(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_replication via a request object, either of type DeleteReplicationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::DeleteReplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_replication(name: nil) -> ::Gapic::Operation

Pass arguments to delete_replication via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The replication resource name, in the format projects/*/locations/*/volumes/*/replications/{replication_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::DeleteReplicationRequest.new

# Call the delete_replication method.
result = client.delete_replication request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_snapshot

def delete_snapshot(request, options = nil) -> ::Gapic::Operation
def delete_snapshot(name: nil) -> ::Gapic::Operation

Deletes a snapshot.

Overloads

def delete_snapshot(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_snapshot via a request object, either of type DeleteSnapshotRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::DeleteSnapshotRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_snapshot(name: nil) -> ::Gapic::Operation

Pass arguments to delete_snapshot via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The snapshot resource name, in the format projects/*/locations/*/volumes/*/snapshots/{snapshot_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::DeleteSnapshotRequest.new

# Call the delete_snapshot method.
result = client.delete_snapshot request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_storage_pool

def delete_storage_pool(request, options = nil) -> ::Gapic::Operation
def delete_storage_pool(name: nil) -> ::Gapic::Operation

Warning! This operation will permanently delete the storage pool.

Overloads

def delete_storage_pool(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_storage_pool via a request object, either of type DeleteStoragePoolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::DeleteStoragePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_storage_pool(name: nil) -> ::Gapic::Operation

Pass arguments to delete_storage_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the storage pool

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::DeleteStoragePoolRequest.new

# Call the delete_storage_pool method.
result = client.delete_storage_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_volume

def delete_volume(request, options = nil) -> ::Gapic::Operation
def delete_volume(name: nil, force: nil) -> ::Gapic::Operation

Deletes a single Volume.

Overloads

def delete_volume(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_volume via a request object, either of type DeleteVolumeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::DeleteVolumeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_volume(name: nil, force: nil) -> ::Gapic::Operation

Pass arguments to delete_volume via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Name of the volume
force (::Boolean) — 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.)

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::DeleteVolumeRequest.new

# Call the delete_volume method.
result = client.delete_volume request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#encrypt_volumes

def encrypt_volumes(request, options = nil) -> ::Gapic::Operation
def encrypt_volumes(name: nil) -> ::Gapic::Operation

Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.

Overloads

def encrypt_volumes(request, options = nil) -> ::Gapic::Operation

Pass arguments to encrypt_volumes via a request object, either of type EncryptVolumesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::EncryptVolumesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def encrypt_volumes(name: nil) -> ::Gapic::Operation

Pass arguments to encrypt_volumes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the KmsConfig.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::EncryptVolumesRequest.new

# Call the encrypt_volumes method.
result = client.encrypt_volumes request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_active_directory

def get_active_directory(request, options = nil) -> ::Google::Cloud::NetApp::V1::ActiveDirectory
def get_active_directory(name: nil) -> ::Google::Cloud::NetApp::V1::ActiveDirectory

Describes a specified active directory.

Overloads

def get_active_directory(request, options = nil) -> ::Google::Cloud::NetApp::V1::ActiveDirectory

Pass arguments to get_active_directory via a request object, either of type GetActiveDirectoryRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::GetActiveDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_active_directory(name: nil) -> ::Google::Cloud::NetApp::V1::ActiveDirectory

Pass arguments to get_active_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the active directory.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::ActiveDirectory)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::ActiveDirectory)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::GetActiveDirectoryRequest.new

# Call the get_active_directory method.
result = client.get_active_directory request

# The returned object is of type Google::Cloud::NetApp::V1::ActiveDirectory.
p result

#get_backup

def get_backup(request, options = nil) -> ::Google::Cloud::NetApp::V1::Backup
def get_backup(name: nil) -> ::Google::Cloud::NetApp::V1::Backup

Returns the description of the specified backup

Overloads

def get_backup(request, options = nil) -> ::Google::Cloud::NetApp::V1::Backup

Pass arguments to get_backup via a request object, either of type GetBackupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::GetBackupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_backup(name: nil) -> ::Google::Cloud::NetApp::V1::Backup

Pass arguments to get_backup via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::Backup)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::Backup)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::GetBackupRequest.new

# Call the get_backup method.
result = client.get_backup request

# The returned object is of type Google::Cloud::NetApp::V1::Backup.
p result

#get_backup_policy

def get_backup_policy(request, options = nil) -> ::Google::Cloud::NetApp::V1::BackupPolicy
def get_backup_policy(name: nil) -> ::Google::Cloud::NetApp::V1::BackupPolicy

Returns the description of the specified backup policy by backup_policy_id.

Overloads

def get_backup_policy(request, options = nil) -> ::Google::Cloud::NetApp::V1::BackupPolicy

Pass arguments to get_backup_policy via a request object, either of type GetBackupPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::GetBackupPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_backup_policy(name: nil) -> ::Google::Cloud::NetApp::V1::BackupPolicy

Pass arguments to get_backup_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The backupPolicy resource name, in the format projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::BackupPolicy)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::BackupPolicy)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::GetBackupPolicyRequest.new

# Call the get_backup_policy method.
result = client.get_backup_policy request

# The returned object is of type Google::Cloud::NetApp::V1::BackupPolicy.
p result

#get_backup_vault

def get_backup_vault(request, options = nil) -> ::Google::Cloud::NetApp::V1::BackupVault
def get_backup_vault(name: nil) -> ::Google::Cloud::NetApp::V1::BackupVault

Returns the description of the specified backup vault

Overloads

def get_backup_vault(request, options = nil) -> ::Google::Cloud::NetApp::V1::BackupVault

Pass arguments to get_backup_vault via a request object, either of type GetBackupVaultRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::GetBackupVaultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_backup_vault(name: nil) -> ::Google::Cloud::NetApp::V1::BackupVault

Pass arguments to get_backup_vault via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The backupVault resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::BackupVault)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::BackupVault)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::GetBackupVaultRequest.new

# Call the get_backup_vault method.
result = client.get_backup_vault request

# The returned object is of type Google::Cloud::NetApp::V1::BackupVault.
p result

#get_kms_config

def get_kms_config(request, options = nil) -> ::Google::Cloud::NetApp::V1::KmsConfig
def get_kms_config(name: nil) -> ::Google::Cloud::NetApp::V1::KmsConfig

Returns the description of the specified KMS config by kms_config_id.

Overloads

def get_kms_config(request, options = nil) -> ::Google::Cloud::NetApp::V1::KmsConfig

Pass arguments to get_kms_config via a request object, either of type GetKmsConfigRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::GetKmsConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_kms_config(name: nil) -> ::Google::Cloud::NetApp::V1::KmsConfig

Pass arguments to get_kms_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the KmsConfig

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::KmsConfig)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::KmsConfig)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::GetKmsConfigRequest.new

# Call the get_kms_config method.
result = client.get_kms_config request

# The returned object is of type Google::Cloud::NetApp::V1::KmsConfig.
p result

#get_replication

def get_replication(request, options = nil) -> ::Google::Cloud::NetApp::V1::Replication
def get_replication(name: nil) -> ::Google::Cloud::NetApp::V1::Replication

Describe a replication for a volume.

Overloads

def get_replication(request, options = nil) -> ::Google::Cloud::NetApp::V1::Replication

Pass arguments to get_replication via a request object, either of type GetReplicationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::GetReplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_replication(name: nil) -> ::Google::Cloud::NetApp::V1::Replication

Pass arguments to get_replication via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The replication resource name, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::Replication)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::Replication)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::GetReplicationRequest.new

# Call the get_replication method.
result = client.get_replication request

# The returned object is of type Google::Cloud::NetApp::V1::Replication.
p result

#get_snapshot

def get_snapshot(request, options = nil) -> ::Google::Cloud::NetApp::V1::Snapshot
def get_snapshot(name: nil) -> ::Google::Cloud::NetApp::V1::Snapshot

Describe a snapshot for a volume.

Overloads

def get_snapshot(request, options = nil) -> ::Google::Cloud::NetApp::V1::Snapshot

Pass arguments to get_snapshot via a request object, either of type GetSnapshotRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::GetSnapshotRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_snapshot(name: nil) -> ::Google::Cloud::NetApp::V1::Snapshot

Pass arguments to get_snapshot via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::Snapshot)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::Snapshot)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::GetSnapshotRequest.new

# Call the get_snapshot method.
result = client.get_snapshot request

# The returned object is of type Google::Cloud::NetApp::V1::Snapshot.
p result

#get_storage_pool

def get_storage_pool(request, options = nil) -> ::Google::Cloud::NetApp::V1::StoragePool
def get_storage_pool(name: nil) -> ::Google::Cloud::NetApp::V1::StoragePool

Returns the description of the specified storage pool by poolId.

Overloads

def get_storage_pool(request, options = nil) -> ::Google::Cloud::NetApp::V1::StoragePool

Pass arguments to get_storage_pool via a request object, either of type GetStoragePoolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::GetStoragePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_storage_pool(name: nil) -> ::Google::Cloud::NetApp::V1::StoragePool

Pass arguments to get_storage_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the storage pool

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::StoragePool)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::StoragePool)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::GetStoragePoolRequest.new

# Call the get_storage_pool method.
result = client.get_storage_pool request

# The returned object is of type Google::Cloud::NetApp::V1::StoragePool.
p result

#get_volume

def get_volume(request, options = nil) -> ::Google::Cloud::NetApp::V1::Volume
def get_volume(name: nil) -> ::Google::Cloud::NetApp::V1::Volume

Gets details of a single Volume.

Overloads

def get_volume(request, options = nil) -> ::Google::Cloud::NetApp::V1::Volume

Pass arguments to get_volume via a request object, either of type GetVolumeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::GetVolumeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_volume(name: nil) -> ::Google::Cloud::NetApp::V1::Volume

Pass arguments to get_volume via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the volume

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::Volume)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::Volume)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::GetVolumeRequest.new

# Call the get_volume method.
result = client.get_volume request

# The returned object is of type Google::Cloud::NetApp::V1::Volume.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new NetApp client object.

Yields

(config) — Configure the NetApp client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::NetApp::V1::NetApp::Client.new do |config|
  config.timeout = 10.0
end

#list_active_directories

def list_active_directories(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::ActiveDirectory>
def list_active_directories(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::ActiveDirectory>

Lists active directories.

Overloads

def list_active_directories(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::ActiveDirectory>

Pass arguments to list_active_directories via a request object, either of type ListActiveDirectoriesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ListActiveDirectoriesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_active_directories(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::ActiveDirectory>

Pass arguments to list_active_directories via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Parent value for ListActiveDirectoriesRequest
page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
page_token (::String) — A token identifying a page of results the server should return.
filter (::String) — Filtering results
order_by (::String) — Hint for how to order the results

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::ActiveDirectory>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::ActiveDirectory>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ListActiveDirectoriesRequest.new

# Call the list_active_directories method.
result = client.list_active_directories request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetApp::V1::ActiveDirectory.
  p item
end

#list_backup_policies

def list_backup_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupPolicy>
def list_backup_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupPolicy>

Returns list of all available backup policies.

Overloads

def list_backup_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupPolicy>

Pass arguments to list_backup_policies via a request object, either of type ListBackupPoliciesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ListBackupPoliciesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_backup_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupPolicy>

Pass arguments to list_backup_policies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Parent value for ListBackupPoliciesRequest
page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
page_token (::String) — A token identifying a page of results the server should return.
filter (::String) — Filtering results
order_by (::String) — Hint for how to order the results

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupPolicy>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupPolicy>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ListBackupPoliciesRequest.new

# Call the list_backup_policies method.
result = client.list_backup_policies request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetApp::V1::BackupPolicy.
  p item
end

#list_backup_vaults

def list_backup_vaults(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupVault>
def list_backup_vaults(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupVault>

Returns list of all available backup vaults.

Overloads

def list_backup_vaults(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupVault>

Pass arguments to list_backup_vaults via a request object, either of type ListBackupVaultsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ListBackupVaultsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_backup_vaults(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupVault>

Pass arguments to list_backup_vaults via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The location for which to retrieve backupVault information, in the format projects/{project_id}/locations/{location}.
page_size (::Integer) — The maximum number of items to return.
page_token (::String) — The next_page_token value to use if there are additional results to retrieve for this list request.
order_by (::String) — Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter (::String) — List filter.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupVault>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::BackupVault>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ListBackupVaultsRequest.new

# Call the list_backup_vaults method.
result = client.list_backup_vaults request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetApp::V1::BackupVault.
  p item
end

#list_backups

def list_backups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Backup>
def list_backups(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Backup>

Returns descriptions of all backups for a backupVault.

Overloads

def list_backups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Backup>

Pass arguments to list_backups via a request object, either of type ListBackupsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ListBackupsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_backups(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Backup>

Pass arguments to list_backups via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — 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.
page_size (::Integer) — 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.
page_token (::String) — The next_page_token value to use if there are additional results to retrieve for this list request.
order_by (::String) — Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter (::String) — 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

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Backup>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Backup>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ListBackupsRequest.new

# Call the list_backups method.
result = client.list_backups request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetApp::V1::Backup.
  p item
end

#list_kms_configs

def list_kms_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::KmsConfig>
def list_kms_configs(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::KmsConfig>

Returns descriptions of all KMS configs owned by the caller.

Overloads

def list_kms_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::KmsConfig>

Pass arguments to list_kms_configs via a request object, either of type ListKmsConfigsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ListKmsConfigsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_kms_configs(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::KmsConfig>

Pass arguments to list_kms_configs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Parent value
page_size (::Integer) — The maximum number of items to return.
page_token (::String) — The next_page_token value to use if there are additional results to retrieve for this list request.
order_by (::String) — Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter (::String) — List filter.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::KmsConfig>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::KmsConfig>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ListKmsConfigsRequest.new

# Call the list_kms_configs method.
result = client.list_kms_configs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetApp::V1::KmsConfig.
  p item
end

#list_replications

def list_replications(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Replication>
def list_replications(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Replication>

Returns descriptions of all replications for a volume.

Overloads

def list_replications(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Replication>

Pass arguments to list_replications via a request object, either of type ListReplicationsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ListReplicationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_replications(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Replication>

Pass arguments to list_replications via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The volume for which to retrieve replication information, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}.
page_size (::Integer) — The maximum number of items to return.
page_token (::String) — The next_page_token value to use if there are additional results to retrieve for this list request.
order_by (::String) — Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter (::String) — List filter.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Replication>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Replication>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ListReplicationsRequest.new

# Call the list_replications method.
result = client.list_replications request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetApp::V1::Replication.
  p item
end

#list_snapshots

def list_snapshots(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Snapshot>
def list_snapshots(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Snapshot>

Returns descriptions of all snapshots for a volume.

Overloads

def list_snapshots(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Snapshot>

Pass arguments to list_snapshots via a request object, either of type ListSnapshotsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ListSnapshotsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_snapshots(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Snapshot>

Pass arguments to list_snapshots via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The volume for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}.
page_size (::Integer) — The maximum number of items to return.
page_token (::String) — The next_page_token value to use if there are additional results to retrieve for this list request.
order_by (::String) — Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter (::String) — List filter.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Snapshot>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Snapshot>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ListSnapshotsRequest.new

# Call the list_snapshots method.
result = client.list_snapshots request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetApp::V1::Snapshot.
  p item
end

#list_storage_pools

def list_storage_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::StoragePool>
def list_storage_pools(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::StoragePool>

Returns descriptions of all storage pools owned by the caller.

Overloads

def list_storage_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::StoragePool>

Pass arguments to list_storage_pools via a request object, either of type ListStoragePoolsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ListStoragePoolsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_storage_pools(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::StoragePool>

Pass arguments to list_storage_pools via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Parent value
page_size (::Integer) — Optional. The maximum number of items to return.
page_token (::String) — Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
order_by (::String) — Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter (::String) — Optional. List filter.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::StoragePool>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::StoragePool>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ListStoragePoolsRequest.new

# Call the list_storage_pools method.
result = client.list_storage_pools request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetApp::V1::StoragePool.
  p item
end

#list_volumes

def list_volumes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Volume>
def list_volumes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Volume>

Lists Volumes in a given project.

Overloads

def list_volumes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Volume>

Pass arguments to list_volumes via a request object, either of type ListVolumesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ListVolumesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_volumes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Volume>

Pass arguments to list_volumes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Parent value for ListVolumesRequest
page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
page_token (::String) — A token identifying a page of results the server should return.
filter (::String) — Filtering results
order_by (::String) — Hint for how to order the results

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Volume>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetApp::V1::Volume>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ListVolumesRequest.new

# Call the list_volumes method.
result = client.list_volumes request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetApp::V1::Volume.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns

(Google::Cloud::Location::Locations::Client)

#operations_client

def operations_client() -> ::Google::Cloud::NetApp::V1::NetApp::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::NetApp::V1::NetApp::Operations)

#resume_replication

def resume_replication(request, options = nil) -> ::Gapic::Operation
def resume_replication(name: nil) -> ::Gapic::Operation

Resume Cross Region Replication.

Overloads

def resume_replication(request, options = nil) -> ::Gapic::Operation

Pass arguments to resume_replication via a request object, either of type ResumeReplicationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ResumeReplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def resume_replication(name: nil) -> ::Gapic::Operation

Pass arguments to resume_replication via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ResumeReplicationRequest.new

# Call the resume_replication method.
result = client.resume_replication request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#reverse_replication_direction

def reverse_replication_direction(request, options = nil) -> ::Gapic::Operation
def reverse_replication_direction(name: nil) -> ::Gapic::Operation

Reverses direction of replication. Source becomes destination and destination becomes source.

Overloads

def reverse_replication_direction(request, options = nil) -> ::Gapic::Operation

Pass arguments to reverse_replication_direction via a request object, either of type ReverseReplicationDirectionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::ReverseReplicationDirectionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def reverse_replication_direction(name: nil) -> ::Gapic::Operation

Pass arguments to reverse_replication_direction via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::ReverseReplicationDirectionRequest.new

# Call the reverse_replication_direction method.
result = client.reverse_replication_direction request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#revert_volume

def revert_volume(request, options = nil) -> ::Gapic::Operation
def revert_volume(name: nil, snapshot_id: nil) -> ::Gapic::Operation

Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.

Overloads

def revert_volume(request, options = nil) -> ::Gapic::Operation

Pass arguments to revert_volume via a request object, either of type RevertVolumeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::RevertVolumeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def revert_volume(name: nil, snapshot_id: nil) -> ::Gapic::Operation

Pass arguments to revert_volume via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The resource name of the volume, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}.
snapshot_id (::String) — 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}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::RevertVolumeRequest.new

# Call the revert_volume method.
result = client.revert_volume request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#stop_replication

def stop_replication(request, options = nil) -> ::Gapic::Operation
def stop_replication(name: nil, force: nil) -> ::Gapic::Operation

Stop Cross Region Replication.

Overloads

def stop_replication(request, options = nil) -> ::Gapic::Operation

Pass arguments to stop_replication via a request object, either of type StopReplicationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::StopReplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def stop_replication(name: nil, force: nil) -> ::Gapic::Operation

Pass arguments to stop_replication via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.
force (::Boolean) — 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.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::StopReplicationRequest.new

# Call the stop_replication method.
result = client.stop_replication request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_active_directory

def update_active_directory(request, options = nil) -> ::Gapic::Operation
def update_active_directory(update_mask: nil, active_directory: nil) -> ::Gapic::Operation

Update the parameters of an active directories.

Overloads

def update_active_directory(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_active_directory via a request object, either of type UpdateActiveDirectoryRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::UpdateActiveDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_active_directory(update_mask: nil, active_directory: nil) -> ::Gapic::Operation

Pass arguments to update_active_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
active_directory (::Google::Cloud::NetApp::V1::ActiveDirectory, ::Hash) — Required. The volume being updated

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::UpdateActiveDirectoryRequest.new

# Call the update_active_directory method.
result = client.update_active_directory request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_backup

def update_backup(request, options = nil) -> ::Gapic::Operation
def update_backup(update_mask: nil, backup: nil) -> ::Gapic::Operation

Update backup with full spec.

Overloads

def update_backup(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_backup via a request object, either of type UpdateBackupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::UpdateBackupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_backup(update_mask: nil, backup: nil) -> ::Gapic::Operation

Pass arguments to update_backup via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
backup (::Google::Cloud::NetApp::V1::Backup, ::Hash) — Required. The backup being updated

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::UpdateBackupRequest.new

# Call the update_backup method.
result = client.update_backup request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_backup_policy

def update_backup_policy(request, options = nil) -> ::Gapic::Operation
def update_backup_policy(update_mask: nil, backup_policy: nil) -> ::Gapic::Operation

Updates settings of a specific backup policy.

Overloads

def update_backup_policy(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_backup_policy via a request object, either of type UpdateBackupPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::UpdateBackupPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_backup_policy(update_mask: nil, backup_policy: nil) -> ::Gapic::Operation

Pass arguments to update_backup_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
backup_policy (::Google::Cloud::NetApp::V1::BackupPolicy, ::Hash) — Required. The backup policy being updated

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::UpdateBackupPolicyRequest.new

# Call the update_backup_policy method.
result = client.update_backup_policy request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_backup_vault

def update_backup_vault(request, options = nil) -> ::Gapic::Operation
def update_backup_vault(update_mask: nil, backup_vault: nil) -> ::Gapic::Operation

Updates the settings of a specific backup vault.

Overloads

def update_backup_vault(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_backup_vault via a request object, either of type UpdateBackupVaultRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::UpdateBackupVaultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_backup_vault(update_mask: nil, backup_vault: nil) -> ::Gapic::Operation

Pass arguments to update_backup_vault via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
backup_vault (::Google::Cloud::NetApp::V1::BackupVault, ::Hash) — Required. The backupVault being updated

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::UpdateBackupVaultRequest.new

# Call the update_backup_vault method.
result = client.update_backup_vault request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_kms_config

def update_kms_config(request, options = nil) -> ::Gapic::Operation
def update_kms_config(update_mask: nil, kms_config: nil) -> ::Gapic::Operation

Updates the Kms config properties with the full spec

Overloads

def update_kms_config(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_kms_config via a request object, either of type UpdateKmsConfigRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::UpdateKmsConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_kms_config(update_mask: nil, kms_config: nil) -> ::Gapic::Operation

Pass arguments to update_kms_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
kms_config (::Google::Cloud::NetApp::V1::KmsConfig, ::Hash) — Required. The KmsConfig being updated

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::UpdateKmsConfigRequest.new

# Call the update_kms_config method.
result = client.update_kms_config request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_replication

def update_replication(request, options = nil) -> ::Gapic::Operation
def update_replication(update_mask: nil, replication: nil) -> ::Gapic::Operation

Updates the settings of a specific replication.

Overloads

def update_replication(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_replication via a request object, either of type UpdateReplicationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::UpdateReplicationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_replication(update_mask: nil, replication: nil) -> ::Gapic::Operation

Pass arguments to update_replication via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Mask of fields to update. At least one path must be supplied in this field.
replication (::Google::Cloud::NetApp::V1::Replication, ::Hash) — Required. A replication resource

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::UpdateReplicationRequest.new

# Call the update_replication method.
result = client.update_replication request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_snapshot

def update_snapshot(request, options = nil) -> ::Gapic::Operation
def update_snapshot(update_mask: nil, snapshot: nil) -> ::Gapic::Operation

Updates the settings of a specific snapshot.

Overloads

def update_snapshot(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_snapshot via a request object, either of type UpdateSnapshotRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::UpdateSnapshotRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_snapshot(update_mask: nil, snapshot: nil) -> ::Gapic::Operation

Pass arguments to update_snapshot via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Mask of fields to update. At least one path must be supplied in this field.
snapshot (::Google::Cloud::NetApp::V1::Snapshot, ::Hash) — Required. A snapshot resource

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::UpdateSnapshotRequest.new

# Call the update_snapshot method.
result = client.update_snapshot request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_storage_pool

def update_storage_pool(request, options = nil) -> ::Gapic::Operation
def update_storage_pool(update_mask: nil, storage_pool: nil) -> ::Gapic::Operation

Updates the storage pool properties with the full spec

Overloads

def update_storage_pool(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_storage_pool via a request object, either of type UpdateStoragePoolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::UpdateStoragePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_storage_pool(update_mask: nil, storage_pool: nil) -> ::Gapic::Operation

Pass arguments to update_storage_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
storage_pool (::Google::Cloud::NetApp::V1::StoragePool, ::Hash) — Required. The pool being updated

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::UpdateStoragePoolRequest.new

# Call the update_storage_pool method.
result = client.update_storage_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_volume

def update_volume(request, options = nil) -> ::Gapic::Operation
def update_volume(update_mask: nil, volume: nil) -> ::Gapic::Operation

Updates the parameters of a single Volume.

Overloads

def update_volume(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_volume via a request object, either of type UpdateVolumeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::UpdateVolumeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_volume(update_mask: nil, volume: nil) -> ::Gapic::Operation

Pass arguments to update_volume via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.
volume (::Google::Cloud::NetApp::V1::Volume, ::Hash) — Required. The volume being updated

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::UpdateVolumeRequest.new

# Call the update_volume method.
result = client.update_volume request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#verify_kms_config

def verify_kms_config(request, options = nil) -> ::Google::Cloud::NetApp::V1::VerifyKmsConfigResponse
def verify_kms_config(name: nil) -> ::Google::Cloud::NetApp::V1::VerifyKmsConfigResponse

Verifies KMS config reachability.

Overloads

def verify_kms_config(request, options = nil) -> ::Google::Cloud::NetApp::V1::VerifyKmsConfigResponse

Pass arguments to verify_kms_config via a request object, either of type VerifyKmsConfigRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetApp::V1::VerifyKmsConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def verify_kms_config(name: nil) -> ::Google::Cloud::NetApp::V1::VerifyKmsConfigResponse

Pass arguments to verify_kms_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the KMS Config to be verified.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetApp::V1::VerifyKmsConfigResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetApp::V1::VerifyKmsConfigResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/netapp/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::NetApp::V1::NetApp::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::NetApp::V1::VerifyKmsConfigRequest.new

# Call the verify_kms_config method.
result = client.verify_kms_config request

# The returned object is of type Google::Cloud::NetApp::V1::VerifyKmsConfigResponse.
p result