Class: Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/kms/v1/hsm_management.rb

Overview

A SingleTenantHsmInstanceProposal represents a proposal to perform an operation on a SingleTenantHsmInstance.

Defined Under Namespace

Modules: State Classes: AddQuorumMember, DeleteSingleTenantHsmInstance, DisableSingleTenantHsmInstance, EnableSingleTenantHsmInstance, QuorumParameters, RefreshSingleTenantHsmInstance, RegisterTwoFactorAuthKeys, RemoveQuorumMember, RequiredActionQuorumParameters

Instance Attribute Summary collapse

Instance Attribute Details

#add_quorum_member ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::AddQuorumMember

Returns Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Note: The following fields are mutually exclusive: add_quorum_member, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the SingleTenantHsmInstanceProposal was created.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#delete_single_tenant_hsm_instance ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DeleteSingleTenantHsmInstance

Returns Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

Note: The following fields are mutually exclusive: delete_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#delete_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#disable_single_tenant_hsm_instance ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DisableSingleTenantHsmInstance

Returns Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Note: The following fields are mutually exclusive: disable_single_tenant_hsm_instance, register_two_factor_auth_keys, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#enable_single_tenant_hsm_instance ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::EnableSingleTenantHsmInstance

Returns Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.

Note: The following fields are mutually exclusive: enable_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp

Returns The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.

Note: The following fields are mutually exclusive: expire_time, ttl. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#failure_reason ⇒ ::String (readonly)

Returns Output only. The root cause of the most recent failure. Only present if state is [FAILED][SingleTenantHsmInstanceProposal.FAILED].

Returns:

  • (::String) —

    Output only. The root cause of the most recent failure. Only present if state is [FAILED][SingleTenantHsmInstanceProposal.FAILED].



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#name ⇒ ::String

Returns Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.

Returns:

  • (::String) —

    Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#purge_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#quorum_parameters ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::QuorumParameters (readonly)

Returns Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

Note: The following fields are mutually exclusive: quorum_parameters, required_action_quorum_parameters. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#refresh_single_tenant_hsm_instance ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RefreshSingleTenantHsmInstance

Returns Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Note: The following fields are mutually exclusive: refresh_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#register_two_factor_auth_keys ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RegisterTwoFactorAuthKeys

Returns Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

Note: The following fields are mutually exclusive: register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#remove_quorum_member ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RemoveQuorumMember

Returns Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

Note: The following fields are mutually exclusive: remove_quorum_member, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#required_action_quorum_parameters ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RequiredActionQuorumParameters (readonly)

Returns Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.

Note: The following fields are mutually exclusive: required_action_quorum_parameters, quorum_parameters. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#state ⇒ ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::State (readonly)

Returns Output only. The state of the SingleTenantHsmInstanceProposal.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end

#ttl ⇒ ::Google::Protobuf::Duration

Returns Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

Note: The following fields are mutually exclusive: ttl, expire_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::Duration) —

    Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

    Note: The following fields are mutually exclusive: ttl, expire_time. If a field in that set is populated, all other fields in the set will automatically be cleared.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/kms/v1/hsm_management.rb', line 309

class SingleTenantHsmInstanceProposal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters of quorum approval for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required numbers of approvers. This is the M value used
  #     for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class QuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for an approval that has both required challenges and a
  # quorum.
  # @!attribute [r] required_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. A list of specific challenges that must be signed.
  #     For some operations, this will contain a single challenge.
  # @!attribute [r] required_approver_count
  #   @return [::Integer]
  #     Output only. The required number of quorum approvers. This is the M value
  #     used for M of N quorum auth. It is less than the number of public keys.
  # @!attribute [r] quorum_challenges
  #   @return [::Array<::Google::Cloud::Kms::V1::Challenge>]
  #     Output only. The challenges to be signed by 2FA keys for quorum auth. M
  #     of N of these challenges are required to be signed to approve the
  #     operation.
  # @!attribute [r] approved_two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Output only. The public keys associated with the 2FA keys that have
  #     already approved the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
  #     by signing the challenge.
  class RequiredActionQuorumParameters
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Register 2FA keys for the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation requires all Challenges to be signed by 2FA keys. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::PENDING_TWO_FACTOR_AUTH_REGISTRATION PENDING_TWO_FACTOR_AUTH_REGISTRATION}
  # state to perform this operation.
  # @!attribute [rw] required_approver_count
  #   @return [::Integer]
  #     Required. The required numbers of approvers to set for the
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  #     This is the M value used for M of N quorum auth. Must be greater than or
  #     equal to 2 and less than or equal to
  #     {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  #     - 1.
  # @!attribute [rw] two_factor_public_key_pems
  #   @return [::Array<::String>]
  #     Required. The public keys associated with the 2FA keys for M of N quorum
  #     auth. Public keys must be associated with RSA 2048 keys.
  class RegisterTwoFactorAuthKeys
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Disable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class DisableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DISABLED DISABLED}
  # state to perform this operation.
  class EnableSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Delete the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # Deleting a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} will
  # make all {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} attached to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # unusable. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # not be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETING DELETING} or
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::DELETED DELETED} state
  # to perform this operation.
  class DeleteSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Add a quorum member to the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will increase the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the new quorum
  #     member to add. Public keys must be associated with RSA 2048 keys.
  class AddQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Remove a quorum member from the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This will reduce
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth#total_approver_count total_approver_count}
  # by 1. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  # @!attribute [rw] two_factor_public_key_pem
  #   @return [::String]
  #     Required. The public key associated with the 2FA key for the quorum
  #     member to remove. Public keys must be associated with RSA 2048 keys.
  class RemoveQuorumMember
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Refreshes the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}.
  # This operation must be performed periodically to keep the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance}
  # active. This operation must be performed before
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance#unrefreshed_duration_until_disable unrefreshed_duration_until_disable}
  # has passed. The
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance SingleTenantHsmInstance} must
  # be in the
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State::ACTIVE ACTIVE} state to
  # perform this operation.
  class RefreshSingleTenantHsmInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The set of states of a
  # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being created.
    CREATING = 1

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is pending approval.
    PENDING = 2

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been approved.
    APPROVED = 3

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # is being executed.
    RUNNING = 4

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been executed successfully.
    SUCCEEDED = 5

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has failed.
    FAILED = 6

    # The
    # {::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal}
    # has been deleted and will be purged after the purge_time.
    DELETED = 7
  end
end