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

Instance Methods

close()

Close httplib2 connections.

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

Renames an enum value in a tag template. The enum values have to be unique within one enum field. Thus, an enum value cannot be renamed with a name used in any other enum value within the same enum field.

Method Details

close()
Close httplib2 connections.
rename(name, body=None, x__xgafv=None)
Renames an enum value in a tag template. The enum values have to be unique within one enum field. Thus, an enum value cannot be renamed with a name used in any other enum value within the same enum field.

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

{ # Request message for RenameTagTemplateFieldEnumValue.
    "newEnumValueDisplayName": "A String", # Required. The new display name of the enum value. For example, `my_new_enum_value`.
  }

  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.
    "displayName": "A String", # The display name for this field. Defaults to an empty string.
    "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.
      "primitiveType": "A String", # Represents primitive types - string, bool etc.
      "enumType": { # Represents an enum type.
        "allowedValues": [ # The set of allowed values for this enum. This set must not be empty, the display names of the values in this set must not be empty and the display names of the values must be case-insensitively unique within this set. The order of items in this list is preserved. This field can be used to Required on create; optional on update. The set of allowed values for this enum. This set must not be empty, the display names of the values in this set must not be empty and the display names of the values must be case-insensitively unique within this set. Currently, enum values can only be added to the list of allowed values. Deletion and renaming of enum values are not supported. Can have up to 500 allowed values.
          {
            "displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
          },
        ],
      },
    },
    "name": "A String", # Output only. 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.
    "isRequired": True or False, # Whether this is a required field. Defaults to false.
  }