Data Catalog v1 API - Class UpdateTagTemplateFieldRequest (2.3.0)

public sealed class UpdateTagTemplateFieldRequest : IMessage<UpdateTagTemplateFieldRequest>, IEquatable<UpdateTagTemplateFieldRequest>, IDeepCloneable<UpdateTagTemplateFieldRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Data Catalog v1 API class UpdateTagTemplateFieldRequest.

Request message for [UpdateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField].

Inheritance

object > UpdateTagTemplateFieldRequest

Namespace

GoogleCloudGoogle.Cloud.DataCatalogV1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

UpdateTagTemplateFieldRequest()

public UpdateTagTemplateFieldRequest()

UpdateTagTemplateFieldRequest(UpdateTagTemplateFieldRequest)

public UpdateTagTemplateFieldRequest(UpdateTagTemplateFieldRequest other)
Parameter
NameDescription
otherUpdateTagTemplateFieldRequest

Properties

Name

public string Name { get; set; }

Required. The name of the tag template field.

Property Value
TypeDescription
string

TagTemplateField

public TagTemplateField TagTemplateField { get; set; }

Required. The template to update.

Property Value
TypeDescription
TagTemplateField

TagTemplateFieldName

public TagTemplateFieldName TagTemplateFieldName { get; set; }

TagTemplateFieldName-typed view over the Name resource name property.

Property Value
TypeDescription
TagTemplateFieldName

UpdateMask

public FieldMask UpdateMask { get; set; }

Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:

  • display_name
  • type.enum_type
  • is_required

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 with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.

Additionally, updating a template field from optional to required is not allowed.

Property Value
TypeDescription
FieldMask