| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="datacatalog_v1beta1.html">Google Cloud Data Catalog API</a> . <a href="datacatalog_v1beta1.projects.html">projects</a> . <a href="datacatalog_v1beta1.projects.locations.html">locations</a> . <a href="datacatalog_v1beta1.projects.locations.entryGroups.html">entryGroups</a> . <a href="datacatalog_v1beta1.projects.locations.entryGroups.entries.html">entries</a> . <a href="datacatalog_v1beta1.projects.locations.entryGroups.entries.tags.html">tags</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a tag on an Entry.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a tag.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the tags on an Entry.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing tag.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Creates a tag on an Entry. |
| Note: The project identified by the `parent` parameter for the |
| [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) |
| and the |
| [tag |
| template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) |
| used to create the tag must be from the same organization. |
| |
| Args: |
| parent: string, Required. The name of the resource to attach this tag to. Tags can be attached to |
| Entries. Example: |
| |
| * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} |
| |
| Note that this Tag and its child resources may not actually be stored in |
| the location in this name. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Tags are used to attach custom metadata to Data Catalog resources. Tags |
| # conform to the specifications within 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 users to attach tags to an individual column based on that schema. |
| # |
| # For attaching a tag to a nested column, use `.` to separate the column |
| # names. Example: |
| # |
| # * `outer_column.inner_column` |
| "templateDisplayName": "A String", # Output only. The display name of the tag template. |
| "fields": { # Required. This maps the ID of a tag field to the value of and additional information |
| # about that field. Valid field IDs are defined by the tag's template. A tag |
| # must have at least 1 field and at most 500 fields. |
| "a_key": { # Contains the value and supporting information for a field within |
| # a Tag. |
| "order": 42, # Output only. The order of this field with respect to other fields in this tag. It can be |
| # set in 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 do not have to be sequential. |
| "boolValue": True or False, # Holds the value for a tag field with boolean type. |
| "timestampValue": "A String", # Holds the value for a tag field with timestamp type. |
| "stringValue": "A String", # Holds the value for a tag field with string type. |
| "enumValue": { # Holds an enum value. # Holds the value for a tag field with enum type. This value must be |
| # one of the allowed values in the definition of this enum. |
| "displayName": "A String", # The display name of the enum value. |
| }, |
| "displayName": "A String", # Output only. The display name of this field. |
| "doubleValue": 3.14, # Holds the value for a tag field with double type. |
| }, |
| }, |
| "name": "A String", # The resource name of the tag in URL format. Example: |
| # |
| # * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} |
| # |
| # where `tag_id` is a system-generated identifier. |
| # Note that this Tag may not actually be stored in the location in this name. |
| "template": "A String", # Required. The resource name of the tag template that this tag uses. Example: |
| # |
| # * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} |
| # |
| # This field cannot be modified after creation. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Tags are used to attach custom metadata to Data Catalog resources. Tags |
| # conform to the specifications within 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 users to attach tags to an individual column based on that schema. |
| # |
| # For attaching a tag to a nested column, use `.` to separate the column |
| # names. Example: |
| # |
| # * `outer_column.inner_column` |
| "templateDisplayName": "A String", # Output only. The display name of the tag template. |
| "fields": { # Required. This maps the ID of a tag field to the value of and additional information |
| # about that field. Valid field IDs are defined by the tag's template. A tag |
| # must have at least 1 field and at most 500 fields. |
| "a_key": { # Contains the value and supporting information for a field within |
| # a Tag. |
| "order": 42, # Output only. The order of this field with respect to other fields in this tag. It can be |
| # set in 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 do not have to be sequential. |
| "boolValue": True or False, # Holds the value for a tag field with boolean type. |
| "timestampValue": "A String", # Holds the value for a tag field with timestamp type. |
| "stringValue": "A String", # Holds the value for a tag field with string type. |
| "enumValue": { # Holds an enum value. # Holds the value for a tag field with enum type. This value must be |
| # one of the allowed values in the definition of this enum. |
| "displayName": "A String", # The display name of the enum value. |
| }, |
| "displayName": "A String", # Output only. The display name of this field. |
| "doubleValue": 3.14, # Holds the value for a tag field with double type. |
| }, |
| }, |
| "name": "A String", # The resource name of the tag in URL format. Example: |
| # |
| # * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} |
| # |
| # where `tag_id` is a system-generated identifier. |
| # Note that this Tag may not actually be stored in the location in this name. |
| "template": "A String", # Required. The resource name of the tag template that this tag uses. Example: |
| # |
| # * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} |
| # |
| # This field cannot be modified after creation. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a tag. |
| |
| Args: |
| name: string, Required. The name of the tag to delete. Example: |
| |
| * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} (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); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists the tags on an Entry. |
| |
| Args: |
| parent: string, Required. The name of the Data Catalog resource to list the tags of. The resource |
| could be an Entry or an |
| EntryGroup. |
| |
| Examples: |
| |
| * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} |
| * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} (required) |
| pageSize: integer, The maximum number of tags to return. Default is 10. Max limit is 1000. |
| pageToken: string, Token that specifies which page is requested. 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. |
| "tags": [ # Tag details. |
| { # Tags are used to attach custom metadata to Data Catalog resources. Tags |
| # conform to the specifications within 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 users to attach tags to an individual column based on that schema. |
| # |
| # For attaching a tag to a nested column, use `.` to separate the column |
| # names. Example: |
| # |
| # * `outer_column.inner_column` |
| "templateDisplayName": "A String", # Output only. The display name of the tag template. |
| "fields": { # Required. This maps the ID of a tag field to the value of and additional information |
| # about that field. Valid field IDs are defined by the tag's template. A tag |
| # must have at least 1 field and at most 500 fields. |
| "a_key": { # Contains the value and supporting information for a field within |
| # a Tag. |
| "order": 42, # Output only. The order of this field with respect to other fields in this tag. It can be |
| # set in 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 do not have to be sequential. |
| "boolValue": True or False, # Holds the value for a tag field with boolean type. |
| "timestampValue": "A String", # Holds the value for a tag field with timestamp type. |
| "stringValue": "A String", # Holds the value for a tag field with string type. |
| "enumValue": { # Holds an enum value. # Holds the value for a tag field with enum type. This value must be |
| # one of the allowed values in the definition of this enum. |
| "displayName": "A String", # The display name of the enum value. |
| }, |
| "displayName": "A String", # Output only. The display name of this field. |
| "doubleValue": 3.14, # Holds the value for a tag field with double type. |
| }, |
| }, |
| "name": "A String", # The resource name of the tag in URL format. Example: |
| # |
| # * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} |
| # |
| # where `tag_id` is a system-generated identifier. |
| # Note that this Tag may not actually be stored in the location in this name. |
| "template": "A String", # Required. The resource name of the tag template that this tag uses. Example: |
| # |
| # * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} |
| # |
| # This field cannot be modified after creation. |
| }, |
| ], |
| "nextPageToken": "A String", # Token to retrieve the next page of results. It is set to empty if no items |
| # remain in results. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates an existing tag. |
| |
| Args: |
| name: string, The resource name of the tag in URL format. Example: |
| |
| * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} |
| |
| where `tag_id` is a system-generated identifier. |
| Note that this Tag may not actually be stored in the location in this name. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Tags are used to attach custom metadata to Data Catalog resources. Tags |
| # conform to the specifications within 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 users to attach tags to an individual column based on that schema. |
| # |
| # For attaching a tag to a nested column, use `.` to separate the column |
| # names. Example: |
| # |
| # * `outer_column.inner_column` |
| "templateDisplayName": "A String", # Output only. The display name of the tag template. |
| "fields": { # Required. This maps the ID of a tag field to the value of and additional information |
| # about that field. Valid field IDs are defined by the tag's template. A tag |
| # must have at least 1 field and at most 500 fields. |
| "a_key": { # Contains the value and supporting information for a field within |
| # a Tag. |
| "order": 42, # Output only. The order of this field with respect to other fields in this tag. It can be |
| # set in 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 do not have to be sequential. |
| "boolValue": True or False, # Holds the value for a tag field with boolean type. |
| "timestampValue": "A String", # Holds the value for a tag field with timestamp type. |
| "stringValue": "A String", # Holds the value for a tag field with string type. |
| "enumValue": { # Holds an enum value. # Holds the value for a tag field with enum type. This value must be |
| # one of the allowed values in the definition of this enum. |
| "displayName": "A String", # The display name of the enum value. |
| }, |
| "displayName": "A String", # Output only. The display name of this field. |
| "doubleValue": 3.14, # Holds the value for a tag field with double type. |
| }, |
| }, |
| "name": "A String", # The resource name of the tag in URL format. Example: |
| # |
| # * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} |
| # |
| # where `tag_id` is a system-generated identifier. |
| # Note that this Tag may not actually be stored in the location in this name. |
| "template": "A String", # Required. The resource name of the tag template that this tag uses. Example: |
| # |
| # * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} |
| # |
| # This field cannot be modified after creation. |
| } |
| |
| updateMask: string, The fields to update on the Tag. If absent or empty, all modifiable fields |
| are updated. Currently the only modifiable field is the field `fields`. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Tags are used to attach custom metadata to Data Catalog resources. Tags |
| # conform to the specifications within 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 users to attach tags to an individual column based on that schema. |
| # |
| # For attaching a tag to a nested column, use `.` to separate the column |
| # names. Example: |
| # |
| # * `outer_column.inner_column` |
| "templateDisplayName": "A String", # Output only. The display name of the tag template. |
| "fields": { # Required. This maps the ID of a tag field to the value of and additional information |
| # about that field. Valid field IDs are defined by the tag's template. A tag |
| # must have at least 1 field and at most 500 fields. |
| "a_key": { # Contains the value and supporting information for a field within |
| # a Tag. |
| "order": 42, # Output only. The order of this field with respect to other fields in this tag. It can be |
| # set in 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 do not have to be sequential. |
| "boolValue": True or False, # Holds the value for a tag field with boolean type. |
| "timestampValue": "A String", # Holds the value for a tag field with timestamp type. |
| "stringValue": "A String", # Holds the value for a tag field with string type. |
| "enumValue": { # Holds an enum value. # Holds the value for a tag field with enum type. This value must be |
| # one of the allowed values in the definition of this enum. |
| "displayName": "A String", # The display name of the enum value. |
| }, |
| "displayName": "A String", # Output only. The display name of this field. |
| "doubleValue": 3.14, # Holds the value for a tag field with double type. |
| }, |
| }, |
| "name": "A String", # The resource name of the tag in URL format. Example: |
| # |
| # * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} |
| # |
| # where `tag_id` is a system-generated identifier. |
| # Note that this Tag may not actually be stored in the location in this name. |
| "template": "A String", # Required. The resource name of the tag template that this tag uses. Example: |
| # |
| # * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} |
| # |
| # This field cannot be modified after creation. |
| }</pre> |
| </div> |
| |
| </body></html> |
