# Google Cloud Data Catalog API . projects . locations . entryGroups . entries . tags

## Instance Methods

Close httplib2 connections.

Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.

Deletes a tag.

Lists tags assigned to an Entry. The columns in the response are lowercased.

Retrieves the next page of results.

Updates an existing tag.

`ReconcileTags` creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message.

### Method Details

`close()`

    Close httplib2 connections.

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

    Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.

    Args:
      parent: string, Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name. (required)
      body: object, The request body.
        The object takes the form of:

    { # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags.
      "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
      "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template.
      "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.
        "a_key": { # Contains the value and additional information on a field within a Tag.
          "boolValue": True or False, # The value of a tag field with a boolean type.
          "displayName": "A String", # Output only. The display name of this field.
          "doubleValue": 3.14, # The value of a tag field with a double type.
          "enumValue": { # An enum value. # The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.
            "displayName": "A String", # The display name of the enum value.
          },
          "order": 42, # Output only. The order of this field with respect to other fields in this tag. Can be set by Tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.
          "richtextValue": "A String", # The value of a tag field with a rich text type. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
          "stringValue": "A String", # The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters.
          "timestampValue": "A String", # The value of a tag field with a timestamp type.
        },
      },
      "name": "A String", # Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
      "template": "A String", # Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation.
      "templateDisplayName": "A String", # Output only. The display name of the tag template.
    }

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

    Returns:
      An object of the form:

        { # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags.
      "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
      "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template.
      "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.
        "a_key": { # Contains the value and additional information on a field within a Tag.
          "boolValue": True or False, # The value of a tag field with a boolean type.
          "displayName": "A String", # Output only. The display name of this field.
          "doubleValue": 3.14, # The value of a tag field with a double type.
          "enumValue": { # An enum value. # The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.
            "displayName": "A String", # The display name of the enum value.
          },
          "order": 42, # Output only. The order of this field with respect to other fields in this tag. Can be set by Tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.
          "richtextValue": "A String", # The value of a tag field with a rich text type. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
          "stringValue": "A String", # The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters.
          "timestampValue": "A String", # The value of a tag field with a timestamp type.
        },
      },
      "name": "A String", # Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
      "template": "A String", # Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation.
      "templateDisplayName": "A String", # Output only. The display name of the tag template.
    }

`delete(name, x__xgafv=None)`

    Deletes a tag.

    Args:
      name: string, Required. The name of the tag to delete. (required)
      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); }
    }

`list(parent, pageSize=None, pageToken=None, x__xgafv=None)`

    Lists tags assigned to an Entry. The columns in the response are lowercased.

    Args:
      parent: string, Required. The name of the Data Catalog resource to list the tags of. The resource can be an Entry or an EntryGroup (without `/entries/{entries}` at the end). (required)
      pageSize: integer, The maximum number of tags to return. Default is 10. Maximum limit is 1000.
      pageToken: string, Pagination token that specifies the next page to return. If empty, the first page is returned.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for ListTags.
      "nextPageToken": "A String", # Pagination token of the next results page. Empty if there are no more items in results.
      "tags": [ # Tag details.
        { # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags.
          "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
          "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template.
          "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.
            "a_key": { # Contains the value and additional information on a field within a Tag.
              "boolValue": True or False, # The value of a tag field with a boolean type.
              "displayName": "A String", # Output only. The display name of this field.
              "doubleValue": 3.14, # The value of a tag field with a double type.
              "enumValue": { # An enum value. # The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.
                "displayName": "A String", # The display name of the enum value.
              },
              "order": 42, # Output only. The order of this field with respect to other fields in this tag. Can be set by Tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.
              "richtextValue": "A String", # The value of a tag field with a rich text type. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
              "stringValue": "A String", # The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters.
              "timestampValue": "A String", # The value of a tag field with a timestamp type.
            },
          },
          "name": "A String", # Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
          "template": "A String", # Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation.
          "templateDisplayName": "A String", # Output only. The display name of the tag template.
        },
      ],
    }

`list_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.

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

    Updates an existing tag.

    Args:
      name: string, Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. (required)
      body: object, The request body.
        The object takes the form of:

    { # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags.
      "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
      "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template.
      "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.
        "a_key": { # Contains the value and additional information on a field within a Tag.
          "boolValue": True or False, # The value of a tag field with a boolean type.
          "displayName": "A String", # Output only. The display name of this field.
          "doubleValue": 3.14, # The value of a tag field with a double type.
          "enumValue": { # An enum value. # The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.
            "displayName": "A String", # The display name of the enum value.
          },
          "order": 42, # Output only. The order of this field with respect to other fields in this tag. Can be set by Tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.
          "richtextValue": "A String", # The value of a tag field with a rich text type. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
          "stringValue": "A String", # The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters.
          "timestampValue": "A String", # The value of a tag field with a timestamp type.
        },
      },
      "name": "A String", # Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
      "template": "A String", # Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation.
      "templateDisplayName": "A String", # Output only. The display name of the tag template.
    }

      updateMask: string, Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name `fields`. In general, 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.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags.
      "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
      "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template.
      "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.
        "a_key": { # Contains the value and additional information on a field within a Tag.
          "boolValue": True or False, # The value of a tag field with a boolean type.
          "displayName": "A String", # Output only. The display name of this field.
          "doubleValue": 3.14, # The value of a tag field with a double type.
          "enumValue": { # An enum value. # The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.
            "displayName": "A String", # The display name of the enum value.
          },
          "order": 42, # Output only. The order of this field with respect to other fields in this tag. Can be set by Tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.
          "richtextValue": "A String", # The value of a tag field with a rich text type. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
          "stringValue": "A String", # The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters.
          "timestampValue": "A String", # The value of a tag field with a timestamp type.
        },
      },
      "name": "A String", # Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
      "template": "A String", # Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation.
      "templateDisplayName": "A String", # Output only. The display name of the tag template.
    }

`reconcile(parent, body=None, x__xgafv=None)`

    `ReconcileTags` creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message.

    Args:
      parent: string, Required. Name of Entry to be tagged. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for ReconcileTags.
      "forceDeleteMissing": True or False, # If set to `true`, deletes entry tags related to a tag template not listed in the tags source from an entry. If set to `false`, unlisted tags are retained.
      "tagTemplate": "A String", # Required. The name of the tag template, which is used for reconciliation.
      "tags": [ # A list of tags to apply to an entry. A tag can specify a tag template, which must be the template specified in the `ReconcileTagsRequest`. The sole entry and each of its columns must be mentioned at most once.
        { # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags.
          "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
          "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template.
          "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.
            "a_key": { # Contains the value and additional information on a field within a Tag.
              "boolValue": True or False, # The value of a tag field with a boolean type.
              "displayName": "A String", # Output only. The display name of this field.
              "doubleValue": 3.14, # The value of a tag field with a double type.
              "enumValue": { # An enum value. # The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.
                "displayName": "A String", # The display name of the enum value.
              },
              "order": 42, # Output only. The order of this field with respect to other fields in this tag. Can be set by Tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.
              "richtextValue": "A String", # The value of a tag field with a rich text type. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
              "stringValue": "A String", # The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters.
              "timestampValue": "A String", # The value of a tag field with a timestamp type.
            },
          },
          "name": "A String", # Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
          "template": "A String", # Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation.
          "templateDisplayName": "A String", # Output only. The display name of the tag template.
        },
      ],
    }

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

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }