Class: Google::Cloud::FinancialServices::V1::Instance

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

Overview

Instance is a container for the rest of API resources. Only resources in the same instance can interact with each other. Child resources inherit the location (data residency) and encryption (CMEK). The location of the provided input and output in requests must match the location of the instance.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when the Instance was created. Assigned by the server.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/financialservices/v1/instance.rb', line 54

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Resource State
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#kms_key ⇒ ::String

Returns Required. The KMS key name used for CMEK (encryption-at-rest). format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} VPC-SC restrictions apply.

Returns:

  • (::String) —

    Required. The KMS key name used for CMEK (encryption-at-rest). format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} VPC-SC restrictions apply.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/financialservices/v1/instance.rb', line 54

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Resource State
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/financialservices/v1/instance.rb', line 54

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Resource State
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The full path to the Instance resource in this API. format: projects/{project}/locations/{location}/instances/{instance}.

Returns:

  • (::String) —

    Output only. The full path to the Instance resource in this API. format: projects/{project}/locations/{location}/instances/{instance}



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/financialservices/v1/instance.rb', line 54

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Resource State
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#state ⇒ ::Google::Cloud::FinancialServices::V1::Instance::State (readonly)

Returns Output only. State of the instance. Assigned by the server.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/financialservices/v1/instance.rb', line 54

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Resource State
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

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

Returns Output only. Timestamp when the Instance was last updated. Assigned by the server.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/financialservices/v1/instance.rb', line 54

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Resource State
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end