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

Inherits:

Object

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

Defined in:

lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb

Overview

The request for FirestoreAdmin::UpdateField.

Instance Attribute Summary

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

  Required.

• #update_mask ⇒ Google::Protobuf::FieldMask

  A mask, relative to the field.

Instance Attribute Details

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

Returns Required. The field to be updated.

Returns:

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

  Required. The field to be updated.

# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb', line 80

class UpdateFieldRequest; 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 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb', line 80

class UpdateFieldRequest; end