Este producto no es compatible con el
sitio Datadog seleccionado. (
).
gcp_discoveryengine_collection
ancestors
Type: UNORDERED_LIST_STRING
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. Timestamp the Collection was created at.
data_connector
Type: STRUCT
Provider name: dataConnector
Description: Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including name, data_source, entities.entity_name and entities.data_store. To get more details about a data connector, use the DataConnectorService.GetDataConnector method.
acl_enabled
Type: BOOLEAN
Provider name: aclEnabled
Description: Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
action_config
Type: STRUCT
Provider name: actionConfig
Description: Optional. Action configurations to make the connector support actions.
is_action_configured
Type: BOOLEAN
Provider name: isActionConfigured
Description: Output only. The connector contains the necessary parameters and is configured to support actions.
service_name
Type: STRING
Provider name: serviceName
Description: Optional. The Service Directory resource name (projects//locations//namespaces//services/) representing a VPC network endpoint used to connect to the data source’s instance_uri, defined in DataConnector.params. Required when VPC Service Controls are enabled.
action_state
Type: STRING
Provider name: actionState
Description: Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
Possible values:
STATE_UNSPECIFIED - Default value.
CREATING - The connector is being set up.
ACTIVE - The connector is successfully set up and awaiting next sync run.
FAILED - The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.
RUNNING - The connector is actively syncing records from the data source.
WARNING - The connector has completed a sync run, but encountered non-fatal errors.
INITIALIZATION_FAILED - Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).
UPDATING - Connector is in the process of an update.
alert_policy_configs
Type: UNORDERED_LIST_STRUCT
Provider name: alertPolicyConfigs
Description: Optional. The connector level alert config.
alert_enrollments
Type: UNORDERED_LIST_STRUCT
Provider name: alertEnrollments
Description: Optional. The enrollment states of each alert.
alert_id
Type: STRING
Provider name: alertId
Description: Immutable. The id of an alert.
enroll_state
Type: STRING
Provider name: enrollState
Description: Required. The enrollment status of a customer.
Possible values:
ENROLL_STATES_UNSPECIFIED - Default value. Used for customers who have not responded to the alert policy.
ENROLLED - Customer is enrolled in this policy.
DECLINED - Customer declined this policy.
alert_policy_name
Type: STRING
Provider name: alertPolicyName
Description: Immutable. The fully qualified resource name of the AlertPolicy.
auto_run_disabled
Type: BOOLEAN
Provider name: autoRunDisabled
Description: 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
bap_config
Type: STRUCT
Provider name: bapConfig
Description: Optional. The configuration for establishing a BAP connection.
supported_connector_modes
Type: UNORDERED_LIST_STRING
Provider name: supportedConnectorModes
Description: Required. The supported connector modes for the associated BAP connection.
blocking_reasons
Type: UNORDERED_LIST_STRING
Provider name: blockingReasons
Description: Output only. User actions that must be completed before the connector can start syncing data.
connector_modes
Type: UNORDERED_LIST_STRING
Provider name: connectorModes
Description: Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
connector_type
Type: STRING
Provider name: connectorType
Description: 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.
Possible values:
CONNECTOR_TYPE_UNSPECIFIED - Default value.
THIRD_PARTY - Third party connector to connector to third party application.
GCP_FHIR - Data connector connects between FHIR store and VAIS datastore.
BIG_QUERY - Big query connector.
GCS - Google Cloud Storage connector.
GOOGLE_MAIL - Gmail connector.
GOOGLE_CALENDAR - Google Calendar connector.
GOOGLE_DRIVE - Google Drive connector.
NATIVE_CLOUD_IDENTITY - Native Cloud Identity connector for people search powered by People API.
THIRD_PARTY_FEDERATED - Federated connector, it is a third party connector that doesn’t ingestion data, and search is powered by third party application’s API.
THIRD_PARTY_EUA - Connector utilized for End User Authentication features.
GCNV - Google Cloud NetApp Volumes connector.
create_eua_saas
Type: BOOLEAN
Provider name: createEuaSaas
Description: Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. Timestamp the DataConnector was created at.
data_source
Type: STRING
Provider name: dataSource
Description: Required. The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
destination_configs
Type: UNORDERED_LIST_STRUCT
Provider name: destinationConfigs
Description: Optional. Any target destinations used to connect to third-party services.
destinations
Type: UNORDERED_LIST_STRUCT
Provider name: destinations
Description: Optional. The destinations for the corresponding key.
host
Type: STRING
Provider name: host
Description: Publicly routable host.
port
Type: INT32
Provider name: port
Description: Optional. Target port number accepted by the destination.
key
Type: STRING
Provider name: key
Description: Optional. Unique destination identifier that is supported by the connector.
end_user_config
Type: STRUCT
Provider name: endUserConfig
Description: Optional. Any params and credentials used specifically for EUA connectors.
tenant
Type: STRUCT
Provider name: tenant
Description: Optional. The tenant project the connector is connected to.
gcp_display_name
Type: STRING
Provider name: displayName
Description: Optional display name for the tenant, e.g. “My Slack Team”.
id
Type: STRING
Provider name: id
Description: The tenant’s instance ID. Examples: Jira (“8594f221-9797-5f78-1fa4-485e198d7cd0”), Slack (“T123456”).
uri
Type: STRING
Provider name: uri
Description: The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.
entities
Type: UNORDERED_LIST_STRUCT
Provider name: entities
Description: List of entities from the connected data source to ingest.
data_store
Type: STRING
Provider name: dataStore
Description: Output only. The full resource name of the associated data store for the source entity. Format: projects/*/locations/*/collections/*/dataStores/*. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.
entity_name
Type: STRING
Provider name: entityName
Description: The name of the entity. Supported values by data source: * Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign * Jira: Issue * Confluence: Content, Space
healthcare_fhir_config
Type: STRUCT
Provider name: healthcareFhirConfig
Description: Optional. Configuration for HEALTHCARE_FHIR vertical.
enable_configurable_schema
Type: BOOLEAN
Provider name: enableConfigurableSchema
Description: Whether to enable configurable schema for HEALTHCARE_FHIR vertical. If set to true, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
enable_static_indexing_for_batch_ingestion
Type: BOOLEAN
Provider name: enableStaticIndexingForBatchIngestion
Description: Whether to enable static indexing for HEALTHCARE_FHIR batch ingestion. If set to true, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
starting_schema
Type: STRUCT
Provider name: startingSchema
Description: Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from this doc.
field_configs
Type: UNORDERED_LIST_STRUCT
Provider name: fieldConfigs
Description: Output only. Configurations for fields of the schema.
advanced_site_search_data_sources
Type: UNORDERED_LIST_STRING
Provider name: advancedSiteSearchDataSources
Description: If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with in meta tag, and in page map: if this enum is set to METATAGS, we will only index ; if this enum is not set, we will merge them and index .
completable_option
Type: STRING
Provider name: completableOption
Description: If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just string fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw INVALID_ARGUMENT error.
Possible values:
COMPLETABLE_OPTION_UNSPECIFIED - Value used when unset.
COMPLETABLE_ENABLED - Completable option enabled for a schema field.
COMPLETABLE_DISABLED - Completable option disabled for a schema field.
dynamic_facetable_option
Type: STRING
Provider name: dynamicFacetableOption
Description: If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as object and boolean, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw INVALID_ARGUMENT error.
Possible values:
DYNAMIC_FACETABLE_OPTION_UNSPECIFIED - Value used when unset.
DYNAMIC_FACETABLE_ENABLED - Dynamic facetable option enabled for a schema field.
DYNAMIC_FACETABLE_DISABLED - Dynamic facetable option disabled for a schema field.
field_path
Type: STRING
Provider name: fieldPath
Description: Required. Field path of the schema field. For example: title, description, release_info.release_year.
field_type
Type: STRING
Provider name: fieldType
Description: Output only. Raw type of the field.
Possible values:
FIELD_TYPE_UNSPECIFIED - Field type is unspecified.
OBJECT - Field value type is Object.
STRING - Field value type is String.
NUMBER - Field value type is Number.
INTEGER - Field value type is Integer.
BOOLEAN - Field value type is Boolean.
GEOLOCATION - Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * id: a string representing the location id * longitude: a number representing the longitude coordinate of the location * latitude: a number repesenting the latitude coordinate of the location * address: a string representing the full address of the location latitude and longitude must always be provided together. At least one of a) address or b) latitude-longitude pair must be provided.
DATETIME - Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. '1420070400001' * a string representing the ISO 8601 date or date and time. e.g. '2015-01-01' or '2015-01-01T12:10:30Z'
indexable_option
Type: STRING
Provider name: indexableOption
Description: If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as object and boolean and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw INVALID_ARGUMENT error.
Possible values:
INDEXABLE_OPTION_UNSPECIFIED - Value used when unset.
INDEXABLE_ENABLED - Indexable option enabled for a schema field.
INDEXABLE_DISABLED - Indexable option disabled for a schema field.
key_property_type
Type: STRING
Provider name: keyPropertyType
Description: Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are title, description. Full list is defined by keyPropertyMapping in the schema field annotation. If the schema field has a KeyPropertyMapping annotation, indexable_option and searchable_option of this field cannot be modified.
metatag_name
Type: STRING
Provider name: metatagName
Description: Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.
recs_filterable_option
Type: STRING
Provider name: recsFilterableOption
Description: If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.
Possible values:
FILTERABLE_OPTION_UNSPECIFIED - Value used when unset.
FILTERABLE_ENABLED - Filterable option enabled for a schema field.
FILTERABLE_DISABLED - Filterable option disabled for a schema field.
retrievable_option
Type: STRING
Provider name: retrievableOption
Description: If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as object and boolean, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw INVALID_ARGUMENT error.
Possible values:
RETRIEVABLE_OPTION_UNSPECIFIED - Value used when unset.
RETRIEVABLE_ENABLED - Retrievable option enabled for a schema field.
RETRIEVABLE_DISABLED - Retrievable option disabled for a schema field.
schema_org_paths
Type: UNORDERED_LIST_STRING
Provider name: schemaOrgPaths
Description: Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at schema.org. It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from _root, with a period . as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
searchable_option
Type: STRING
Provider name: searchableOption
Description: If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only string fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw INVALID_ARGUMENT error.
Possible values:
SEARCHABLE_OPTION_UNSPECIFIED - Value used when unset.
SEARCHABLE_ENABLED - Searchable option enabled for a schema field.
SEARCHABLE_DISABLED - Searchable option disabled for a schema field.
json_schema
Type: STRING
Provider name: jsonSchema
Description: The JSON representation of the schema.
name
Type: STRING
Provider name: name
Description: Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
errors
Type: UNORDERED_LIST_STRUCT
Provider name: errors
Description: Output only. The errors from initialization or from the latest connector run.
code
Type: INT32
Provider name: code
Description: The status code, which should be an enum value of google.rpc.Code.
message
Type: STRING
Provider name: message
Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
identity_refresh_interval
Type: STRING
Provider name: identityRefreshInterval
Description: The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
identity_schedule_config
Type: STRUCT
Provider name: identityScheduleConfig
Description: 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.
next_sync_time
Type: STRUCT
Provider name: nextSyncTime
Description: Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day.
day
Type: INT32
Provider name: day
Description: Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
hours
Type: INT32
Provider name: hours
Description: Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value “24:00:00” for scenarios like business closing time.
minutes
Type: INT32
Provider name: minutes
Description: Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
month
Type: INT32
Provider name: month
Description: Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
nanos
Type: INT32
Provider name: nanos
Description: Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
seconds
Type: INT32
Provider name: seconds
Description: Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
time_zone
Type: STRUCT
Provider name: timeZone
Description: Time zone.
id
Type: STRING
Provider name: id
Description: IANA Time Zone Database time zone. For example “America/New_York”.
version
Type: STRING
Provider name: version
Description: Optional. IANA Time Zone Database version number. For example “2019a”.
utc_offset
Type: STRING
Provider name: utcOffset
Description: UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
year
Type: INT32
Provider name: year
Description: Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
refresh_interval
Type: STRING
Provider name: refreshInterval
Description: Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
incremental_refresh_interval
Type: STRING
Provider name: incrementalRefreshInterval
Description: 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.
incremental_sync_disabled
Type: BOOLEAN
Provider name: incrementalSyncDisabled
Description: 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.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: 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.
last_sync_time
Type: TIMESTAMP
Provider name: lastSyncTime
Description: Output only. For periodic connectors only, the last time a data sync was completed.
latest_pause_time
Type: TIMESTAMP
Provider name: latestPauseTime
Description: 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.
name
Type: STRING
Provider name: name
Description: Output only. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.
next_sync_time
Type: STRUCT
Provider name: nextSyncTime
Description: 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.
day
Type: INT32
Provider name: day
Description: Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
hours
Type: INT32
Provider name: hours
Description: Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value “24:00:00” for scenarios like business closing time.
minutes
Type: INT32
Provider name: minutes
Description: Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
month
Type: INT32
Provider name: month
Description: Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
nanos
Type: INT32
Provider name: nanos
Description: Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
seconds
Type: INT32
Provider name: seconds
Description: Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
time_zone
Type: STRUCT
Provider name: timeZone
Description: Time zone.
id
Type: STRING
Provider name: id
Description: IANA Time Zone Database time zone. For example “America/New_York”.
version
Type: STRING
Provider name: version
Description: Optional. IANA Time Zone Database version number. For example “2019a”.
utc_offset
Type: STRING
Provider name: utcOffset
Description: UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
year
Type: INT32
Provider name: year
Description: Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
private_connectivity_project_id
Type: STRING
Provider name: privateConnectivityProjectId
Description: Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
realtime_state
Type: STRING
Provider name: realtimeState
Description: Output only. real-time sync state
Possible values:
STATE_UNSPECIFIED - Default value.
CREATING - The connector is being set up.
ACTIVE - The connector is successfully set up and awaiting next sync run.
FAILED - The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.
RUNNING - The connector is actively syncing records from the data source.
WARNING - The connector has completed a sync run, but encountered non-fatal errors.
INITIALIZATION_FAILED - Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).
UPDATING - Connector is in the process of an update.
realtime_sync_config
Type: STRUCT
Provider name: realtimeSyncConfig
Description: Optional. The configuration for realtime sync.
realtime_sync_secret
Type: STRING
Provider name: realtimeSyncSecret
Description: Optional. The ID of the Secret Manager secret used for webhook secret.
streaming_error
Type: STRUCT
Provider name: streamingError
Description: Optional. Streaming error details.
error
Type: STRUCT
Provider name: error
Description: Optional. Error details.
code
Type: INT32
Provider name: code
Description: The status code, which should be an enum value of google.rpc.Code.
message
Type: STRING
Provider name: message
Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
streaming_error_reason
Type: STRING
Provider name: streamingErrorReason
Description: Optional. Streaming error.
Possible values:
STREAMING_ERROR_REASON_UNSPECIFIED - Streaming error reason unspecified.
STREAMING_SETUP_ERROR - Some error occurred while setting up resources for realtime sync.
STREAMING_SYNC_ERROR - Some error was encountered while running realtime sync for the connector.
INGRESS_ENDPOINT_REQUIRED - Ingress endpoint is required when setting up realtime sync in private connectivity.
webhook_uri
Type: STRING
Provider name: webhookUri
Description: Optional. Webhook url for the connector to specify additional params for realtime sync.
refresh_interval
Type: STRING
Provider name: refreshInterval
Description: 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.
state
Type: STRING
Provider name: state
Description: Output only. State of the connector.
Possible values:
STATE_UNSPECIFIED - Default value.
CREATING - The connector is being set up.
ACTIVE - The connector is successfully set up and awaiting next sync run.
FAILED - The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.
RUNNING - The connector is actively syncing records from the data source.
WARNING - The connector has completed a sync run, but encountered non-fatal errors.
INITIALIZATION_FAILED - Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).
UPDATING - Connector is in the process of an update.
static_ip_addresses
Type: UNORDERED_LIST_STRING
Provider name: staticIpAddresses
Description: Output only. The static IP addresses used by this connector.
static_ip_enabled
Type: BOOLEAN
Provider name: staticIpEnabled
Description: Optional. Whether customer has enabled static IP addresses for this connector.
sync_mode
Type: STRING
Provider name: syncMode
Description: The data synchronization mode supported by the data connector.
Possible values:
PERIODIC - The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.
STREAMING - The data will be synced in real time.
UNSPECIFIED - Connector that doesn’t ingest data will have this value
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Timestamp the DataConnector was last updated.
gcp_display_name
Type: STRING
Provider name: displayName
Description: Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
labels
Type: UNORDERED_LIST_STRING
name
Type: STRING
Provider name: name
Description: Immutable. The full resource name of the Collection. Format: projects/{project}/locations/{location}/collections/{collection_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
organization_id
Type: STRING
parent
Type: STRING
project_id
Type: STRING
project_number
Type: STRING
resource_name
Type: STRING
Type: UNORDERED_LIST_STRING
