value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
Returns
(::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
#name
defname()->::String
Returns
(::String) — Optional. A unique identifier for an instance. The name should be of the
format:
projects/{project_number}/locations/{location_id}/instances/{instance_id}
project_number: Maps to a unique int64 id assigned to each project.
location_id: Refers to the region where the instance will be deployed.
Since Secure Source Manager is a regional service, it must be one of the
valid GCP regions.
instance_id: User provided name for the instance, must be unique for a
project_number and location_id combination.
#name=
defname=(value)->::String
Parameter
value (::String) — Optional. A unique identifier for an instance. The name should be of the
format:
projects/{project_number}/locations/{location_id}/instances/{instance_id}
project_number: Maps to a unique int64 id assigned to each project.
location_id: Refers to the region where the instance will be deployed.
Since Secure Source Manager is a regional service, it must be one of the
valid GCP regions.
instance_id: User provided name for the instance, must be unique for a
project_number and location_id combination.
Returns
(::String) — Optional. A unique identifier for an instance. The name should be of the
format:
projects/{project_number}/locations/{location_id}/instances/{instance_id}
project_number: Maps to a unique int64 id assigned to each project.
location_id: Refers to the region where the instance will be deployed.
Since Secure Source Manager is a regional service, it must be one of the
valid GCP regions.
instance_id: User provided name for the instance, must be unique for a
project_number and location_id combination.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Secure Source Manager V1 API - Class Google::Cloud::SecureSourceManager::V1::Instance (v2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Cloud-SecureSourceManager-V1-Instance)\n- [2.2.0](/ruby/docs/reference/google-cloud-secure_source_manager-v1/2.2.0/Google-Cloud-SecureSourceManager-V1-Instance)\n- [2.1.0](/ruby/docs/reference/google-cloud-secure_source_manager-v1/2.1.0/Google-Cloud-SecureSourceManager-V1-Instance)\n- [2.0.1](/ruby/docs/reference/google-cloud-secure_source_manager-v1/2.0.1/Google-Cloud-SecureSourceManager-V1-Instance)\n- [1.3.0](/ruby/docs/reference/google-cloud-secure_source_manager-v1/1.3.0/Google-Cloud-SecureSourceManager-V1-Instance)\n- [1.2.0](/ruby/docs/reference/google-cloud-secure_source_manager-v1/1.2.0/Google-Cloud-SecureSourceManager-V1-Instance)\n- [1.1.0](/ruby/docs/reference/google-cloud-secure_source_manager-v1/1.1.0/Google-Cloud-SecureSourceManager-V1-Instance)\n- [1.0.1](/ruby/docs/reference/google-cloud-secure_source_manager-v1/1.0.1/Google-Cloud-SecureSourceManager-V1-Instance)\n- [0.4.0](/ruby/docs/reference/google-cloud-secure_source_manager-v1/0.4.0/Google-Cloud-SecureSourceManager-V1-Instance)\n- [0.3.0](/ruby/docs/reference/google-cloud-secure_source_manager-v1/0.3.0/Google-Cloud-SecureSourceManager-V1-Instance)\n- [0.2.2](/ruby/docs/reference/google-cloud-secure_source_manager-v1/0.2.2/Google-Cloud-SecureSourceManager-V1-Instance)\n- [0.1.0](/ruby/docs/reference/google-cloud-secure_source_manager-v1/0.1.0/Google-Cloud-SecureSourceManager-V1-Instance) \nReference documentation and code samples for the Secure Source Manager V1 API class Google::Cloud::SecureSourceManager::V1::Instance.\n\nA resource that represents a Secure Source Manager instance. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Create timestamp.\n\n### #host_config\n\n def host_config() -\u003e ::Google::Cloud::SecureSourceManager::V1::Instance::HostConfig\n\n**Returns**\n\n- ([::Google::Cloud::SecureSourceManager::V1::Instance::HostConfig](./Google-Cloud-SecureSourceManager-V1-Instance-HostConfig)) --- Output only. A list of hostnames for this instance.\n\n### #kms_key\n\n def kms_key() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/* /keyRings/*/cryptoKeys/*.\n\n### #kms_key=\n\n def kms_key=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/* /keyRings/*/cryptoKeys/*. \n**Returns**\n\n- (::String) --- Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/* /keyRings/*/cryptoKeys/*.\n\n### #labels\n\n def labels() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Labels as key value pairs.\n\n### #labels=\n\n def labels=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Labels as key value pairs. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Labels as key value pairs.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. A unique identifier for an instance. The name should be of the format: `projects/{project_number}/locations/{location_id}/instances/{instance_id}`\n\n\n `project_number`: Maps to a unique int64 id assigned to each project.\n\n `location_id`: Refers to the region where the instance will be deployed.\n Since Secure Source Manager is a regional service, it must be one of the\n valid GCP regions.\n\n `instance_id`: User provided name for the instance, must be unique for a\n project_number and location_id combination.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. A unique identifier for an instance. The name should be of the format: `projects/{project_number}/locations/{location_id}/instances/{instance_id}`\n\n\n `project_number`: Maps to a unique int64 id assigned to each project.\n\n `location_id`: Refers to the region where the instance will be deployed.\n Since Secure Source Manager is a regional service, it must be one of the\n valid GCP regions.\n\n `instance_id`: User provided name for the instance, must be unique for a\nproject_number and location_id combination. \n**Returns**\n\n- (::String) --- Optional. A unique identifier for an instance. The name should be of the format: `projects/{project_number}/locations/{location_id}/instances/{instance_id}`\n\n\n `project_number`: Maps to a unique int64 id assigned to each project.\n\n `location_id`: Refers to the region where the instance will be deployed.\n Since Secure Source Manager is a regional service, it must be one of the\n valid GCP regions.\n\n `instance_id`: User provided name for the instance, must be unique for a\n project_number and location_id combination.\n\n### #private_config\n\n def private_config() -\u003e ::Google::Cloud::SecureSourceManager::V1::Instance::PrivateConfig\n\n**Returns**\n\n- ([::Google::Cloud::SecureSourceManager::V1::Instance::PrivateConfig](./Google-Cloud-SecureSourceManager-V1-Instance-PrivateConfig)) --- Optional. Private settings for private instance.\n\n### #private_config=\n\n def private_config=(value) -\u003e ::Google::Cloud::SecureSourceManager::V1::Instance::PrivateConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::SecureSourceManager::V1::Instance::PrivateConfig](./Google-Cloud-SecureSourceManager-V1-Instance-PrivateConfig)) --- Optional. Private settings for private instance. \n**Returns**\n\n- ([::Google::Cloud::SecureSourceManager::V1::Instance::PrivateConfig](./Google-Cloud-SecureSourceManager-V1-Instance-PrivateConfig)) --- Optional. Private settings for private instance.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::SecureSourceManager::V1::Instance::State\n\n**Returns**\n\n- ([::Google::Cloud::SecureSourceManager::V1::Instance::State](./Google-Cloud-SecureSourceManager-V1-Instance-State)) --- Output only. Current state of the instance.\n\n### #state_note\n\n def state_note() -\u003e ::Google::Cloud::SecureSourceManager::V1::Instance::StateNote\n\n**Returns**\n\n- ([::Google::Cloud::SecureSourceManager::V1::Instance::StateNote](./Google-Cloud-SecureSourceManager-V1-Instance-StateNote)) --- Output only. An optional field providing information about the current instance state.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Update timestamp.\n\n### #workforce_identity_federation_config\n\n def workforce_identity_federation_config() -\u003e ::Google::Cloud::SecureSourceManager::V1::Instance::WorkforceIdentityFederationConfig\n\n**Returns**\n\n- ([::Google::Cloud::SecureSourceManager::V1::Instance::WorkforceIdentityFederationConfig](./Google-Cloud-SecureSourceManager-V1-Instance-WorkforceIdentityFederationConfig)) --- Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP.\n\n### #workforce_identity_federation_config=\n\n def workforce_identity_federation_config=(value) -\u003e ::Google::Cloud::SecureSourceManager::V1::Instance::WorkforceIdentityFederationConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::SecureSourceManager::V1::Instance::WorkforceIdentityFederationConfig](./Google-Cloud-SecureSourceManager-V1-Instance-WorkforceIdentityFederationConfig)) --- Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP. \n**Returns**\n\n- ([::Google::Cloud::SecureSourceManager::V1::Instance::WorkforceIdentityFederationConfig](./Google-Cloud-SecureSourceManager-V1-Instance-WorkforceIdentityFederationConfig)) --- Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP."]]
