| <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.tagTemplates.html">tagTemplates</a> . <a href="datacatalog_v1beta1.projects.locations.tagTemplates.fields.html">fields</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="datacatalog_v1beta1.projects.locations.tagTemplates.fields.enumValues.html">enumValues()</a></code> |
| </p> |
| <p class="firstline">Returns the enumValues Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, tagTemplateFieldId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a field in a tag template. The user should enable the Data Catalog</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a field in a tag template and all uses of that field.</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 a field in a tag template. This method cannot be used to update the</p> |
| <p class="toc_element"> |
| <code><a href="#rename">rename(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Renames a field in a tag template. The user should enable the Data Catalog</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, tagTemplateFieldId=None, x__xgafv=None)</code> |
| <pre>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. |
| "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 |
| # create, remove and reorder enum values. To rename enum values, use the |
| # RenameTagTemplateFieldEnumValue method. This list can include 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. |
| "displayName": "A String", # The display name for this field. Defaults to an empty string. |
| } |
| |
| 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. |
| "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 |
| # create, remove and reorder enum values. To rename enum values, use the |
| # RenameTagTemplateFieldEnumValue method. This list can include 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. |
| "displayName": "A String", # The display name for this field. Defaults to an empty string. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code> |
| <pre>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); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>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. |
| "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 |
| # create, remove and reorder enum values. To rename enum values, use the |
| # RenameTagTemplateFieldEnumValue method. This list can include 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. |
| "displayName": "A String", # The display name for this field. Defaults to an empty string. |
| } |
| |
| updateMask: string, Optional. The field mask specifies the parts of the template to be updated. |
| Allowed fields: |
| |
| * `display_name` |
| * `type.enum_type` |
| * `is_required` |
| |
| If `update_mask` is not set or empty, all of the allowed fields above will |
| be updated. |
| |
| When updating an enum type, the provided values will be merged with the |
| existing values. Therefore, enum values can only be added, existing enum |
| values cannot be deleted nor renamed. 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. |
| "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 |
| # create, remove and reorder enum values. To rename enum values, use the |
| # RenameTagTemplateFieldEnumValue method. This list can include 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. |
| "displayName": "A String", # The display name for this field. Defaults to an empty string. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="rename">rename(name, body=None, x__xgafv=None)</code> |
| <pre>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. |
| "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 |
| # create, remove and reorder enum values. To rename enum values, use the |
| # RenameTagTemplateFieldEnumValue method. This list can include 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. |
| "displayName": "A String", # The display name for this field. Defaults to an empty string. |
| }</pre> |
| </div> |
| |
| </body></html> |
