Class: Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest

Inherits:

Object

• Object
• Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/firestore/admin/v1/firestore_admin.rb

Overview

The request for FirestoreAdmin.UpdateField.

Instance Attribute Summary

• #field ⇒ ::Google::Cloud::Firestore::Admin::V1::Field

  Required.

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

  A mask, relative to the field.

Instance Attribute Details

#field ⇒ ::Google::Cloud::Firestore::Admin::V1::Field

Returns Required. The field to be updated.

Returns:

• (::Google::Cloud::Firestore::Admin::V1::Field) —

  Required. The field to be updated.

# File 'proto_docs/google/firestore/admin/v1/firestore_admin.rb', line 296

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

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

Returns A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

Returns:

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

  A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

# File 'proto_docs/google/firestore/admin/v1/firestore_admin.rb', line 296

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