Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest.
The request for FirestoreAdmin.UpdateField.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#field
def field() -> ::Google::Cloud::Firestore::Admin::V1::Field
Returns
- (::Google::Cloud::Firestore::Admin::V1::Field) — Required. The field to be updated.
#field=
def field=(value) -> ::Google::Cloud::Firestore::Admin::V1::Field
Parameter
- value (::Google::Cloud::Firestore::Admin::V1::Field) — Required. The field to be updated.
Returns
- (::Google::Cloud::Firestore::Admin::V1::Field) — Required. The field to be updated.
#update_mask
def update_mask() -> ::Google::Protobuf::FieldMask
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.
#update_mask=
def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
- value (::Google::Protobuf::FieldMask) — 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.