View Source GoogleApi.ContentWarehouse.V1.Api.Projects (google_api_content_warehouse v0.4.0)

API calls for all endpoints tagged Projects.

Summary

Functions

contentwarehouse_projects_fetch_acl(connection, resource, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

contentwarehouse_projects_locations_document_schemas_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a document schema.

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

Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.

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

Gets a document schema. Returns NOT_FOUND if the document schema does not exist.

contentwarehouse_projects_locations_document_schemas_list(connection, parent, optional_params \\ [], opts \\ [])

Lists document schemas.

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

Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.

contentwarehouse_projects_locations_documents_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a document.

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

Deletes a document. Returns NOT_FOUND if the document does not exist.

contentwarehouse_projects_locations_documents_document_links_create(connection, parent, optional_params \\ [], opts \\ [])

Create a link between a source document and a target document.

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

Remove the link between the source and target documents.

contentwarehouse_projects_locations_documents_fetch_acl(connection, resource, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

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

Gets a document. Returns NOT_FOUND if the document does not exist.

contentwarehouse_projects_locations_documents_linked_sources(connection, parent, optional_params \\ [], opts \\ [])

Return all source document-links from the document.

contentwarehouse_projects_locations_documents_linked_targets(connection, parent, optional_params \\ [], opts \\ [])

Return all target document-links from the document.

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

Lock the document so the document cannot be updated by other users.

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

Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

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

Deletes a document. Returns NOT_FOUND if the document does not exist.

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

Gets a document. Returns NOT_FOUND if the document does not exist.

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

Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

contentwarehouse_projects_locations_documents_search(connection, parent, optional_params \\ [], opts \\ [])

Searches for documents using provided SearchDocumentsRequest. This call only returns documents that the caller has permission to search against.

contentwarehouse_projects_locations_documents_set_acl(connection, resource, optional_params \\ [], opts \\ [])

Sets the access control policy for a resource. Replaces any existing policy.

contentwarehouse_projects_locations_get_status(connection, location, optional_params \\ [], opts \\ [])

Get the project status.

contentwarehouse_projects_locations_initialize(connection, location, optional_params \\ [], opts \\ [])

Provisions resources for given tenant project. Returns a long running operation.

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

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

contentwarehouse_projects_locations_rule_sets_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a ruleset.

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

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

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

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

contentwarehouse_projects_locations_rule_sets_list(connection, parent, optional_params \\ [], opts \\ [])

Lists rulesets.

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

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

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

Run a predefined pipeline.

contentwarehouse_projects_locations_synonym_sets_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.

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

Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found.

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

Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist

contentwarehouse_projects_locations_synonym_sets_list(connection, parent, optional_params \\ [], opts \\ [])

Returns all SynonymSets (for all contexts) for the specified location.

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

Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found.

contentwarehouse_projects_set_acl(connection, resource, optional_params \\ [], opts \\ [])

Sets the access control policy for a resource. Replaces any existing policy.

Functions

Link to this function

contentwarehouse_projects_fetch_acl(connection, resource, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_fetch_acl(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FetchAclResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • resource (type: String.t) - Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for collection: projects/{project_number}/locations/{location}/collections/{collection_id}. Format for project: projects/{project_number}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FetchAclRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FetchAclResponse{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_document_schemas_create(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_document_schemas_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DocumentSchema.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a document schema.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent name.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DocumentSchema.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DocumentSchema{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_document_schemas_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document schema to delete.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_document_schemas_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DocumentSchema.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a document schema. Returns NOT_FOUND if the document schema does not exist.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document schema to retrieve.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DocumentSchema{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_document_schemas_list(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_document_schemas_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListDocumentSchemasResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists document schemas.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent, which owns this collection of document schemas. Format: projects/{project_number}/locations/{location}.
  • 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").
    • :pageSize (type: integer()) - The maximum number of document schemas to return. The service may return fewer than this value. If unspecified, at most 50 document schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
    • :pageToken (type: String.t) - A page token, received from a previous ListDocumentSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDocumentSchemas must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListDocumentSchemasResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_document_schemas_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DocumentSchema.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document schema to update. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DocumentSchema{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_documents_create(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_documents_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1CreateDocumentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a document.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent name. Format: projects/{project_number}/locations/{location}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1CreateDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1CreateDocumentResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_documents_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a document. Returns NOT_FOUND if the document does not exist.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to delete. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DeleteDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_documents_fetch_acl(connection, resource, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_documents_fetch_acl(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FetchAclResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • resource (type: String.t) - Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for collection: projects/{project_number}/locations/{location}/collections/{collection_id}. Format for project: projects/{project_number}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FetchAclRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FetchAclResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_documents_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1Document.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a document. Returns NOT_FOUND if the document does not exist.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1GetDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1Document{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_documents_linked_sources(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_documents_linked_sources(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListLinkedSourcesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Return all source document-links from the document.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the document, for which all source links are returned. Format: projects/{project_number}/locations/{location}/documents/{source_document_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListLinkedSourcesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListLinkedSourcesResponse{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_documents_linked_targets(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_documents_linked_targets(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListLinkedTargetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Return all target document-links from the document.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the document, for which all target links are returned. Format: projects/{project_number}/locations/{location}/documents/{target_document_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListLinkedTargetsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListLinkedTargetsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_documents_lock(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1Document.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lock the document so the document cannot be updated by other users.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to lock. Format: projects/{project_number}/locations/{location}/documents/{document}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1LockDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1Document{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_documents_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1UpdateDocumentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1UpdateDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1UpdateDocumentResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_documents_reference_id_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a document. Returns NOT_FOUND if the document does not exist.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to delete. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DeleteDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_documents_reference_id_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1Document.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a document. Returns NOT_FOUND if the document does not exist.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1GetDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1Document{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_documents_reference_id_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1UpdateDocumentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1UpdateDocumentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1UpdateDocumentResponse{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_documents_search(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_documents_search(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Searches for documents using provided SearchDocumentsRequest. This call only returns documents that the caller has permission to search against.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponse{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_documents_set_acl(connection, resource, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_documents_set_acl(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SetAclResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the access control policy for a resource. Replaces any existing policy.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • resource (type: String.t) - Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for collection: projects/{project_number}/locations/{location}/collections/{collection_id}. Format for project: projects/{project_number}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SetAclRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SetAclResponse{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_get_status(connection, location, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_get_status(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ProjectStatus.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get the project status.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • location (type: String.t) - Required. The location to be queried Format: projects/{project_number}/locations/{location}.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ProjectStatus{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_initialize(connection, location, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_initialize(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContentWarehouse.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Provisions resources for given tenant project. Returns a long running operation.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • location (type: String.t) - Required. The location to be initialized Format: projects/{project_number}/locations/{location}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1InitializeProjectRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContentWarehouse.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_rule_sets_create(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_rule_sets_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1RuleSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a ruleset.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent name. Format: projects/{project_number}/locations/{location}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1RuleSet.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1RuleSet{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_rule_sets_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the rule set to delete. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_rule_sets_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1RuleSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the rule set to retrieve. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1RuleSet{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_rule_sets_list(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_rule_sets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListRuleSetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists rulesets.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}.
  • 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").
    • :pageSize (type: integer()) - The maximum number of rule sets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
    • :pageToken (type: String.t) - A page token, received from a previous ListRuleSets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRuleSets must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListRuleSetsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_rule_sets_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1RuleSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the rule set to update. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1UpdateRuleSetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1RuleSet{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_run_pipeline(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContentWarehouse.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Run a predefined pipeline.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name which owns the resources of the pipeline. Format: projects/{project_number}/locations/{location}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1RunPipelineRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_synonym_sets_create(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_synonym_sets_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SynonymSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent name. Format: projects/{project_number}/locations/{location}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SynonymSet.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SynonymSet{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_synonym_sets_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the synonymSet to delete Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_synonym_sets_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SynonymSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the synonymSet to retrieve Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SynonymSet{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_locations_synonym_sets_list(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_locations_synonym_sets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListSynonymSetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns all SynonymSets (for all contexts) for the specified location.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent name. Format: projects/{project_number}/locations/{location}.
  • 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").
    • :pageSize (type: integer()) - The maximum number of synonymSets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
    • :pageToken (type: String.t) - A page token, received from a previous ListSynonymSets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSynonymSets must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ListSynonymSetsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec contentwarehouse_projects_locations_synonym_sets_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SynonymSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the synonymSet to update Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SynonymSet.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SynonymSet{}} on success
  • {:error, info} on failure
Link to this function

contentwarehouse_projects_set_acl(connection, resource, optional_params \\ [], opts \\ [])

View Source 
@spec contentwarehouse_projects_set_acl(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SetAclResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the access control policy for a resource. Replaces any existing policy.

Parameters

  • connection (type: GoogleApi.ContentWarehouse.V1.Connection.t) - Connection to server
  • resource (type: String.t) - Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for collection: projects/{project_number}/locations/{location}/collections/{collection_id}. Format for project: projects/{project_number}.
  • 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").
    • :body (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SetAclRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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