# Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::HsmManagement::Client (v1.13.0)

1.13.0 (latest) 1.12.1 1.11.0 1.10.0 1.9.2 1.8.0 1.7.0 1.6.0 1.5.1 1.4.0 1.3.2 1.2.1 1.1.0 1.0.2 0.27.0 0.26.0 0.25.1 0.24.3 0.23.0 0.22.1 0.21.0 0.20.0 0.19.0 0.18.1 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.2 Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::HsmManagement::Client.

Client for the HsmManagement service.

Google Cloud HSM Management Service

Provides interfaces for managing HSM instances.

Implements a REST model with the following objects:

- [SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)")
- [SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)")

## Inherits

- Object

## Includes

- [Google::Cloud::Kms::V1::HsmManagement::Paths](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Paths)

## Methods

### .configure

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

Configure the HsmManagement Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client-Configuration "Google::Cloud::Kms::V1::HsmManagement::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client-Configuration))
**Example**

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

### #approve_single_tenant_hsm_instance_proposal

    def approve_single_tenant_hsm_instance_proposal(request, options = nil) -> ::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse
    def approve_single_tenant_hsm_instance_proposal(name: nil, quorum_reply: nil, required_action_quorum_reply: nil) -> ::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse

Approves a
[SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)")
for a given
[SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)"). The
proposal must be in the
[PENDING](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal-State#Google__Cloud__Kms__V1__SingleTenantHsmInstanceProposal__State__PENDING "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::State::PENDING (constant)")
state.
**Overloads**

    def approve_single_tenant_hsm_instance_proposal(request, options = nil) -> ::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse

Pass arguments to `approve_single_tenant_hsm_instance_proposal` via a request object, either of type [ApproveSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ApproveSingleTenantHsmInstanceProposalRequest "Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ApproveSingleTenantHsmInstanceProposalRequest), ::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 approve_single_tenant_hsm_instance_proposal(name: nil, quorum_reply: nil, required_action_quorum_reply: nil) -> ::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse

Pass arguments to `approve_single_tenant_hsm_instance_proposal` 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 [name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal#Google__Cloud__Kms__V1__SingleTenantHsmInstanceProposal_name_instance_ "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal#name (method)") of the [SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to approve.
- **quorum_reply** ([::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest::QuorumReply](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ApproveSingleTenantHsmInstanceProposalRequest-QuorumReply), ::Hash) --- Required. The reply to [QuorumParameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal-QuorumParameters "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::QuorumParameters (class)") for approving the proposal.


  Note: The following parameters are mutually exclusive: `quorum_reply`, `required_action_quorum_reply`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
- **required_action_quorum_reply** ([::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalRequest::RequiredActionQuorumReply](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ApproveSingleTenantHsmInstanceProposalRequest-RequiredActionQuorumReply), ::Hash) --- Required. The reply to [RequiredActionQuorumParameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal-RequiredActionQuorumParameters "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RequiredActionQuorumParameters (class)") for approving the proposal.


  Note: The following parameters are mutually exclusive: `required_action_quorum_reply`, `quorum_reply`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ApproveSingleTenantHsmInstanceProposalResponse))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ApproveSingleTenantHsmInstanceProposalResponse))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/kms/v1"

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

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

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

