Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::ActionConfig (v2.14.0)

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

Informations to support actions on the connector.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#action_params

def action_params() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Optional. Action parameters in structured json format.

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

#action_params=

def action_params=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Optional. Action parameters in structured json format.

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

Returns
  • (::Google::Protobuf::Struct) — Optional. Action parameters in structured json format.

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

#create_bap_connection

def create_bap_connection() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether to create a BAP connection for the connector.

#create_bap_connection=

def create_bap_connection=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether to create a BAP connection for the connector.
Returns
  • (::Boolean) — Optional. Whether to create a BAP connection for the connector.

#is_action_configured

def is_action_configured() -> ::Boolean
Returns
  • (::Boolean) — Output only. The connector contains the necessary parameters and is configured to support actions.

#json_action_params

def json_action_params() -> ::String
Returns
  • (::String) — Optional. Action parameters in json string format.

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

#json_action_params=

def json_action_params=(value) -> ::String
Parameter
  • value (::String) — Optional. Action parameters in json string format.

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

Returns
  • (::String) — Optional. Action parameters in json string format.

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

#service_name

def service_name() -> ::String
Returns
  • (::String) — Optional. The Service Directory resource name (projects//locations//namespaces//services/) representing a VPC network endpoint used to connect to the data source's instance_uri, defined in DataConnector.params.

    Required when VPC Service Controls are enabled.

#service_name=

def service_name=(value) -> ::String
Parameter
  • value (::String) — Optional. The Service Directory resource name (projects//locations//namespaces//services/) representing a VPC network endpoint used to connect to the data source's instance_uri, defined in DataConnector.params.

    Required when VPC Service Controls are enabled.

Returns
  • (::String) — Optional. The Service Directory resource name (projects//locations//namespaces//services/) representing a VPC network endpoint used to connect to the data source's instance_uri, defined in DataConnector.params.

    Required when VPC Service Controls are enabled.

#use_static_secrets

def use_static_secrets() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.

#use_static_secrets=

def use_static_secrets=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
Returns
  • (::Boolean) — Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.

#user_defined_scopes_mapping

def user_defined_scopes_mapping() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::ActionConfig::ScopeList}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::ActionConfig::ScopeList}) — Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.

#user_defined_scopes_mapping=

def user_defined_scopes_mapping=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::ActionConfig::ScopeList}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::ActionConfig::ScopeList}) — Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::ActionConfig::ScopeList}) — Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.