Class: Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datacatalog/v1/datacatalog.rb

Overview

Request message for UpdateTagTemplateField.

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ ::String

Returns Required. The name of the tag template field.

Returns:

  • (::String) —

    Required. The name of the tag template field.



1245
1246
1247
1248
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 1245

class UpdateTagTemplateFieldRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#tag_template_field ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

Returns Required. The template to update.

Returns:



1245
1246
1247
1248
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 1245

class UpdateTagTemplateFieldRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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.

Returns:

  • (::Google::Protobuf::FieldMask) —

    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.



1245
1246
1247
1248
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 1245

class UpdateTagTemplateFieldRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end