Class DataConnector.Builder (0.99.0)

public static final class DataConnector.Builder extends GeneratedMessage.Builder<DataConnector.Builder> implements DataConnectorOrBuilder

Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.

Protobuf type google.cloud.discoveryengine.v1.DataConnector

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAlertPolicyConfigs(AlertPolicyConfig value)

public DataConnector.Builder addAlertPolicyConfigs(AlertPolicyConfig value)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AlertPolicyConfig
Returns
Type Description
DataConnector.Builder

addAlertPolicyConfigs(AlertPolicyConfig.Builder builderForValue)

public DataConnector.Builder addAlertPolicyConfigs(AlertPolicyConfig.Builder builderForValue)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AlertPolicyConfig.Builder
Returns
Type Description
DataConnector.Builder

addAlertPolicyConfigs(int index, AlertPolicyConfig value)

public DataConnector.Builder addAlertPolicyConfigs(int index, AlertPolicyConfig value)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AlertPolicyConfig
Returns
Type Description
DataConnector.Builder

addAlertPolicyConfigs(int index, AlertPolicyConfig.Builder builderForValue)

public DataConnector.Builder addAlertPolicyConfigs(int index, AlertPolicyConfig.Builder builderForValue)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AlertPolicyConfig.Builder
Returns
Type Description
DataConnector.Builder

addAlertPolicyConfigsBuilder()

public AlertPolicyConfig.Builder addAlertPolicyConfigsBuilder()

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AlertPolicyConfig.Builder

addAlertPolicyConfigsBuilder(int index)

public AlertPolicyConfig.Builder addAlertPolicyConfigsBuilder(int index)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AlertPolicyConfig.Builder

addAllAlertPolicyConfigs(Iterable<? extends AlertPolicyConfig> values)

public DataConnector.Builder addAllAlertPolicyConfigs(Iterable<? extends AlertPolicyConfig> values)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.AlertPolicyConfig>
Returns
Type Description
DataConnector.Builder

addAllBlockingReasons(Iterable<? extends DataConnector.BlockingReason> values)

public DataConnector.Builder addAllBlockingReasons(Iterable<? extends DataConnector.BlockingReason> values)

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.DataConnector.BlockingReason>

The blockingReasons to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addAllBlockingReasonsValue(Iterable<Integer> values)

public DataConnector.Builder addAllBlockingReasonsValue(Iterable<Integer> values)

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for blockingReasons to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addAllConnectorModes(Iterable<? extends DataConnector.ConnectorMode> values)

public DataConnector.Builder addAllConnectorModes(Iterable<? extends DataConnector.ConnectorMode> values)

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.DataConnector.ConnectorMode>

The connectorModes to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addAllConnectorModesValue(Iterable<Integer> values)

public DataConnector.Builder addAllConnectorModesValue(Iterable<Integer> values)

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for connectorModes to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addAllDestinationConfigs(Iterable<? extends DestinationConfig> values)

public DataConnector.Builder addAllDestinationConfigs(Iterable<? extends DestinationConfig> values)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.DestinationConfig>
Returns
Type Description
DataConnector.Builder

addAllDynamicTools(Iterable<? extends DynamicTool> values)

public DataConnector.Builder addAllDynamicTools(Iterable<? extends DynamicTool> values)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.DynamicTool>
Returns
Type Description
DataConnector.Builder

addAllEgressFqdns(Iterable<String> values)

public DataConnector.Builder addAllEgressFqdns(Iterable<String> values)

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.

repeated string egress_fqdns = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The egressFqdns to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addAllEntities(Iterable<? extends DataConnector.SourceEntity> values)

public DataConnector.Builder addAllEntities(Iterable<? extends DataConnector.SourceEntity> values)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.DataConnector.SourceEntity>
Returns
Type Description
DataConnector.Builder

addAllErrors(Iterable<? extends Status> values)

public DataConnector.Builder addAllErrors(Iterable<? extends Status> values)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.rpc.Status>
Returns
Type Description
DataConnector.Builder

addAllOauthStaticIpAddresses(Iterable<String> values)

public DataConnector.Builder addAllOauthStaticIpAddresses(Iterable<String> values)

Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

repeated string oauth_static_ip_addresses = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The oauthStaticIpAddresses to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addAllRemoveParamKeys(Iterable<String> values)

public DataConnector.Builder addAllRemoveParamKeys(Iterable<String> values)

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.

repeated string remove_param_keys = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The removeParamKeys to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addAllStaticIpAddresses(Iterable<String> values)

public DataConnector.Builder addAllStaticIpAddresses(Iterable<String> values)

Output only. The static IP addresses used by this connector.

repeated string static_ip_addresses = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The staticIpAddresses to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addBlockingReasons(DataConnector.BlockingReason value)

public DataConnector.Builder addBlockingReasons(DataConnector.BlockingReason value)

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DataConnector.BlockingReason

The blockingReasons to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addBlockingReasonsValue(int value)

public DataConnector.Builder addBlockingReasonsValue(int value)

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for blockingReasons to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addConnectorModes(DataConnector.ConnectorMode value)

public DataConnector.Builder addConnectorModes(DataConnector.ConnectorMode value)

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataConnector.ConnectorMode

The connectorModes to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addConnectorModesValue(int value)

public DataConnector.Builder addConnectorModesValue(int value)

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for connectorModes to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addDestinationConfigs(DestinationConfig value)

public DataConnector.Builder addDestinationConfigs(DestinationConfig value)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DestinationConfig
Returns
Type Description
DataConnector.Builder

addDestinationConfigs(DestinationConfig.Builder builderForValue)

public DataConnector.Builder addDestinationConfigs(DestinationConfig.Builder builderForValue)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DestinationConfig.Builder
Returns
Type Description
DataConnector.Builder

addDestinationConfigs(int index, DestinationConfig value)

public DataConnector.Builder addDestinationConfigs(int index, DestinationConfig value)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value DestinationConfig
Returns
Type Description
DataConnector.Builder

addDestinationConfigs(int index, DestinationConfig.Builder builderForValue)

public DataConnector.Builder addDestinationConfigs(int index, DestinationConfig.Builder builderForValue)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue DestinationConfig.Builder
Returns
Type Description
DataConnector.Builder

addDestinationConfigsBuilder()

public DestinationConfig.Builder addDestinationConfigsBuilder()

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DestinationConfig.Builder

addDestinationConfigsBuilder(int index)

public DestinationConfig.Builder addDestinationConfigsBuilder(int index)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DestinationConfig.Builder

addDynamicTools(DynamicTool value)

public DataConnector.Builder addDynamicTools(DynamicTool value)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DynamicTool
Returns
Type Description
DataConnector.Builder

addDynamicTools(DynamicTool.Builder builderForValue)

public DataConnector.Builder addDynamicTools(DynamicTool.Builder builderForValue)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue DynamicTool.Builder
Returns
Type Description
DataConnector.Builder

addDynamicTools(int index, DynamicTool value)

public DataConnector.Builder addDynamicTools(int index, DynamicTool value)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value DynamicTool
Returns
Type Description
DataConnector.Builder

addDynamicTools(int index, DynamicTool.Builder builderForValue)

public DataConnector.Builder addDynamicTools(int index, DynamicTool.Builder builderForValue)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue DynamicTool.Builder
Returns
Type Description
DataConnector.Builder

addDynamicToolsBuilder()

public DynamicTool.Builder addDynamicToolsBuilder()

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DynamicTool.Builder

addDynamicToolsBuilder(int index)

public DynamicTool.Builder addDynamicToolsBuilder(int index)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DynamicTool.Builder

addEgressFqdns(String value)

public DataConnector.Builder addEgressFqdns(String value)

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.

repeated string egress_fqdns = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The egressFqdns to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addEgressFqdnsBytes(ByteString value)

public DataConnector.Builder addEgressFqdnsBytes(ByteString value)

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.

repeated string egress_fqdns = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the egressFqdns to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addEntities(DataConnector.SourceEntity value)

public DataConnector.Builder addEntities(DataConnector.SourceEntity value)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameter
Name Description
value DataConnector.SourceEntity
Returns
Type Description
DataConnector.Builder

addEntities(DataConnector.SourceEntity.Builder builderForValue)

public DataConnector.Builder addEntities(DataConnector.SourceEntity.Builder builderForValue)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameter
Name Description
builderForValue DataConnector.SourceEntity.Builder
Returns
Type Description
DataConnector.Builder

addEntities(int index, DataConnector.SourceEntity value)

public DataConnector.Builder addEntities(int index, DataConnector.SourceEntity value)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameters
Name Description
index int
value DataConnector.SourceEntity
Returns
Type Description
DataConnector.Builder

addEntities(int index, DataConnector.SourceEntity.Builder builderForValue)

public DataConnector.Builder addEntities(int index, DataConnector.SourceEntity.Builder builderForValue)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameters
Name Description
index int
builderForValue DataConnector.SourceEntity.Builder
Returns
Type Description
DataConnector.Builder

addEntitiesBuilder()

public DataConnector.SourceEntity.Builder addEntitiesBuilder()

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Returns
Type Description
DataConnector.SourceEntity.Builder

addEntitiesBuilder(int index)

public DataConnector.SourceEntity.Builder addEntitiesBuilder(int index)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameter
Name Description
index int
Returns
Type Description
DataConnector.SourceEntity.Builder

