GoogleApi.CloudSearch.V1.Api.Indexing.cloudsearch_indexing_datasources_items_list

You're seeing just the function cloudsearch_indexing_datasources_items_list, go back to GoogleApi.CloudSearch.V1.Api.Indexing module for more information.
Link to this function

cloudsearch_indexing_datasources_items_list(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudsearch_indexing_datasources_items_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudSearch.V1.Model.ListItemsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • name (type: String.t) - Name of the Data Source to list Items. Format: datasources/{source_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :brief (type: boolean()) - When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, If this value is false, then all the fields are populated in Item.
    • :connectorName (type: String.t) - Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
    • :"debugOptions.enableDebugging" (type: boolean()) - If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
    • :pageSize (type: integer()) - Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false. The default value is 10
    • :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.ListItemsResponse{}} on success
  • {:error, info} on failure