Google Cloud Data Catalog API . projects . locations . tagTemplates . fields

close()

Close httplib2 connections.

create(parent, body=None, tagTemplateFieldId=None, x__xgafv=None)

Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).

Args:
  parent: string, Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions). Example: * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # The template for an individual field within a tag template.
  "description": "A String", # The description for this field. Defaults to an empty string.
  "displayName": "A String", # The display name for this field. Defaults to an empty string.
  "isRequired": True or False, # Whether this is a required field. Defaults to false.
  "name": "A String", # Output only. Identifier. The resource name of the tag template field in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name.
  "order": 42, # The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
  "type": { # Required. The type of value this tag field can contain.
    "enumType": { # Represents an enum type.
      "allowedValues": [
        {
          "displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
        },
      ],
    },
    "primitiveType": "A String", # Represents primitive types - string, bool etc.
  },
}

  tagTemplateFieldId: string, Required. The ID of the tag template field to create. Field ids can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The template for an individual field within a tag template.
  "description": "A String", # The description for this field. Defaults to an empty string.
  "displayName": "A String", # The display name for this field. Defaults to an empty string.
  "isRequired": True or False, # Whether this is a required field. Defaults to false.
  "name": "A String", # Output only. Identifier. The resource name of the tag template field in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name.
  "order": 42, # The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
  "type": { # Required. The type of value this tag field can contain.
    "enumType": { # Represents an enum type.
      "allowedValues": [
        {
          "displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
        },
      ],
    },
    "primitiveType": "A String", # Represents primitive types - string, bool etc.
  },
}

delete(name, force=None, x__xgafv=None)

Deletes a field in a tag template and all uses of that field. 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).

Args:
  name: string, Required. The name of the tag template field to delete. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} (required)
  force: boolean, Required. Currently, this field must always be set to `true`. This confirms the deletion of this field from any tags using this field. `force = false` will be supported in the future.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

patch(name, body=None, updateMask=None, x__xgafv=None)

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).

Args:
  name: string, Required. The name of the tag template field. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # The template for an individual field within a tag template.
  "description": "A String", # The description for this field. Defaults to an empty string.
  "displayName": "A String", # The display name for this field. Defaults to an empty string.
  "isRequired": True or False, # Whether this is a required field. Defaults to false.
  "name": "A String", # Output only. Identifier. The resource name of the tag template field in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name.
  "order": 42, # The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
  "type": { # Required. The type of value this tag field can contain.
    "enumType": { # Represents an enum type.
      "allowedValues": [
        {
          "displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
        },
      ],
    },
    "primitiveType": "A String", # Represents primitive types - string, bool etc.
  },
}

  updateMask: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The template for an individual field within a tag template.
  "description": "A String", # The description for this field. Defaults to an empty string.
  "displayName": "A String", # The display name for this field. Defaults to an empty string.
  "isRequired": True or False, # Whether this is a required field. Defaults to false.
  "name": "A String", # Output only. Identifier. The resource name of the tag template field in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name.
  "order": 42, # The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
  "type": { # Required. The type of value this tag field can contain.
    "enumType": { # Represents an enum type.
      "allowedValues": [
        {
          "displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
        },
      ],
    },
    "primitiveType": "A String", # Represents primitive types - string, bool etc.
  },
}

rename(name, body=None, x__xgafv=None)

Renames a field in a tag template. The user 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).

Args:
  name: string, Required. The name of the tag template. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for RenameTagTemplateField.
  "newTagTemplateFieldId": "A String", # Required. The new ID of this tag template field. For example, `my_new_field`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The template for an individual field within a tag template.
  "description": "A String", # The description for this field. Defaults to an empty string.
  "displayName": "A String", # The display name for this field. Defaults to an empty string.
  "isRequired": True or False, # Whether this is a required field. Defaults to false.
  "name": "A String", # Output only. Identifier. The resource name of the tag template field in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name.
  "order": 42, # The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
  "type": { # Required. The type of value this tag field can contain.
    "enumType": { # Represents an enum type.
      "allowedValues": [
        {
          "displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
        },
      ],
    },
    "primitiveType": "A String", # Represents primitive types - string, bool etc.
  },
}