# The returned object is of type Google::Cloud::Kms::V1::ApproveSingleTenantHsmInstanceProposalResponse.
p result
```

### #configure

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

Configure the HsmManagement 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client#Google__Cloud__Kms__V1__HsmManagement__Client_configure_class_ "Google::Cloud::Kms::V1::HsmManagement::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client-Configuration "Google::Cloud::Kms::V1::HsmManagement::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client-Configuration))

### #create_single_tenant_hsm_instance

    def create_single_tenant_hsm_instance(request, options = nil) -> ::Gapic::Operation
    def create_single_tenant_hsm_instance(parent: nil, single_tenant_hsm_instance_id: nil, single_tenant_hsm_instance: nil) -> ::Gapic::Operation

Creates a new
[SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)") in a
given Project and Location. User must create a RegisterTwoFactorAuthKeys
proposal with this single-tenant HSM instance to finish setup of the
instance.
**Overloads**

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

Pass arguments to `create_single_tenant_hsm_instance` via a request object, either of type [CreateSingleTenantHsmInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-CreateSingleTenantHsmInstanceRequest "Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-CreateSingleTenantHsmInstanceRequest), ::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_single_tenant_hsm_instance(parent: nil, single_tenant_hsm_instance_id: nil, single_tenant_hsm_instance: nil) -> ::Gapic::Operation

Pass arguments to `create_single_tenant_hsm_instance` 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 resource name of the location associated with the [SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)"), in the format `projects/*/locations/*`.
- **single_tenant_hsm_instance_id** (::String) --- Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`.
- **single_tenant_hsm_instance** ([::Google::Cloud::Kms::V1::SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance), ::Hash) --- Required. An [SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)") with initial field values.
**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

```ruby
require "google/cloud/kms/v1"

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

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

# Call the create_single_tenant_hsm_instance method.
result = client.create_single_tenant_hsm_instance 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_single_tenant_hsm_instance_proposal

    def create_single_tenant_hsm_instance_proposal(request, options = nil) -> ::Gapic::Operation
    def create_single_tenant_hsm_instance_proposal(parent: nil, single_tenant_hsm_instance_proposal_id: nil, single_tenant_hsm_instance_proposal: nil) -> ::Gapic::Operation

Creates a new
[SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)")
for a given
[SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)").
**Overloads**

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

Pass arguments to `create_single_tenant_hsm_instance_proposal` via a request object, either of type [CreateSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-CreateSingleTenantHsmInstanceProposalRequest "Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceProposalRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Kms::V1::CreateSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-CreateSingleTenantHsmInstanceProposalRequest), ::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_single_tenant_hsm_instance_proposal(parent: nil, single_tenant_hsm_instance_proposal_id: nil, single_tenant_hsm_instance_proposal: nil) -> ::Gapic::Operation

Pass arguments to `create_single_tenant_hsm_instance_proposal` 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 [name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance#Google__Cloud__Kms__V1__SingleTenantHsmInstance_name_instance_ "Google::Cloud::Kms::V1::SingleTenantHsmInstance#name (method)") of the [SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)") associated with the [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)").
- **single_tenant_hsm_instance_proposal_id** (::String) --- Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`.
- **single_tenant_hsm_instance_proposal** ([::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal), ::Hash) --- Required. The [SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") 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

```ruby
require "google/cloud/kms/v1"

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

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

# Call the create_single_tenant_hsm_instance_proposal method.
result = client.create_single_tenant_hsm_instance_proposal 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_single_tenant_hsm_instance_proposal

    def delete_single_tenant_hsm_instance_proposal(request, options = nil) -> ::Google::Protobuf::Empty
    def delete_single_tenant_hsm_instance_proposal(name: nil) -> ::Google::Protobuf::Empty

Deletes a
[SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)").
**Overloads**

    def delete_single_tenant_hsm_instance_proposal(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_single_tenant_hsm_instance_proposal` via a request object, either of type [DeleteSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-DeleteSingleTenantHsmInstanceProposalRequest "Google::Cloud::Kms::V1::DeleteSingleTenantHsmInstanceProposalRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Kms::V1::DeleteSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-DeleteSingleTenantHsmInstanceProposalRequest), ::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_single_tenant_hsm_instance_proposal(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_single_tenant_hsm_instance_proposal` 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 [name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal#Google__Cloud__Kms__V1__SingleTenantHsmInstanceProposal_name_instance_ "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal#name (method)") of the [SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to delete.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Protobuf-Empty))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Protobuf-Empty))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/kms/v1"

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

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

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

# The returned object is of type Google::Protobuf::Empty.
p result
```

### #execute_single_tenant_hsm_instance_proposal

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

Executes a
[SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)")
for a given
[SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)"). The
proposal must be in the
[APPROVED](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal-State#Google__Cloud__Kms__V1__SingleTenantHsmInstanceProposal__State__APPROVED "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::State::APPROVED (constant)")
state.
**Overloads**

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

Pass arguments to `execute_single_tenant_hsm_instance_proposal` via a request object, either of type [ExecuteSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ExecuteSingleTenantHsmInstanceProposalRequest "Google::Cloud::Kms::V1::ExecuteSingleTenantHsmInstanceProposalRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Kms::V1::ExecuteSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ExecuteSingleTenantHsmInstanceProposalRequest), ::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 execute_single_tenant_hsm_instance_proposal(name: nil) -> ::Gapic::Operation

Pass arguments to `execute_single_tenant_hsm_instance_proposal` 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 [name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal#Google__Cloud__Kms__V1__SingleTenantHsmInstanceProposal_name_instance_ "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal#name (method)") of the [SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to execute.
**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

```ruby
require "google/cloud/kms/v1"

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

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

# Call the execute_single_tenant_hsm_instance_proposal method.
result = client.execute_single_tenant_hsm_instance_proposal 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_single_tenant_hsm_instance

    def get_single_tenant_hsm_instance(request, options = nil) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstance
    def get_single_tenant_hsm_instance(name: nil) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstance

Returns metadata for a given
[SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)").
**Overloads**

    def get_single_tenant_hsm_instance(request, options = nil) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstance

Pass arguments to `get_single_tenant_hsm_instance` via a request object, either of type [GetSingleTenantHsmInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-GetSingleTenantHsmInstanceRequest "Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-GetSingleTenantHsmInstanceRequest), ::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_single_tenant_hsm_instance(name: nil) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstance

Pass arguments to `get_single_tenant_hsm_instance` 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 [name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance#Google__Cloud__Kms__V1__SingleTenantHsmInstance_name_instance_ "Google::Cloud::Kms::V1::SingleTenantHsmInstance#name (method)") of the [SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)") to get.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Kms::V1::SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Kms::V1::SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/kms/v1"

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

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

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

# The returned object is of type Google::Cloud::Kms::V1::SingleTenantHsmInstance.
p result
```

### #get_single_tenant_hsm_instance_proposal

    def get_single_tenant_hsm_instance_proposal(request, options = nil) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal
    def get_single_tenant_hsm_instance_proposal(name: nil) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal

Returns metadata for a given
[SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)").
**Overloads**

    def get_single_tenant_hsm_instance_proposal(request, options = nil) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal

Pass arguments to `get_single_tenant_hsm_instance_proposal` via a request object, either of type [GetSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-GetSingleTenantHsmInstanceProposalRequest "Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceProposalRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Kms::V1::GetSingleTenantHsmInstanceProposalRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-GetSingleTenantHsmInstanceProposalRequest), ::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_single_tenant_hsm_instance_proposal(name: nil) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal

Pass arguments to `get_single_tenant_hsm_instance_proposal` 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 [name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal#Google__Cloud__Kms__V1__SingleTenantHsmInstanceProposal_name_instance_ "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal#name (method)") of the [SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to get.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/kms/v1"

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

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

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

# The returned object is of type Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal.
p result
```

### #iam_policy_client

    def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.
**Returns**

- (Google::Iam::V1::IAMPolicy::Client)

### #initialize

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

Create a new HsmManagement client object.
**Yields**

- (config) --- Configure the HsmManagement client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client)) --- a new instance of Client
**Example**

```ruby
# Create a client using the default configuration
client = ::Google::Cloud::Kms::V1::HsmManagement::Client.new

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

### #list_single_tenant_hsm_instance_proposals

    def list_single_tenant_hsm_instance_proposals(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal>
    def list_single_tenant_hsm_instance_proposals(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal>

Lists
[SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)").
**Overloads**

    def list_single_tenant_hsm_instance_proposals(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal>

Pass arguments to `list_single_tenant_hsm_instance_proposals` via a request object, either of type [ListSingleTenantHsmInstanceProposalsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsRequest "Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsRequest), ::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_single_tenant_hsm_instance_proposals(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal>

Pass arguments to `list_single_tenant_hsm_instance_proposals` 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 resource name of the single tenant HSM instance associated with the [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`.
- **page_size** (::Integer) --- Optional. Optional limit on the number of [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") to include in the response. Further [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") can subsequently be obtained by including the [ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstanceProposalsResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token (method)") in a subsequent request. If unspecified, the server will pick an appropriate default.
- **page_token** (::String) --- Optional. Optional pagination token, returned earlier via [ListSingleTenantHsmInstanceProposalsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstanceProposalsResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstanceProposalsResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstanceProposalsResponse#next_page_token (method)").
- **filter** (::String) --- Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list
  results](https://cloud.google.com/kms/docs/sorting-and-filtering).
- **order_by** (::String) --- Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list
  results](https://cloud.google.com/kms/docs/sorting-and-filtering).
- **show_deleted** (::Boolean) --- Optional. If set to true, [HsmManagement.ListSingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client#Google__Cloud__Kms__V1__HsmManagement__Client_list_single_tenant_hsm_instance_proposals_instance_ "Google::Cloud::Kms::V1::HsmManagement::Client#list_single_tenant_hsm_instance_proposals (method)") will also return [SingleTenantHsmInstanceProposals](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal "Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (class)") in DELETED state.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::PagedEnumerable\<[::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal)\>)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::PagedEnumerable\<[::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstanceProposal)\>)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/kms/v1"

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

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

# Call the list_single_tenant_hsm_instance_proposals method.
result = client.list_single_tenant_hsm_instance_proposals 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::Kms::V1::SingleTenantHsmInstanceProposal.
  p item
end
```

### #list_single_tenant_hsm_instances

    def list_single_tenant_hsm_instances(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstance>
    def list_single_tenant_hsm_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstance>

Lists
[SingleTenantHsmInstances](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)").
**Overloads**

    def list_single_tenant_hsm_instances(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstance>

Pass arguments to `list_single_tenant_hsm_instances` via a request object, either of type [ListSingleTenantHsmInstancesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstancesRequest "Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstancesRequest), ::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_single_tenant_hsm_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::SingleTenantHsmInstance>

Pass arguments to `list_single_tenant_hsm_instances` 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 resource name of the location associated with the [SingleTenantHsmInstances](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)") to list, in the format `projects/*/locations/*`.
- **page_size** (::Integer) --- Optional. Optional limit on the number of [SingleTenantHsmInstances](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)") to include in the response. Further [SingleTenantHsmInstances](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)") can subsequently be obtained by including the [ListSingleTenantHsmInstancesResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstancesResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstancesResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesResponse#next_page_token (method)") in a subsequent request. If unspecified, the server will pick an appropriate default.
- **page_token** (::String) --- Optional. Optional pagination token, returned earlier via [ListSingleTenantHsmInstancesResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-ListSingleTenantHsmInstancesResponse#Google__Cloud__Kms__V1__ListSingleTenantHsmInstancesResponse_next_page_token_instance_ "Google::Cloud::Kms::V1::ListSingleTenantHsmInstancesResponse#next_page_token (method)").
- **filter** (::String) --- Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list
  results](https://cloud.google.com/kms/docs/sorting-and-filtering).
- **order_by** (::String) --- Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list
  results](https://cloud.google.com/kms/docs/sorting-and-filtering).
- **show_deleted** (::Boolean) --- Optional. If set to true, [HsmManagement.ListSingleTenantHsmInstances](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Client#Google__Cloud__Kms__V1__HsmManagement__Client_list_single_tenant_hsm_instances_instance_ "Google::Cloud::Kms::V1::HsmManagement::Client#list_single_tenant_hsm_instances (method)") will also return [SingleTenantHsmInstances](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance "Google::Cloud::Kms::V1::SingleTenantHsmInstance (class)") in DELETED state.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::PagedEnumerable\<[::Google::Cloud::Kms::V1::SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance)\>)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::PagedEnumerable\<[::Google::Cloud::Kms::V1::SingleTenantHsmInstance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-SingleTenantHsmInstance)\>)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/kms/v1"

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

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

# Call the list_single_tenant_hsm_instances method.
result = client.list_single_tenant_hsm_instances 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::Kms::V1::SingleTenantHsmInstance.
  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)

### #logger

    def logger() -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #operations_client

    def operations_client() -> ::Google::Cloud::Kms::V1::HsmManagement::Operations

Get the associated client for long-running operations.
**Returns**

- ([::Google::Cloud::Kms::V1::HsmManagement::Operations](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-kms-v1/latest/Google-Cloud-Kms-V1-HsmManagement-Operations))

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)