GoogleApi.DataCatalog.V1beta1.Api.Projects.datacatalog_projects_locations_tag_templates_fields_patch

You're seeing just the function datacatalog_projects_locations_tag_templates_fields_patch, go back to GoogleApi.DataCatalog.V1beta1.Api.Projects module for more information.
Link to this function

datacatalog_projects_locations_tag_templates_fields_patch(connection, projects_id, locations_id, tag_templates_id, fields_id, optional_params \\ [], opts \\ [])

View Source

Specs

datacatalog_projects_locations_tag_templates_fields_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The name of the tag template field. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • tag_templates_id (type: String.t) - Part of name. See documentation of projectsId.
  • fields_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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").
    • :updateMask (type: String.t) - Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable: display_name type.enum_type is_required If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not* allowed.
    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField{}} on success
  • {:error, info} on failure