addErrors(Status value)

public DataConnector.Builder addErrors(Status value)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
DataConnector.Builder

addErrors(Status.Builder builderForValue)

public DataConnector.Builder addErrors(Status.Builder builderForValue)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
DataConnector.Builder

addErrors(int index, Status value)

public DataConnector.Builder addErrors(int index, Status value)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
DataConnector.Builder

addErrors(int index, Status.Builder builderForValue)

public DataConnector.Builder addErrors(int index, Status.Builder builderForValue)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
DataConnector.Builder

addErrorsBuilder()

public Status.Builder addErrorsBuilder()

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status.Builder

addErrorsBuilder(int index)

public Status.Builder addErrorsBuilder(int index)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status.Builder

addOauthStaticIpAddresses(String value)

public DataConnector.Builder addOauthStaticIpAddresses(String value)

Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

repeated string oauth_static_ip_addresses = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The oauthStaticIpAddresses to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addOauthStaticIpAddressesBytes(ByteString value)

public DataConnector.Builder addOauthStaticIpAddressesBytes(ByteString value)

Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

repeated string oauth_static_ip_addresses = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the oauthStaticIpAddresses to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addRemoveParamKeys(String value)

public DataConnector.Builder addRemoveParamKeys(String value)

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.

repeated string remove_param_keys = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The removeParamKeys to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addRemoveParamKeysBytes(ByteString value)

public DataConnector.Builder addRemoveParamKeysBytes(ByteString value)

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.

repeated string remove_param_keys = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the removeParamKeys to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addStaticIpAddresses(String value)

public DataConnector.Builder addStaticIpAddresses(String value)

Output only. The static IP addresses used by this connector.

repeated string static_ip_addresses = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The staticIpAddresses to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

addStaticIpAddressesBytes(ByteString value)

public DataConnector.Builder addStaticIpAddressesBytes(ByteString value)

Output only. The static IP addresses used by this connector.

repeated string static_ip_addresses = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the staticIpAddresses to add.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

build()

public DataConnector build()
Returns
Type Description
DataConnector

buildPartial()

public DataConnector buildPartial()
Returns
Type Description
DataConnector

clear()

public DataConnector.Builder clear()
Returns
Type Description
DataConnector.Builder
Overrides

clearAclEnabled()

public DataConnector.Builder clearAclEnabled()

Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.

bool acl_enabled = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearActionConfig()

public DataConnector.Builder clearActionConfig()

Optional. Action configurations to make the connector support actions.

.google.cloud.discoveryengine.v1.ActionConfig action_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearActionState()

public DataConnector.Builder clearActionState()

Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.

.google.cloud.discoveryengine.v1.DataConnector.State action_state = 37 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearAlertPolicyConfigs()

public DataConnector.Builder clearAlertPolicyConfigs()

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearAutoRunDisabled()

public DataConnector.Builder clearAutoRunDisabled()

Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs

bool auto_run_disabled = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearBapConfig()

public DataConnector.Builder clearBapConfig()

Optional. The configuration for establishing a BAP connection.

.google.cloud.discoveryengine.v1.BAPConfig bap_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearBlockingReasons()

public DataConnector.Builder clearBlockingReasons()

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearCliConfig()

public DataConnector.Builder clearCliConfig()

Optional. The configuration for establishing a CLI connection.

.google.cloud.discoveryengine.v1.CliConfig cli_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearConnectorModes()

public DataConnector.Builder clearConnectorModes()

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearConnectorSourceId()

public DataConnector.Builder clearConnectorSourceId()

Optional. If set, this value instead of data_source is used to fetch the corresponding connector source.

string connector_source_id = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearConnectorType()

public DataConnector.Builder clearConnectorType()

Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.

.google.cloud.discoveryengine.v1.ConnectorType connector_type = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearCreateEuaSaas()

public DataConnector.Builder clearCreateEuaSaas()

Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.

bool create_eua_saas = 34 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearCreateTime()

public DataConnector.Builder clearCreateTime()

Output only. Timestamp the DataConnector was created at.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

clearDataConnectorParams()

public DataConnector.Builder clearDataConnectorParams()
Returns
Type Description
DataConnector.Builder

clearDataProtectionPolicy()

public DataConnector.Builder clearDataProtectionPolicy()

Optional. Specifies the data protection policy for the connector.

.google.cloud.discoveryengine.v1.DataProtectionPolicy data_protection_policy = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearDataSource()

public DataConnector.Builder clearDataSource()

Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see Connect a third-party data source.

string data_source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearDestinationConfigs()

public DataConnector.Builder clearDestinationConfigs()

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearDynamicTools()

public DataConnector.Builder clearDynamicTools()

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

clearEgressFqdns()

public DataConnector.Builder clearEgressFqdns()

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.

repeated string egress_fqdns = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearEndUserConfig()

public DataConnector.Builder clearEndUserConfig()

Optional. Any params and credentials used specifically for EUA connectors.

.google.cloud.discoveryengine.v1.DataConnector.EndUserConfig end_user_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearEntities()

public DataConnector.Builder clearEntities()

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Returns
Type Description
DataConnector.Builder

clearErrors()

public DataConnector.Builder clearErrors()

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

clearFederatedConfig()

public DataConnector.Builder clearFederatedConfig()

Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.

.google.cloud.discoveryengine.v1.DataConnector.FederatedConfig federated_config = 41 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearHybridIngestionDisabled()

public DataConnector.Builder clearHybridIngestionDisabled()

Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.

bool hybrid_ingestion_disabled = 40 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearIdentityScheduleConfig()

public DataConnector.Builder clearIdentityScheduleConfig()

The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.

.google.cloud.discoveryengine.v1.IdentityScheduleConfig identity_schedule_config = 23;

Returns
Type Description
DataConnector.Builder

clearIncrementalRefreshInterval()

public DataConnector.Builder clearIncrementalRefreshInterval()

Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration incremental_refresh_interval = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearIncrementalSyncDisabled()

public DataConnector.Builder clearIncrementalSyncDisabled()

Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.

bool incremental_sync_disabled = 35 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearJsonParams()

public DataConnector.Builder clearJsonParams()

Required data connector parameters in json string format.

string json_params = 43;

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearKmsKeyName()

public DataConnector.Builder clearKmsKeyName()

Input only. The KMS key to be used to protect the DataStores managed by this connector.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.

string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearLastSyncTime()

public DataConnector.Builder clearLastSyncTime()

Output only. For periodic connectors only, the last time a data sync was completed.

.google.protobuf.Timestamp last_sync_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

clearLatestPauseTime()

public DataConnector.Builder clearLatestPauseTime()

Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

  • All functionalities, including data synchronization, are halted.
  • Any ongoing data synchronization job will be canceled.
  • No future data synchronization runs will be scheduled nor can be triggered.

.google.protobuf.Timestamp latest_pause_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

clearMetadata()

public DataConnector.Builder clearMetadata()

Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.

.google.cloud.discoveryengine.v1.DataConnector.ConnectorMetadata metadata = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearName()

public DataConnector.Builder clearName()

Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearNextSyncTime()

public DataConnector.Builder clearNextSyncTime()

Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

.google.type.DateTime next_sync_time = 22;

Returns
Type Description
DataConnector.Builder

clearOauthStaticIpAddresses()

public DataConnector.Builder clearOauthStaticIpAddresses()

Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

repeated string oauth_static_ip_addresses = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearParams()

public DataConnector.Builder clearParams()

Required data connector parameters in structured json format.

.google.protobuf.Struct params = 4;

Returns
Type Description
DataConnector.Builder

clearPrivateConnectivityProjectId()

public DataConnector.Builder clearPrivateConnectivityProjectId()

Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

string private_connectivity_project_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearRealtimeState()

public DataConnector.Builder clearRealtimeState()

Output only. real-time sync state

.google.cloud.discoveryengine.v1.DataConnector.State realtime_state = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearRealtimeSyncConfig()

public DataConnector.Builder clearRealtimeSyncConfig()

Optional. The configuration for realtime sync.

.google.cloud.discoveryengine.v1.DataConnector.RealtimeSyncConfig realtime_sync_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

clearRefreshInterval()

public DataConnector.Builder clearRefreshInterval()

Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration refresh_interval = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataConnector.Builder

clearRemoveParamKeys()

public DataConnector.Builder clearRemoveParamKeys()

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.

repeated string remove_param_keys = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearState()

public DataConnector.Builder clearState()

Output only. State of the connector.

.google.cloud.discoveryengine.v1.DataConnector.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearStaticIpAddresses()

public DataConnector.Builder clearStaticIpAddresses()

Output only. The static IP addresses used by this connector.

repeated string static_ip_addresses = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearStaticIpEnabled()

public DataConnector.Builder clearStaticIpEnabled()

Optional. Whether customer has enabled static IP addresses for this connector.

bool static_ip_enabled = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearSyncMode()

public DataConnector.Builder clearSyncMode()

The data synchronization mode supported by the data connector.

.google.cloud.discoveryengine.v1.DataConnector.SyncMode sync_mode = 9;

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearTag()

public DataConnector.Builder clearTag()

Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time.

