blob: 2d3f6e0f17d4e92cfd27fabe4a3ff81957462a1e [file] [log] [blame]
<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> . <a href="datacatalog_v1beta1.projects.locations.tagTemplates.fields.enumValues.html">enumValues</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#rename">rename(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Renames an enum value in a tag template. The enum values have to be unique</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="rename">rename(name, body=None, x__xgafv=None)</code>
<pre>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.
&quot;newEnumValueDisplayName&quot;: &quot;A String&quot;, # 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.
&quot;order&quot;: 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.
&quot;type&quot;: { # Required. The type of value this tag field can contain.
&quot;primitiveType&quot;: &quot;A String&quot;, # Represents primitive types - string, bool etc.
&quot;enumType&quot;: { # Represents an enum type.
&quot;allowedValues&quot;: [ # 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.
{
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the enum value. Must not be an empty string.
},
],
},
},
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;isRequired&quot;: True or False, # Whether this is a required field. Defaults to false.
&quot;displayName&quot;: &quot;A String&quot;, # The display name for this field. Defaults to an empty string.
}</pre>
</div>
</body></html>