Reference documentation and code samples for the Financial Services V1 API class Google::Cloud::FinancialServices::V1::Instance.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when the Instance was created. Assigned by the server.
#kms_key
def kms_key() -> ::String
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.
#kms_key=
def kms_key=(value) -> ::String
Parameter
-
value (::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.
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.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Labels
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels
#name
def name() -> ::String
Returns
-
(::String) — Output only. The full path to the Instance resource in this API.
format:
projects/{project}/locations/{location}/instances/{instance}
#state
def state() -> ::Google::Cloud::FinancialServices::V1::Instance::State
Returns
- (::Google::Cloud::FinancialServices::V1::Instance::State) — Output only. State of the instance. Assigned by the server.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when the Instance was last updated. Assigned by the server.