Optional at Create time. If the caller omits tag, the server auto-derives one from the collection_id (falling back to data_source, else a time-based t-<micros> sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default.

Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.

string tag = 51 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

clearUpdateTime()

public DataConnector.Builder clearUpdateTime()

Output only. Timestamp the DataConnector was last updated.

.google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

clearVpcscEnabled()

public DataConnector.Builder clearVpcscEnabled()

Output only. Whether the connector is created with VPC-SC enabled.

bool vpcsc_enabled = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.Builder

This builder for chaining.

getAclEnabled()

public boolean getAclEnabled()

Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.

bool acl_enabled = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The aclEnabled.

getActionConfig()

public ActionConfig getActionConfig()

Optional. Action configurations to make the connector support actions.

.google.cloud.discoveryengine.v1.ActionConfig action_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ActionConfig

The actionConfig.

getActionConfigBuilder()

public ActionConfig.Builder getActionConfigBuilder()

Optional. Action configurations to make the connector support actions.

.google.cloud.discoveryengine.v1.ActionConfig action_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ActionConfig.Builder

getActionConfigOrBuilder()

public ActionConfigOrBuilder getActionConfigOrBuilder()

Optional. Action configurations to make the connector support actions.

.google.cloud.discoveryengine.v1.ActionConfig action_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ActionConfigOrBuilder

getActionState()

public DataConnector.State getActionState()

Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.

.google.cloud.discoveryengine.v1.DataConnector.State action_state = 37 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.State

The actionState.

getActionStateValue()

public int getActionStateValue()

Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.

.google.cloud.discoveryengine.v1.DataConnector.State action_state = 37 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for actionState.

getAlertPolicyConfigs(int index)

public AlertPolicyConfig getAlertPolicyConfigs(int index)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AlertPolicyConfig

getAlertPolicyConfigsBuilder(int index)

public AlertPolicyConfig.Builder getAlertPolicyConfigsBuilder(int index)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AlertPolicyConfig.Builder

getAlertPolicyConfigsBuilderList()

public List<AlertPolicyConfig.Builder> getAlertPolicyConfigsBuilderList()

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getAlertPolicyConfigsCount()

public int getAlertPolicyConfigsCount()

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAlertPolicyConfigsList()

public List<AlertPolicyConfig> getAlertPolicyConfigsList()

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AlertPolicyConfig>

getAlertPolicyConfigsOrBuilder(int index)

public AlertPolicyConfigOrBuilder getAlertPolicyConfigsOrBuilder(int index)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AlertPolicyConfigOrBuilder

getAlertPolicyConfigsOrBuilderList()

public List<? extends AlertPolicyConfigOrBuilder> getAlertPolicyConfigsOrBuilderList()

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.AlertPolicyConfigOrBuilder>

getAutoRunDisabled()

public boolean getAutoRunDisabled()

Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs

bool auto_run_disabled = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The autoRunDisabled.

getBapConfig()

public BAPConfig getBapConfig()

Optional. The configuration for establishing a BAP connection.

.google.cloud.discoveryengine.v1.BAPConfig bap_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BAPConfig

The bapConfig.

getBapConfigBuilder()

public BAPConfig.Builder getBapConfigBuilder()

Optional. The configuration for establishing a BAP connection.

.google.cloud.discoveryengine.v1.BAPConfig bap_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BAPConfig.Builder

getBapConfigOrBuilder()

public BAPConfigOrBuilder getBapConfigOrBuilder()

Optional. The configuration for establishing a BAP connection.

.google.cloud.discoveryengine.v1.BAPConfig bap_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BAPConfigOrBuilder

getBlockingReasons(int index)

public DataConnector.BlockingReason getBlockingReasons(int index)

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
DataConnector.BlockingReason

The blockingReasons at the given index.

getBlockingReasonsCount()

public int getBlockingReasonsCount()

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of blockingReasons.

getBlockingReasonsList()

public List<DataConnector.BlockingReason> getBlockingReasonsList()

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<BlockingReason>

A list containing the blockingReasons.

getBlockingReasonsValue(int index)

public int getBlockingReasonsValue(int index)

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of blockingReasons at the given index.

getBlockingReasonsValueList()

public List<Integer> getBlockingReasonsValueList()

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for blockingReasons.

getCliConfig()

public CliConfig getCliConfig()

Optional. The configuration for establishing a CLI connection.

.google.cloud.discoveryengine.v1.CliConfig cli_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CliConfig

The cliConfig.

getCliConfigBuilder()

public CliConfig.Builder getCliConfigBuilder()

Optional. The configuration for establishing a CLI connection.

.google.cloud.discoveryengine.v1.CliConfig cli_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CliConfig.Builder

getCliConfigOrBuilder()

public CliConfigOrBuilder getCliConfigOrBuilder()

Optional. The configuration for establishing a CLI connection.

.google.cloud.discoveryengine.v1.CliConfig cli_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CliConfigOrBuilder

getConnectorModes(int index)

public DataConnector.ConnectorMode getConnectorModes(int index)

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
DataConnector.ConnectorMode

The connectorModes at the given index.

getConnectorModesCount()

public int getConnectorModesCount()

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of connectorModes.

getConnectorModesList()

public List<DataConnector.ConnectorMode> getConnectorModesList()

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ConnectorMode>

A list containing the connectorModes.

getConnectorModesValue(int index)

public int getConnectorModesValue(int index)

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of connectorModes at the given index.

getConnectorModesValueList()

public List<Integer> getConnectorModesValueList()

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for connectorModes.

getConnectorSourceId()

public String getConnectorSourceId()

Optional. If set, this value instead of data_source is used to fetch the corresponding connector source.

string connector_source_id = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The connectorSourceId.

getConnectorSourceIdBytes()

public ByteString getConnectorSourceIdBytes()

Optional. If set, this value instead of data_source is used to fetch the corresponding connector source.

string connector_source_id = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for connectorSourceId.

getConnectorType()

public ConnectorType getConnectorType()

Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.

.google.cloud.discoveryengine.v1.ConnectorType connector_type = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ConnectorType

The connectorType.

getConnectorTypeValue()

public int getConnectorTypeValue()

Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.

.google.cloud.discoveryengine.v1.ConnectorType connector_type = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for connectorType.

getCreateEuaSaas()

public boolean getCreateEuaSaas()

Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.

bool create_eua_saas = 34 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The createEuaSaas.

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp the DataConnector was created at.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp the DataConnector was created at.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp the DataConnector was created at.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataConnectorParamsCase()

public DataConnector.DataConnectorParamsCase getDataConnectorParamsCase()
Returns
Type Description
DataConnector.DataConnectorParamsCase

getDataProtectionPolicy()

public DataProtectionPolicy getDataProtectionPolicy()

Optional. Specifies the data protection policy for the connector.

.google.cloud.discoveryengine.v1.DataProtectionPolicy data_protection_policy = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProtectionPolicy

The dataProtectionPolicy.

getDataProtectionPolicyBuilder()

public DataProtectionPolicy.Builder getDataProtectionPolicyBuilder()

Optional. Specifies the data protection policy for the connector.

.google.cloud.discoveryengine.v1.DataProtectionPolicy data_protection_policy = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProtectionPolicy.Builder

getDataProtectionPolicyOrBuilder()

public DataProtectionPolicyOrBuilder getDataProtectionPolicyOrBuilder()

Optional. Specifies the data protection policy for the connector.

.google.cloud.discoveryengine.v1.DataProtectionPolicy data_protection_policy = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProtectionPolicyOrBuilder

getDataSource()

public String getDataSource()

Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see Connect a third-party data source.

string data_source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The dataSource.

getDataSourceBytes()

public ByteString getDataSourceBytes()

Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see Connect a third-party data source.

string data_source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for dataSource.

getDefaultInstanceForType()

public DataConnector getDefaultInstanceForType()
Returns
Type Description
DataConnector

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDestinationConfigs(int index)

public DestinationConfig getDestinationConfigs(int index)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DestinationConfig

getDestinationConfigsBuilder(int index)

public DestinationConfig.Builder getDestinationConfigsBuilder(int index)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DestinationConfig.Builder

getDestinationConfigsBuilderList()

public List<DestinationConfig.Builder> getDestinationConfigsBuilderList()

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getDestinationConfigsCount()

public int getDestinationConfigsCount()

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDestinationConfigsList()

public List<DestinationConfig> getDestinationConfigsList()

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<DestinationConfig>

getDestinationConfigsOrBuilder(int index)

public DestinationConfigOrBuilder getDestinationConfigsOrBuilder(int index)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DestinationConfigOrBuilder

getDestinationConfigsOrBuilderList()

public List<? extends DestinationConfigOrBuilder> getDestinationConfigsOrBuilderList()

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.DestinationConfigOrBuilder>

getDynamicTools(int index)

public DynamicTool getDynamicTools(int index)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DynamicTool

getDynamicToolsBuilder(int index)

public DynamicTool.Builder getDynamicToolsBuilder(int index)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DynamicTool.Builder

getDynamicToolsBuilderList()

public List<DynamicTool.Builder> getDynamicToolsBuilderList()

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getDynamicToolsCount()

public int getDynamicToolsCount()

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getDynamicToolsList()

public List<DynamicTool> getDynamicToolsList()

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<DynamicTool>

getDynamicToolsOrBuilder(int index)

public DynamicToolOrBuilder getDynamicToolsOrBuilder(int index)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DynamicToolOrBuilder

getDynamicToolsOrBuilderList()

public List<? extends DynamicToolOrBuilder> getDynamicToolsOrBuilderList()

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.DynamicToolOrBuilder>

getEgressFqdns(int index)

public String getEgressFqdns(int index)

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.

repeated string egress_fqdns = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The egressFqdns at the given index.

getEgressFqdnsBytes(int index)

public ByteString getEgressFqdnsBytes(int index)

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.

repeated string egress_fqdns = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the egressFqdns at the given index.

getEgressFqdnsCount()

public int getEgressFqdnsCount()

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.

repeated string egress_fqdns = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of egressFqdns.

getEgressFqdnsList()

public ProtocolStringList getEgressFqdnsList()

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.

repeated string egress_fqdns = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the egressFqdns.

getEndUserConfig()

public DataConnector.EndUserConfig getEndUserConfig()

Optional. Any params and credentials used specifically for EUA connectors.

.google.cloud.discoveryengine.v1.DataConnector.EndUserConfig end_user_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.EndUserConfig

The endUserConfig.

getEndUserConfigBuilder()

public DataConnector.EndUserConfig.Builder getEndUserConfigBuilder()

Optional. Any params and credentials used specifically for EUA connectors.

.google.cloud.discoveryengine.v1.DataConnector.EndUserConfig end_user_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.EndUserConfig.Builder

getEndUserConfigOrBuilder()

public DataConnector.EndUserConfigOrBuilder getEndUserConfigOrBuilder()

Optional. Any params and credentials used specifically for EUA connectors.

.google.cloud.discoveryengine.v1.DataConnector.EndUserConfig end_user_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.EndUserConfigOrBuilder

getEntities(int index)

public DataConnector.SourceEntity getEntities(int index)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameter
Name Description
index int
Returns
Type Description
DataConnector.SourceEntity

getEntitiesBuilder(int index)

public DataConnector.SourceEntity.Builder getEntitiesBuilder(int index)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameter
Name Description
index int
Returns
Type Description
DataConnector.SourceEntity.Builder

getEntitiesBuilderList()

public List<DataConnector.SourceEntity.Builder> getEntitiesBuilderList()

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Returns
Type Description
List<Builder>

getEntitiesCount()

public int getEntitiesCount()

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Returns
Type Description
int

getEntitiesList()

public List<DataConnector.SourceEntity> getEntitiesList()

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Returns
Type Description
List<SourceEntity>

getEntitiesOrBuilder(int index)

public DataConnector.SourceEntityOrBuilder getEntitiesOrBuilder(int index)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameter
Name Description
index int
Returns
Type Description
DataConnector.SourceEntityOrBuilder

getEntitiesOrBuilderList()

public List<? extends DataConnector.SourceEntityOrBuilder> getEntitiesOrBuilderList()

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.DataConnector.SourceEntityOrBuilder>

getErrors(int index)

public Status getErrors(int index)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status

getErrorsBuilder(int index)

public Status.Builder getErrorsBuilder(int index)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status.Builder

getErrorsBuilderList()

public List<Status.Builder> getErrorsBuilderList()

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<com.google.rpc.Status.Builder>

getErrorsCount()

public int getErrorsCount()

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getErrorsList()

public List<Status> getErrorsList()

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<com.google.rpc.Status>

getErrorsOrBuilder(int index)

public StatusOrBuilder getErrorsOrBuilder(int index)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.StatusOrBuilder

getErrorsOrBuilderList()

public List<? extends StatusOrBuilder> getErrorsOrBuilderList()

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.rpc.StatusOrBuilder>

getFederatedConfig()

public DataConnector.FederatedConfig getFederatedConfig()

Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.

.google.cloud.discoveryengine.v1.DataConnector.FederatedConfig federated_config = 41 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.FederatedConfig

The federatedConfig.

getFederatedConfigBuilder()

public DataConnector.FederatedConfig.Builder getFederatedConfigBuilder()

Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.

.google.cloud.discoveryengine.v1.DataConnector.FederatedConfig federated_config = 41 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.FederatedConfig.Builder

getFederatedConfigOrBuilder()

public DataConnector.FederatedConfigOrBuilder getFederatedConfigOrBuilder()

Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.

.google.cloud.discoveryengine.v1.DataConnector.FederatedConfig federated_config = 41 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.FederatedConfigOrBuilder

getHybridIngestionDisabled()

public boolean getHybridIngestionDisabled()

Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.

bool hybrid_ingestion_disabled = 40 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The hybridIngestionDisabled.

getIdentityScheduleConfig()

public IdentityScheduleConfig getIdentityScheduleConfig()

The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.

.google.cloud.discoveryengine.v1.IdentityScheduleConfig identity_schedule_config = 23;

Returns
Type Description
IdentityScheduleConfig

The identityScheduleConfig.

getIdentityScheduleConfigBuilder()

public IdentityScheduleConfig.Builder getIdentityScheduleConfigBuilder()

The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.

.google.cloud.discoveryengine.v1.IdentityScheduleConfig identity_schedule_config = 23;

Returns
Type Description
IdentityScheduleConfig.Builder

getIdentityScheduleConfigOrBuilder()

public IdentityScheduleConfigOrBuilder getIdentityScheduleConfigOrBuilder()

The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.

.google.cloud.discoveryengine.v1.IdentityScheduleConfig identity_schedule_config = 23;

Returns
Type Description
IdentityScheduleConfigOrBuilder

getIncrementalRefreshInterval()

public Duration getIncrementalRefreshInterval()

Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration incremental_refresh_interval = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The incrementalRefreshInterval.

getIncrementalRefreshIntervalBuilder()

public Duration.Builder getIncrementalRefreshIntervalBuilder()

Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration incremental_refresh_interval = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getIncrementalRefreshIntervalOrBuilder()

public DurationOrBuilder getIncrementalRefreshIntervalOrBuilder()

Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration incremental_refresh_interval = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getIncrementalSyncDisabled()

public boolean getIncrementalSyncDisabled()

Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.

bool incremental_sync_disabled = 35 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The incrementalSyncDisabled.

getJsonParams()

public String getJsonParams()

Required data connector parameters in json string format.

string json_params = 43;

Returns
Type Description
String

The jsonParams.

getJsonParamsBytes()

public ByteString getJsonParamsBytes()

Required data connector parameters in json string format.

string json_params = 43;

Returns
Type Description
ByteString

The bytes for jsonParams.

getKmsKeyName()

public String getKmsKeyName()

Input only. The KMS key to be used to protect the DataStores managed by this connector.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.

string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Input only. The KMS key to be used to protect the DataStores managed by this connector.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.

string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ByteString

The bytes for kmsKeyName.

getLastSyncTime()

public Timestamp getLastSyncTime()

Output only. For periodic connectors only, the last time a data sync was completed.

.google.protobuf.Timestamp last_sync_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The lastSyncTime.

getLastSyncTimeBuilder()

public Timestamp.Builder getLastSyncTimeBuilder()

Output only. For periodic connectors only, the last time a data sync was completed.

.google.protobuf.Timestamp last_sync_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getLastSyncTimeOrBuilder()

public TimestampOrBuilder getLastSyncTimeOrBuilder()

Output only. For periodic connectors only, the last time a data sync was completed.

.google.protobuf.Timestamp last_sync_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getLatestPauseTime()

public Timestamp getLatestPauseTime()

Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

  • All functionalities, including data synchronization, are halted.
  • Any ongoing data synchronization job will be canceled.
  • No future data synchronization runs will be scheduled nor can be triggered.

.google.protobuf.Timestamp latest_pause_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The latestPauseTime.

getLatestPauseTimeBuilder()

public Timestamp.Builder getLatestPauseTimeBuilder()

Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

  • All functionalities, including data synchronization, are halted.
  • Any ongoing data synchronization job will be canceled.
  • No future data synchronization runs will be scheduled nor can be triggered.

.google.protobuf.Timestamp latest_pause_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getLatestPauseTimeOrBuilder()

public TimestampOrBuilder getLatestPauseTimeOrBuilder()

Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

  • All functionalities, including data synchronization, are halted.
  • Any ongoing data synchronization job will be canceled.
  • No future data synchronization runs will be scheduled nor can be triggered.

.google.protobuf.Timestamp latest_pause_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getMetadata()

public DataConnector.ConnectorMetadata getMetadata()

Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.

.google.cloud.discoveryengine.v1.DataConnector.ConnectorMetadata metadata = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.ConnectorMetadata

The metadata.

getMetadataBuilder()

public DataConnector.ConnectorMetadata.Builder getMetadataBuilder()

Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.

.google.cloud.discoveryengine.v1.DataConnector.ConnectorMetadata metadata = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.ConnectorMetadata.Builder

getMetadataOrBuilder()

public DataConnector.ConnectorMetadataOrBuilder getMetadataOrBuilder()

Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.

.google.cloud.discoveryengine.v1.DataConnector.ConnectorMetadata metadata = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.ConnectorMetadataOrBuilder

getName()

public String getName()

Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNextSyncTime()

public DateTime getNextSyncTime()

Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

.google.type.DateTime next_sync_time = 22;

Returns
Type Description
com.google.type.DateTime

The nextSyncTime.

getNextSyncTimeBuilder()

public DateTime.Builder getNextSyncTimeBuilder()

Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

.google.type.DateTime next_sync_time = 22;

Returns
Type Description
com.google.type.DateTime.Builder

getNextSyncTimeOrBuilder()

public DateTimeOrBuilder getNextSyncTimeOrBuilder()

Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

.google.type.DateTime next_sync_time = 22;

Returns
Type Description
com.google.type.DateTimeOrBuilder

getOauthStaticIpAddresses(int index)

public String getOauthStaticIpAddresses(int index)

Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

repeated string oauth_static_ip_addresses = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The oauthStaticIpAddresses at the given index.

getOauthStaticIpAddressesBytes(int index)

public ByteString getOauthStaticIpAddressesBytes(int index)

Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

repeated string oauth_static_ip_addresses = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the oauthStaticIpAddresses at the given index.

getOauthStaticIpAddressesCount()

public int getOauthStaticIpAddressesCount()

Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

repeated string oauth_static_ip_addresses = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of oauthStaticIpAddresses.

getOauthStaticIpAddressesList()

public ProtocolStringList getOauthStaticIpAddressesList()

Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

repeated string oauth_static_ip_addresses = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the oauthStaticIpAddresses.

getParams()

public Struct getParams()

Required data connector parameters in structured json format.

.google.protobuf.Struct params = 4;

Returns
Type Description
Struct

The params.

getParamsBuilder()

public Struct.Builder getParamsBuilder()

Required data connector parameters in structured json format.

.google.protobuf.Struct params = 4;

Returns
Type Description
Builder

getParamsOrBuilder()

public StructOrBuilder getParamsOrBuilder()

Required data connector parameters in structured json format.

.google.protobuf.Struct params = 4;

Returns
Type Description
StructOrBuilder

getPrivateConnectivityProjectId()

public String getPrivateConnectivityProjectId()

Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

string private_connectivity_project_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The privateConnectivityProjectId.

getPrivateConnectivityProjectIdBytes()

public ByteString getPrivateConnectivityProjectIdBytes()

Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

string private_connectivity_project_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for privateConnectivityProjectId.

getRealtimeState()

public DataConnector.State getRealtimeState()

Output only. real-time sync state

.google.cloud.discoveryengine.v1.DataConnector.State realtime_state = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.State

The realtimeState.

getRealtimeStateValue()

public int getRealtimeStateValue()

Output only. real-time sync state

.google.cloud.discoveryengine.v1.DataConnector.State realtime_state = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for realtimeState.

getRealtimeSyncConfig()

public DataConnector.RealtimeSyncConfig getRealtimeSyncConfig()

Optional. The configuration for realtime sync.

.google.cloud.discoveryengine.v1.DataConnector.RealtimeSyncConfig realtime_sync_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.RealtimeSyncConfig

The realtimeSyncConfig.

getRealtimeSyncConfigBuilder()

public DataConnector.RealtimeSyncConfig.Builder getRealtimeSyncConfigBuilder()

Optional. The configuration for realtime sync.

.google.cloud.discoveryengine.v1.DataConnector.RealtimeSyncConfig realtime_sync_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.RealtimeSyncConfig.Builder

getRealtimeSyncConfigOrBuilder()

public DataConnector.RealtimeSyncConfigOrBuilder getRealtimeSyncConfigOrBuilder()

Optional. The configuration for realtime sync.

.google.cloud.discoveryengine.v1.DataConnector.RealtimeSyncConfig realtime_sync_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataConnector.RealtimeSyncConfigOrBuilder

getRefreshInterval()

public Duration getRefreshInterval()

Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration refresh_interval = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The refreshInterval.

getRefreshIntervalBuilder()

public Duration.Builder getRefreshIntervalBuilder()

Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration refresh_interval = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Builder

getRefreshIntervalOrBuilder()

public DurationOrBuilder getRefreshIntervalOrBuilder()

Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration refresh_interval = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

getRemoveParamKeys(int index)

public String getRemoveParamKeys(int index)

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.

repeated string remove_param_keys = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The removeParamKeys at the given index.

getRemoveParamKeysBytes(int index)

public ByteString getRemoveParamKeysBytes(int index)

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.

repeated string remove_param_keys = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the removeParamKeys at the given index.

getRemoveParamKeysCount()

public int getRemoveParamKeysCount()

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.

repeated string remove_param_keys = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of removeParamKeys.

getRemoveParamKeysList()

public ProtocolStringList getRemoveParamKeysList()

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.

repeated string remove_param_keys = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the removeParamKeys.

getState()

public DataConnector.State getState()

Output only. State of the connector.

.google.cloud.discoveryengine.v1.DataConnector.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataConnector.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the connector.

.google.cloud.discoveryengine.v1.DataConnector.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getStaticIpAddresses(int index)

public String getStaticIpAddresses(int index)

Output only. The static IP addresses used by this connector.

repeated string static_ip_addresses = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The staticIpAddresses at the given index.

getStaticIpAddressesBytes(int index)

public ByteString getStaticIpAddressesBytes(int index)

Output only. The static IP addresses used by this connector.

repeated string static_ip_addresses = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the staticIpAddresses at the given index.

getStaticIpAddressesCount()

public int getStaticIpAddressesCount()

Output only. The static IP addresses used by this connector.

repeated string static_ip_addresses = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of staticIpAddresses.

getStaticIpAddressesList()

public ProtocolStringList getStaticIpAddressesList()

Output only. The static IP addresses used by this connector.

repeated string static_ip_addresses = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the staticIpAddresses.

getStaticIpEnabled()

public boolean getStaticIpEnabled()

Optional. Whether customer has enabled static IP addresses for this connector.

bool static_ip_enabled = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The staticIpEnabled.

getSyncMode()

public DataConnector.SyncMode getSyncMode()

The data synchronization mode supported by the data connector.

.google.cloud.discoveryengine.v1.DataConnector.SyncMode sync_mode = 9;

Returns
Type Description
DataConnector.SyncMode

The syncMode.

getSyncModeValue()

public int getSyncModeValue()

The data synchronization mode supported by the data connector.

.google.cloud.discoveryengine.v1.DataConnector.SyncMode sync_mode = 9;

Returns
Type Description
int

The enum numeric value on the wire for syncMode.

getTag()

public String getTag()

Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time.

Optional at Create time. If the caller omits tag, the server auto-derives one from the collection_id (falling back to data_source, else a time-based t-<micros> sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default.

Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.

string tag = 51 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The tag.

getTagBytes()

public ByteString getTagBytes()

Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time.

Optional at Create time. If the caller omits tag, the server auto-derives one from the collection_id (falling back to data_source, else a time-based t-<micros> sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default.

Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.

string tag = 51 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for tag.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp the DataConnector was last updated.

.google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp the DataConnector was last updated.

.google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp the DataConnector was last updated.

.google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVpcscEnabled()

public boolean getVpcscEnabled()

Output only. Whether the connector is created with VPC-SC enabled.

bool vpcsc_enabled = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The vpcscEnabled.

hasActionConfig()

public boolean hasActionConfig()

Optional. Action configurations to make the connector support actions.

.google.cloud.discoveryengine.v1.ActionConfig action_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the actionConfig field is set.

hasBapConfig()

public boolean hasBapConfig()

Optional. The configuration for establishing a BAP connection.

.google.cloud.discoveryengine.v1.BAPConfig bap_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the bapConfig field is set.

hasCliConfig()

public boolean hasCliConfig()

Optional. The configuration for establishing a CLI connection.

.google.cloud.discoveryengine.v1.CliConfig cli_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the cliConfig field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp the DataConnector was created at.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDataProtectionPolicy()

public boolean hasDataProtectionPolicy()

Optional. Specifies the data protection policy for the connector.

.google.cloud.discoveryengine.v1.DataProtectionPolicy data_protection_policy = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataProtectionPolicy field is set.

hasEndUserConfig()

public boolean hasEndUserConfig()

Optional. Any params and credentials used specifically for EUA connectors.

.google.cloud.discoveryengine.v1.DataConnector.EndUserConfig end_user_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the endUserConfig field is set.

hasFederatedConfig()

public boolean hasFederatedConfig()

Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.

.google.cloud.discoveryengine.v1.DataConnector.FederatedConfig federated_config = 41 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the federatedConfig field is set.

hasIdentityScheduleConfig()

public boolean hasIdentityScheduleConfig()

The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.

.google.cloud.discoveryengine.v1.IdentityScheduleConfig identity_schedule_config = 23;

Returns
Type Description
boolean

Whether the identityScheduleConfig field is set.

hasIncrementalRefreshInterval()

public boolean hasIncrementalRefreshInterval()

Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration incremental_refresh_interval = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the incrementalRefreshInterval field is set.

hasJsonParams()

public boolean hasJsonParams()

Required data connector parameters in json string format.

string json_params = 43;

Returns
Type Description
boolean

Whether the jsonParams field is set.

hasLastSyncTime()

public boolean hasLastSyncTime()

Output only. For periodic connectors only, the last time a data sync was completed.

.google.protobuf.Timestamp last_sync_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastSyncTime field is set.

hasLatestPauseTime()

public boolean hasLatestPauseTime()

Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

  • All functionalities, including data synchronization, are halted.
  • Any ongoing data synchronization job will be canceled.
  • No future data synchronization runs will be scheduled nor can be triggered.

.google.protobuf.Timestamp latest_pause_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the latestPauseTime field is set.

hasMetadata()

public boolean hasMetadata()

Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.

.google.cloud.discoveryengine.v1.DataConnector.ConnectorMetadata metadata = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the metadata field is set.

hasNextSyncTime()

public boolean hasNextSyncTime()

Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

.google.type.DateTime next_sync_time = 22;

Returns
Type Description
boolean

Whether the nextSyncTime field is set.

hasParams()

public boolean hasParams()

Required data connector parameters in structured json format.

.google.protobuf.Struct params = 4;

Returns
Type Description
boolean

Whether the params field is set.

hasRealtimeSyncConfig()

public boolean hasRealtimeSyncConfig()

Optional. The configuration for realtime sync.

.google.cloud.discoveryengine.v1.DataConnector.RealtimeSyncConfig realtime_sync_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the realtimeSyncConfig field is set.

hasRefreshInterval()

public boolean hasRefreshInterval()

Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration refresh_interval = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the refreshInterval field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp the DataConnector was last updated.

.google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeActionConfig(ActionConfig value)

public DataConnector.Builder mergeActionConfig(ActionConfig value)

Optional. Action configurations to make the connector support actions.

.google.cloud.discoveryengine.v1.ActionConfig action_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ActionConfig
Returns
Type Description
DataConnector.Builder

mergeBapConfig(BAPConfig value)

public DataConnector.Builder mergeBapConfig(BAPConfig value)

Optional. The configuration for establishing a BAP connection.

.google.cloud.discoveryengine.v1.BAPConfig bap_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value BAPConfig
Returns
Type Description
DataConnector.Builder

mergeCliConfig(CliConfig value)

public DataConnector.Builder mergeCliConfig(CliConfig value)

Optional. The configuration for establishing a CLI connection.

.google.cloud.discoveryengine.v1.CliConfig cli_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CliConfig
Returns
Type Description
DataConnector.Builder

mergeCreateTime(Timestamp value)

public DataConnector.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp the DataConnector was created at.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataConnector.Builder

mergeDataProtectionPolicy(DataProtectionPolicy value)

public DataConnector.Builder mergeDataProtectionPolicy(DataProtectionPolicy value)

Optional. Specifies the data protection policy for the connector.

.google.cloud.discoveryengine.v1.DataProtectionPolicy data_protection_policy = 44 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataProtectionPolicy
Returns
Type Description
DataConnector.Builder

mergeEndUserConfig(DataConnector.EndUserConfig value)

public DataConnector.Builder mergeEndUserConfig(DataConnector.EndUserConfig value)

Optional. Any params and credentials used specifically for EUA connectors.

.google.cloud.discoveryengine.v1.DataConnector.EndUserConfig end_user_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataConnector.EndUserConfig
Returns
Type Description
DataConnector.Builder

mergeFederatedConfig(DataConnector.FederatedConfig value)

public DataConnector.Builder mergeFederatedConfig(DataConnector.FederatedConfig value)

Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.

.google.cloud.discoveryengine.v1.DataConnector.FederatedConfig federated_config = 41 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataConnector.FederatedConfig
Returns
Type Description
DataConnector.Builder

mergeFrom(DataConnector other)

public DataConnector.Builder mergeFrom(DataConnector other)
Parameter
Name Description
other DataConnector
Returns
Type Description
DataConnector.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataConnector.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataConnector.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DataConnector.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DataConnector.Builder
Overrides

mergeIdentityScheduleConfig(IdentityScheduleConfig value)

public DataConnector.Builder mergeIdentityScheduleConfig(IdentityScheduleConfig value)

The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.

.google.cloud.discoveryengine.v1.IdentityScheduleConfig identity_schedule_config = 23;

Parameter
Name Description
value IdentityScheduleConfig
Returns
Type Description
DataConnector.Builder

mergeIncrementalRefreshInterval(Duration value)

public DataConnector.Builder mergeIncrementalRefreshInterval(Duration value)

Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration incremental_refresh_interval = 36 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
DataConnector.Builder

mergeLastSyncTime(Timestamp value)

public DataConnector.Builder mergeLastSyncTime(Timestamp value)

Output only. For periodic connectors only, the last time a data sync was completed.

.google.protobuf.Timestamp last_sync_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataConnector.Builder

mergeLatestPauseTime(Timestamp value)

public DataConnector.Builder mergeLatestPauseTime(Timestamp value)

Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

  • All functionalities, including data synchronization, are halted.
  • Any ongoing data synchronization job will be canceled.
  • No future data synchronization runs will be scheduled nor can be triggered.

.google.protobuf.Timestamp latest_pause_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataConnector.Builder

mergeMetadata(DataConnector.ConnectorMetadata value)

public DataConnector.Builder mergeMetadata(DataConnector.ConnectorMetadata value)

Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.

.google.cloud.discoveryengine.v1.DataConnector.ConnectorMetadata metadata = 52 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataConnector.ConnectorMetadata
Returns
Type Description
DataConnector.Builder

mergeNextSyncTime(DateTime value)

public DataConnector.Builder mergeNextSyncTime(DateTime value)

Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

.google.type.DateTime next_sync_time = 22;

Parameter
Name Description
value com.google.type.DateTime
Returns
Type Description
DataConnector.Builder

mergeParams(Struct value)

public DataConnector.Builder mergeParams(Struct value)

Required data connector parameters in structured json format.

.google.protobuf.Struct params = 4;

Parameter
Name Description
value Struct
Returns
Type Description
DataConnector.Builder

mergeRealtimeSyncConfig(DataConnector.RealtimeSyncConfig value)

public DataConnector.Builder mergeRealtimeSyncConfig(DataConnector.RealtimeSyncConfig value)

Optional. The configuration for realtime sync.

.google.cloud.discoveryengine.v1.DataConnector.RealtimeSyncConfig realtime_sync_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataConnector.RealtimeSyncConfig
Returns
Type Description
DataConnector.Builder

mergeRefreshInterval(Duration value)

public DataConnector.Builder mergeRefreshInterval(Duration value)

Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration refresh_interval = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Duration
Returns
Type Description
DataConnector.Builder

mergeUpdateTime(Timestamp value)

public DataConnector.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp the DataConnector was last updated.

.google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataConnector.Builder

removeAlertPolicyConfigs(int index)

public DataConnector.Builder removeAlertPolicyConfigs(int index)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataConnector.Builder

removeDestinationConfigs(int index)

public DataConnector.Builder removeDestinationConfigs(int index)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataConnector.Builder

removeDynamicTools(int index)

public DataConnector.Builder removeDynamicTools(int index)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DataConnector.Builder

removeEntities(int index)

public DataConnector.Builder removeEntities(int index)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameter
Name Description
index int
Returns
Type Description
DataConnector.Builder

removeErrors(int index)

public DataConnector.Builder removeErrors(int index)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DataConnector.Builder

setAclEnabled(boolean value)

public DataConnector.Builder setAclEnabled(boolean value)

Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.

bool acl_enabled = 33 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The aclEnabled to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setActionConfig(ActionConfig value)

public DataConnector.Builder setActionConfig(ActionConfig value)

Optional. Action configurations to make the connector support actions.

.google.cloud.discoveryengine.v1.ActionConfig action_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ActionConfig
Returns
Type Description
DataConnector.Builder

setActionConfig(ActionConfig.Builder builderForValue)

public DataConnector.Builder setActionConfig(ActionConfig.Builder builderForValue)

Optional. Action configurations to make the connector support actions.

.google.cloud.discoveryengine.v1.ActionConfig action_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ActionConfig.Builder
Returns
Type Description
DataConnector.Builder

setActionState(DataConnector.State value)

public DataConnector.Builder setActionState(DataConnector.State value)

Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.

.google.cloud.discoveryengine.v1.DataConnector.State action_state = 37 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DataConnector.State

The actionState to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setActionStateValue(int value)

public DataConnector.Builder setActionStateValue(int value)

Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.

.google.cloud.discoveryengine.v1.DataConnector.State action_state = 37 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for actionState to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setAlertPolicyConfigs(int index, AlertPolicyConfig value)

public DataConnector.Builder setAlertPolicyConfigs(int index, AlertPolicyConfig value)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AlertPolicyConfig
Returns
Type Description
DataConnector.Builder

setAlertPolicyConfigs(int index, AlertPolicyConfig.Builder builderForValue)

public DataConnector.Builder setAlertPolicyConfigs(int index, AlertPolicyConfig.Builder builderForValue)

Optional. The connector level alert config.

repeated .google.cloud.discoveryengine.v1.AlertPolicyConfig alert_policy_configs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AlertPolicyConfig.Builder
Returns
Type Description
DataConnector.Builder

setAutoRunDisabled(boolean value)

public DataConnector.Builder setAutoRunDisabled(boolean value)

Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs

bool auto_run_disabled = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The autoRunDisabled to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setBapConfig(BAPConfig value)

public DataConnector.Builder setBapConfig(BAPConfig value)

Optional. The configuration for establishing a BAP connection.

.google.cloud.discoveryengine.v1.BAPConfig bap_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value BAPConfig
Returns
Type Description
DataConnector.Builder

setBapConfig(BAPConfig.Builder builderForValue)

public DataConnector.Builder setBapConfig(BAPConfig.Builder builderForValue)

Optional. The configuration for establishing a BAP connection.

.google.cloud.discoveryengine.v1.BAPConfig bap_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue BAPConfig.Builder
Returns
Type Description
DataConnector.Builder

setBlockingReasons(int index, DataConnector.BlockingReason value)

public DataConnector.Builder setBlockingReasons(int index, DataConnector.BlockingReason value)

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.

value DataConnector.BlockingReason

The blockingReasons to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setBlockingReasonsValue(int index, int value)

public DataConnector.Builder setBlockingReasonsValue(int index, int value)

Output only. User actions that must be completed before the connector can start syncing data.

repeated .google.cloud.discoveryengine.v1.DataConnector.BlockingReason blocking_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for blockingReasons to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setCliConfig(CliConfig value)

public DataConnector.Builder setCliConfig(CliConfig value)

Optional. The configuration for establishing a CLI connection.

.google.cloud.discoveryengine.v1.CliConfig cli_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CliConfig
Returns
Type Description
DataConnector.Builder

setCliConfig(CliConfig.Builder builderForValue)

public DataConnector.Builder setCliConfig(CliConfig.Builder builderForValue)

Optional. The configuration for establishing a CLI connection.

.google.cloud.discoveryengine.v1.CliConfig cli_config = 48 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue CliConfig.Builder
Returns
Type Description
DataConnector.Builder

setConnectorModes(int index, DataConnector.ConnectorMode value)

public DataConnector.Builder setConnectorModes(int index, DataConnector.ConnectorMode value)

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value DataConnector.ConnectorMode

The connectorModes to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setConnectorModesValue(int index, int value)

public DataConnector.Builder setConnectorModesValue(int index, int value)

Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.

repeated .google.cloud.discoveryengine.v1.DataConnector.ConnectorMode connector_modes = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for connectorModes to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setConnectorSourceId(String value)

public DataConnector.Builder setConnectorSourceId(String value)

Optional. If set, this value instead of data_source is used to fetch the corresponding connector source.

string connector_source_id = 49 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The connectorSourceId to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setConnectorSourceIdBytes(ByteString value)

public DataConnector.Builder setConnectorSourceIdBytes(ByteString value)

Optional. If set, this value instead of data_source is used to fetch the corresponding connector source.

string connector_source_id = 49 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for connectorSourceId to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setConnectorType(ConnectorType value)

public DataConnector.Builder setConnectorType(ConnectorType value)

Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.

.google.cloud.discoveryengine.v1.ConnectorType connector_type = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ConnectorType

The connectorType to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setConnectorTypeValue(int value)

public DataConnector.Builder setConnectorTypeValue(int value)

Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.

.google.cloud.discoveryengine.v1.ConnectorType connector_type = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for connectorType to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setCreateEuaSaas(boolean value)

public DataConnector.Builder setCreateEuaSaas(boolean value)

Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.

bool create_eua_saas = 34 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The createEuaSaas to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public DataConnector.Builder setCreateTime(Timestamp value)

Output only. Timestamp the DataConnector was created at.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataConnector.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DataConnector.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp the DataConnector was created at.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataConnector.Builder

setDataProtectionPolicy(DataProtectionPolicy value)

public DataConnector.Builder setDataProtectionPolicy(DataProtectionPolicy value)

Optional. Specifies the data protection policy for the connector.

.google.cloud.discoveryengine.v1.DataProtectionPolicy data_protection_policy = 44 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataProtectionPolicy
Returns
Type Description
DataConnector.Builder

setDataProtectionPolicy(DataProtectionPolicy.Builder builderForValue)

public DataConnector.Builder setDataProtectionPolicy(DataProtectionPolicy.Builder builderForValue)

Optional. Specifies the data protection policy for the connector.

.google.cloud.discoveryengine.v1.DataProtectionPolicy data_protection_policy = 44 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataProtectionPolicy.Builder
Returns
Type Description
DataConnector.Builder

setDataSource(String value)

public DataConnector.Builder setDataSource(String value)

Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see Connect a third-party data source.

string data_source = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The dataSource to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setDataSourceBytes(ByteString value)

public DataConnector.Builder setDataSourceBytes(ByteString value)

Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see Connect a third-party data source.

string data_source = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for dataSource to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setDestinationConfigs(int index, DestinationConfig value)

public DataConnector.Builder setDestinationConfigs(int index, DestinationConfig value)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value DestinationConfig
Returns
Type Description
DataConnector.Builder

setDestinationConfigs(int index, DestinationConfig.Builder builderForValue)

public DataConnector.Builder setDestinationConfigs(int index, DestinationConfig.Builder builderForValue)

Optional. Any target destinations used to connect to third-party services.

repeated .google.cloud.discoveryengine.v1.DestinationConfig destination_configs = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue DestinationConfig.Builder
Returns
Type Description
DataConnector.Builder

setDynamicTools(int index, DynamicTool value)

public DataConnector.Builder setDynamicTools(int index, DynamicTool value)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value DynamicTool
Returns
Type Description
DataConnector.Builder

setDynamicTools(int index, DynamicTool.Builder builderForValue)

public DataConnector.Builder setDynamicTools(int index, DynamicTool.Builder builderForValue)

Output only. The dynamic tools fetched for this connector.

repeated .google.cloud.discoveryengine.v1.DynamicTool dynamic_tools = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue DynamicTool.Builder
Returns
Type Description
DataConnector.Builder

setEgressFqdns(int index, String value)

public DataConnector.Builder setEgressFqdns(int index, String value)

Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.

repeated string egress_fqdns = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.

value String

The egressFqdns to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setEndUserConfig(DataConnector.EndUserConfig value)

public DataConnector.Builder setEndUserConfig(DataConnector.EndUserConfig value)

Optional. Any params and credentials used specifically for EUA connectors.

.google.cloud.discoveryengine.v1.DataConnector.EndUserConfig end_user_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataConnector.EndUserConfig
Returns
Type Description
DataConnector.Builder

setEndUserConfig(DataConnector.EndUserConfig.Builder builderForValue)

public DataConnector.Builder setEndUserConfig(DataConnector.EndUserConfig.Builder builderForValue)

Optional. Any params and credentials used specifically for EUA connectors.

.google.cloud.discoveryengine.v1.DataConnector.EndUserConfig end_user_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataConnector.EndUserConfig.Builder
Returns
Type Description
DataConnector.Builder

setEntities(int index, DataConnector.SourceEntity value)

public DataConnector.Builder setEntities(int index, DataConnector.SourceEntity value)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameters
Name Description
index int
value DataConnector.SourceEntity
Returns
Type Description
DataConnector.Builder

setEntities(int index, DataConnector.SourceEntity.Builder builderForValue)

public DataConnector.Builder setEntities(int index, DataConnector.SourceEntity.Builder builderForValue)

List of entities from the connected data source to ingest.

repeated .google.cloud.discoveryengine.v1.DataConnector.SourceEntity entities = 6;

Parameters
Name Description
index int
builderForValue DataConnector.SourceEntity.Builder
Returns
Type Description
DataConnector.Builder

setErrors(int index, Status value)

public DataConnector.Builder setErrors(int index, Status value)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
DataConnector.Builder

setErrors(int index, Status.Builder builderForValue)

public DataConnector.Builder setErrors(int index, Status.Builder builderForValue)

Output only. The errors from initialization or from the latest connector run.

repeated .google.rpc.Status errors = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
DataConnector.Builder

setFederatedConfig(DataConnector.FederatedConfig value)

public DataConnector.Builder setFederatedConfig(DataConnector.FederatedConfig value)

Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.

.google.cloud.discoveryengine.v1.DataConnector.FederatedConfig federated_config = 41 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataConnector.FederatedConfig
Returns
Type Description
DataConnector.Builder

setFederatedConfig(DataConnector.FederatedConfig.Builder builderForValue)

public DataConnector.Builder setFederatedConfig(DataConnector.FederatedConfig.Builder builderForValue)

Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.

.google.cloud.discoveryengine.v1.DataConnector.FederatedConfig federated_config = 41 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataConnector.FederatedConfig.Builder
Returns
Type Description
DataConnector.Builder

setHybridIngestionDisabled(boolean value)

public DataConnector.Builder setHybridIngestionDisabled(boolean value)

Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.

bool hybrid_ingestion_disabled = 40 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The hybridIngestionDisabled to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setIdentityScheduleConfig(IdentityScheduleConfig value)

public DataConnector.Builder setIdentityScheduleConfig(IdentityScheduleConfig value)

The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.

.google.cloud.discoveryengine.v1.IdentityScheduleConfig identity_schedule_config = 23;

Parameter
Name Description
value IdentityScheduleConfig
Returns
Type Description
DataConnector.Builder

setIdentityScheduleConfig(IdentityScheduleConfig.Builder builderForValue)

public DataConnector.Builder setIdentityScheduleConfig(IdentityScheduleConfig.Builder builderForValue)

The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.

.google.cloud.discoveryengine.v1.IdentityScheduleConfig identity_schedule_config = 23;

Parameter
Name Description
builderForValue IdentityScheduleConfig.Builder
Returns
Type Description
DataConnector.Builder

setIncrementalRefreshInterval(Duration value)

public DataConnector.Builder setIncrementalRefreshInterval(Duration value)

Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration incremental_refresh_interval = 36 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
DataConnector.Builder

setIncrementalRefreshInterval(Duration.Builder builderForValue)

public DataConnector.Builder setIncrementalRefreshInterval(Duration.Builder builderForValue)

Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration incremental_refresh_interval = 36 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataConnector.Builder

setIncrementalSyncDisabled(boolean value)

public DataConnector.Builder setIncrementalSyncDisabled(boolean value)

Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.

bool incremental_sync_disabled = 35 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The incrementalSyncDisabled to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setJsonParams(String value)

public DataConnector.Builder setJsonParams(String value)

Required data connector parameters in json string format.

string json_params = 43;

Parameter
Name Description
value String

The jsonParams to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setJsonParamsBytes(ByteString value)

public DataConnector.Builder setJsonParamsBytes(ByteString value)

Required data connector parameters in json string format.

string json_params = 43;

Parameter
Name Description
value ByteString

The bytes for jsonParams to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setKmsKeyName(String value)

public DataConnector.Builder setKmsKeyName(String value)

Input only. The KMS key to be used to protect the DataStores managed by this connector.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.

string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value String

The kmsKeyName to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public DataConnector.Builder setKmsKeyNameBytes(ByteString value)

Input only. The KMS key to be used to protect the DataStores managed by this connector.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.

string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for kmsKeyName to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setLastSyncTime(Timestamp value)

public DataConnector.Builder setLastSyncTime(Timestamp value)

Output only. For periodic connectors only, the last time a data sync was completed.

.google.protobuf.Timestamp last_sync_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataConnector.Builder

setLastSyncTime(Timestamp.Builder builderForValue)

public DataConnector.Builder setLastSyncTime(Timestamp.Builder builderForValue)

Output only. For periodic connectors only, the last time a data sync was completed.

.google.protobuf.Timestamp last_sync_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataConnector.Builder

setLatestPauseTime(Timestamp value)

public DataConnector.Builder setLatestPauseTime(Timestamp value)

Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

  • All functionalities, including data synchronization, are halted.
  • Any ongoing data synchronization job will be canceled.
  • No future data synchronization runs will be scheduled nor can be triggered.

.google.protobuf.Timestamp latest_pause_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataConnector.Builder

setLatestPauseTime(Timestamp.Builder builderForValue)

public DataConnector.Builder setLatestPauseTime(Timestamp.Builder builderForValue)

Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

  • All functionalities, including data synchronization, are halted.
  • Any ongoing data synchronization job will be canceled.
  • No future data synchronization runs will be scheduled nor can be triggered.

.google.protobuf.Timestamp latest_pause_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataConnector.Builder

setMetadata(DataConnector.ConnectorMetadata value)

public DataConnector.Builder setMetadata(DataConnector.ConnectorMetadata value)

Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.

.google.cloud.discoveryengine.v1.DataConnector.ConnectorMetadata metadata = 52 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataConnector.ConnectorMetadata
Returns
Type Description
DataConnector.Builder

setMetadata(DataConnector.ConnectorMetadata.Builder builderForValue)

public DataConnector.Builder setMetadata(DataConnector.ConnectorMetadata.Builder builderForValue)

Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry ConnectorSource.

.google.cloud.discoveryengine.v1.DataConnector.ConnectorMetadata metadata = 52 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataConnector.ConnectorMetadata.Builder
Returns
Type Description
DataConnector.Builder

setName(String value)

public DataConnector.Builder setName(String value)

Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DataConnector.Builder setNameBytes(ByteString value)

Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setNextSyncTime(DateTime value)

public DataConnector.Builder setNextSyncTime(DateTime value)

Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

.google.type.DateTime next_sync_time = 22;

Parameter
Name Description
value com.google.type.DateTime
Returns
Type Description
DataConnector.Builder

setNextSyncTime(DateTime.Builder builderForValue)

public DataConnector.Builder setNextSyncTime(DateTime.Builder builderForValue)

Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the IANA Time Zone Database. This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.

.google.type.DateTime next_sync_time = 22;

Parameter
Name Description
builderForValue com.google.type.DateTime.Builder
Returns
Type Description
DataConnector.Builder

setOauthStaticIpAddresses(int index, String value)

public DataConnector.Builder setOauthStaticIpAddresses(int index, String value)

Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from static_ip_addresses so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.

repeated string oauth_static_ip_addresses = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.

value String

The oauthStaticIpAddresses to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setParams(Struct value)

public DataConnector.Builder setParams(Struct value)

Required data connector parameters in structured json format.

.google.protobuf.Struct params = 4;

Parameter
Name Description
value Struct
Returns
Type Description
DataConnector.Builder

setParams(Struct.Builder builderForValue)

public DataConnector.Builder setParams(Struct.Builder builderForValue)

Required data connector parameters in structured json format.

.google.protobuf.Struct params = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataConnector.Builder

setPrivateConnectivityProjectId(String value)

public DataConnector.Builder setPrivateConnectivityProjectId(String value)

Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

string private_connectivity_project_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The privateConnectivityProjectId to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setPrivateConnectivityProjectIdBytes(ByteString value)

public DataConnector.Builder setPrivateConnectivityProjectIdBytes(ByteString value)

Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

string private_connectivity_project_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for privateConnectivityProjectId to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setRealtimeState(DataConnector.State value)

public DataConnector.Builder setRealtimeState(DataConnector.State value)

Output only. real-time sync state

.google.cloud.discoveryengine.v1.DataConnector.State realtime_state = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DataConnector.State

The realtimeState to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setRealtimeStateValue(int value)

public DataConnector.Builder setRealtimeStateValue(int value)

Output only. real-time sync state

.google.cloud.discoveryengine.v1.DataConnector.State realtime_state = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for realtimeState to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setRealtimeSyncConfig(DataConnector.RealtimeSyncConfig value)

public DataConnector.Builder setRealtimeSyncConfig(DataConnector.RealtimeSyncConfig value)

Optional. The configuration for realtime sync.

.google.cloud.discoveryengine.v1.DataConnector.RealtimeSyncConfig realtime_sync_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataConnector.RealtimeSyncConfig
Returns
Type Description
DataConnector.Builder

setRealtimeSyncConfig(DataConnector.RealtimeSyncConfig.Builder builderForValue)

public DataConnector.Builder setRealtimeSyncConfig(DataConnector.RealtimeSyncConfig.Builder builderForValue)

Optional. The configuration for realtime sync.

.google.cloud.discoveryengine.v1.DataConnector.RealtimeSyncConfig realtime_sync_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataConnector.RealtimeSyncConfig.Builder
Returns
Type Description
DataConnector.Builder

setRefreshInterval(Duration value)

public DataConnector.Builder setRefreshInterval(Duration value)

Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration refresh_interval = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Duration
Returns
Type Description
DataConnector.Builder

setRefreshInterval(Duration.Builder builderForValue)

public DataConnector.Builder setRefreshInterval(Duration.Builder builderForValue)

Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

.google.protobuf.Duration refresh_interval = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataConnector.Builder

setRemoveParamKeys(int index, String value)

public DataConnector.Builder setRemoveParamKeys(int index, String value)

Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.

repeated string remove_param_keys = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The removeParamKeys to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setState(DataConnector.State value)

public DataConnector.Builder setState(DataConnector.State value)

Output only. State of the connector.

.google.cloud.discoveryengine.v1.DataConnector.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DataConnector.State

The state to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setStateValue(int value)

public DataConnector.Builder setStateValue(int value)

Output only. State of the connector.

.google.cloud.discoveryengine.v1.DataConnector.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setStaticIpAddresses(int index, String value)

public DataConnector.Builder setStaticIpAddresses(int index, String value)

Output only. The static IP addresses used by this connector.

repeated string static_ip_addresses = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.

value String

The staticIpAddresses to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setStaticIpEnabled(boolean value)

public DataConnector.Builder setStaticIpEnabled(boolean value)

Optional. Whether customer has enabled static IP addresses for this connector.

bool static_ip_enabled = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The staticIpEnabled to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setSyncMode(DataConnector.SyncMode value)

public DataConnector.Builder setSyncMode(DataConnector.SyncMode value)

The data synchronization mode supported by the data connector.

.google.cloud.discoveryengine.v1.DataConnector.SyncMode sync_mode = 9;

Parameter
Name Description
value DataConnector.SyncMode

The syncMode to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setSyncModeValue(int value)

public DataConnector.Builder setSyncModeValue(int value)

The data synchronization mode supported by the data connector.

.google.cloud.discoveryengine.v1.DataConnector.SyncMode sync_mode = 9;

Parameter
Name Description
value int

The enum numeric value on the wire for syncMode to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setTag(String value)

public DataConnector.Builder setTag(String value)

Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time.

Optional at Create time. If the caller omits tag, the server auto-derives one from the collection_id (falling back to data_source, else a time-based t-<micros> sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default.

Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.

string tag = 51 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The tag to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setTagBytes(ByteString value)

public DataConnector.Builder setTagBytes(ByteString value)

Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time.

Optional at Create time. If the caller omits tag, the server auto-derives one from the collection_id (falling back to data_source, else a time-based t-<micros> sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default.

Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.

string tag = 51 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for tag to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public DataConnector.Builder setUpdateTime(Timestamp value)

Output only. Timestamp the DataConnector was last updated.

.google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataConnector.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public DataConnector.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp the DataConnector was last updated.

.google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataConnector.Builder

setVpcscEnabled(boolean value)

public DataConnector.Builder setVpcscEnabled(boolean value)

Output only. Whether the connector is created with VPC-SC enabled.

bool vpcsc_enabled = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The vpcscEnabled to set.

Returns
Type Description
DataConnector.Builder

This builder for chaining.