Discovery Engine API . projects . locations . collections . dataConnector . connectorRuns

Instance Methods

close()

Close httplib2 connections.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists the ConnectorRuns of a DataConnector.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the ConnectorRuns of a DataConnector.

Args:
  parent: string, Required. The parent DataConnector resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to list ConnectorRuns under this DataConnector, regardless of whether or not this DataConnector exists, a PERMISSION_DENIED error is returned. (required)
  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
  pageToken: string, A page token, received from a previous `ListConnectorRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorRuns` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for DataConnectorService.ListConnectorRuns method.
  "connectorRuns": [ # List of ConnectorRuns.
    { # A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //
      "endTime": "A String", # Output only. The time when the connector run ended.
      "entityRuns": [ # Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.
        { # Represents an entity that was synced in this ConnectorRun.
          "deletedRecordCount": "A String", # The number of documents deleted.
          "entityName": "A String", # The name of the source entity.
          "errorRecordCount": "A String", # The total number of documents failed at sync at any stage (extraction, indexing, etc).
          "errors": [ # The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message.
            { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
              "code": 42, # The status code, which should be an enum value of google.rpc.Code.
              "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
                {
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              ],
              "message": "A String", # 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.
            },
          ],
          "extractedRecordCount": "A String", # The number of documents extracted from connector source, ready to be ingested to UCS.
          "indexedRecordCount": "A String", # The number of documents indexed.
          "progress": { # Represents the progress of a sync run. # Metadata to generate the progress bar.
            "currentCount": "A String", # The current progress.
            "percentile": 3.14, # Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.
            "totalCount": "A String", # The total.
          },
          "sourceApiRequestCount": "A String", # The number of requests sent to 3p API.
          "state": "A String", # The state of the entity's sync run.
          "stateUpdateTime": "A String", # Timestamp at which the entity sync state was last updated.
          "statsUpdateTime": "A String", # The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.
          "syncType": "A String", # Sync type of this run.
        },
      ],
      "errors": [ # Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field.
        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "message": "A String", # 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.
        },
      ],
      "latestPauseTime": "A String", # Output only. The time when the connector run was most recently paused.
      "name": "A String", # Output only. The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.
      "startTime": "A String", # Output only. The time when the connector run started.
      "state": "A String", # Output only. The state of the sync run.
      "stateUpdateTime": "A String", # Timestamp at which the connector run sync state was last updated.
      "trigger": "A String", # Output only. The trigger for this ConnectorRun.
    },
  ],
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.