Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client (v2.3.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client.

Client for the IdentityMappingStoreService service.

Service for managing Identity Mapping Stores.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the IdentityMappingStoreService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all IdentityMappingStoreService clients
::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the IdentityMappingStoreService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_identity_mapping_store

def create_identity_mapping_store(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore
def create_identity_mapping_store(cmek_config_name: nil, disable_cmek: nil, parent: nil, identity_mapping_store_id: nil, identity_mapping_store: nil) -> ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore

Creates a new Identity Mapping Store.

Overloads 
def create_identity_mapping_store(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore
Pass arguments to create_identity_mapping_store via a request object, either of type CreateIdentityMappingStoreRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::CreateIdentityMappingStoreRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_identity_mapping_store(cmek_config_name: nil, disable_cmek: nil, parent: nil, identity_mapping_store_id: nil, identity_mapping_store: nil) -> ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore
Pass arguments to create_identity_mapping_store via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • cmek_config_name (::String) — Resource name of the CmekConfig to use for protecting this Identity Mapping Store.

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

  • disable_cmek (::Boolean) — Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

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

  • parent (::String) — Required. The parent collection resource name, such as projects/{project}/locations/{location}.
  • identity_mapping_store_id (::String) — Required. The ID of the Identity Mapping Store to create.

    The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

  • identity_mapping_store (::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore, ::Hash) — Required. The Identity Mapping Store to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

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

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

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

# The returned object is of type Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore.
p result

#delete_identity_mapping_store

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

Deletes the Identity Mapping Store.

Overloads 
def delete_identity_mapping_store(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_identity_mapping_store via a request object, either of type DeleteIdentityMappingStoreRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::DeleteIdentityMappingStoreRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_identity_mapping_store(name: nil) -> ::Gapic::Operation
Pass arguments to delete_identity_mapping_store via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Identity Mapping Store to delete. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_identity_mapping_store

def get_identity_mapping_store(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore
def get_identity_mapping_store(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore

Gets the Identity Mapping Store.

Overloads 
def get_identity_mapping_store(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore
Pass arguments to get_identity_mapping_store via a request object, either of type GetIdentityMappingStoreRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::GetIdentityMappingStoreRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_identity_mapping_store(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore
Pass arguments to get_identity_mapping_store via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Identity Mapping Store to get. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

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

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

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

# The returned object is of type Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore.
p result

#import_identity_mappings

def import_identity_mappings(request, options = nil) -> ::Gapic::Operation
def import_identity_mappings(inline_source: nil, identity_mapping_store: nil) -> ::Gapic::Operation

Imports a list of Identity Mapping Entries to an Identity Mapping Store.

Overloads 
def import_identity_mappings(request, options = nil) -> ::Gapic::Operation
Pass arguments to import_identity_mappings via a request object, either of type Google::Cloud::DiscoveryEngine::V1::ImportIdentityMappingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::ImportIdentityMappingsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def import_identity_mappings(inline_source: nil, identity_mapping_store: nil) -> ::Gapic::Operation
Pass arguments to import_identity_mappings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#initialize

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

Create a new IdentityMappingStoreService client object.

Yields
  • (config) — Configure the IdentityMappingStoreService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client.new

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

#list_identity_mapping_stores

def list_identity_mapping_stores(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore>
def list_identity_mapping_stores(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore>

Lists all Identity Mapping Stores.

Overloads 
def list_identity_mapping_stores(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore>
Pass arguments to list_identity_mapping_stores via a request object, either of type ListIdentityMappingStoresRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::ListIdentityMappingStoresRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_identity_mapping_stores(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore>
Pass arguments to list_identity_mapping_stores via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent of the Identity Mapping Stores to list. Format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListIdentityMappingStores call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListIdentityMappingStores must match the call that provided the page token.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore.
  p item
end

#list_identity_mappings

def list_identity_mappings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>
def list_identity_mappings(identity_mapping_store: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>

Lists Identity Mappings in an Identity Mapping Store.

Overloads 
def list_identity_mappings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>
Pass arguments to list_identity_mappings via a request object, either of type ListIdentityMappingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::ListIdentityMappingsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_identity_mappings(identity_mapping_store: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>
Pass arguments to list_identity_mappings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • identity_mapping_store (::String) — Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
  • page_size (::Integer) — Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.
  • page_token (::String) — A page token, received from a previous ListIdentityMappings call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListIdentityMappings must match the call that provided the page token.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Operations

Get the associated client for long-running operations.

Returns

#purge_identity_mappings

def purge_identity_mappings(request, options = nil) -> ::Gapic::Operation
def purge_identity_mappings(inline_source: nil, identity_mapping_store: nil, filter: nil, force: nil) -> ::Gapic::Operation

Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

Overloads 
def purge_identity_mappings(request, options = nil) -> ::Gapic::Operation
Pass arguments to purge_identity_mappings via a request object, either of type PurgeIdentityMappingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def purge_identity_mappings(inline_source: nil, identity_mapping_store: nil, filter: nil, force: nil) -> ::Gapic::Operation
Pass arguments to purge_identity_mappings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • inline_source (::Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest::InlineSource, ::Hash) — The inline source to purge identity mapping entries from.
  • identity_mapping_store (::String) — Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
  • filter (::String) — Filter matching identity mappings to purge. The eligible field for filtering is:

    • update_time: in ISO 8601 "zulu" format.
    • external_id

    Examples:

    • Deleting all identity mappings updated in a time range: update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"
    • Deleting all identity mappings for a given external_id: external_id = "id1"
    • Deleting all identity mappings inside an identity mapping store: *

    The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided.

  • force (::Boolean) — Actually performs the purge. If force is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)