google-api-client 0.41.2 → 0.44.0

data/generated/google/apis/firestore_v1beta2.rb

@@ -26,7 +26,7 @@ module Google
     # @see https://cloud.google.com/firestore
     module FirestoreV1beta2
       VERSION = 'V1beta2'
-      REVISION = '20200215'
+      REVISION = '20200801'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

data/generated/google/apis/firestore_v1beta2/classes.rb

@@ -22,13 +22,11 @@ module Google
   module Apis
     module FirestoreV1beta2
       
-      # A generic empty message that you can re-use to avoid defining duplicated
-      # empty messages in your APIs. A typical example is to use it as the request
-      # or the response type of an API method. For instance:
-      # service Foo `
-      # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
-      # `
-      # The JSON representation for `Empty` is empty JSON object ````.
+      # A generic empty message that you can re-use to avoid defining duplicated empty
+      # messages in your APIs. A typical example is to use it as the request or the
+      # response type of an API method. For instance: service Foo ` rpc Bar(google.
+      # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
+      # `Empty` is empty JSON object ````.
       class Empty
         include Google::Apis::Core::Hashable
       
@@ -41,8 +39,8 @@ module Google
         end
       end
       
-      # Metadata for google.longrunning.Operation results from
-      # FirestoreAdmin.ExportDocuments.
+      # Metadata for google.longrunning.Operation results from FirestoreAdmin.
+      # ExportDocuments.
       class GoogleFirestoreAdminV1beta2ExportDocumentsMetadata
         include Google::Apis::Core::Hashable
       
@@ -67,16 +65,14 @@ module Google
         # @return [String]
         attr_accessor :output_uri_prefix
       
-        # Describes the progress of the operation.
-        # Unit of work is generic and must be interpreted based on where Progress
-        # is used.
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
         # Corresponds to the JSON property `progressBytes`
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
         attr_accessor :progress_bytes
       
-        # Describes the progress of the operation.
-        # Unit of work is generic and must be interpreted based on where Progress
-        # is used.
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
         # Corresponds to the JSON property `progressDocuments`
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
         attr_accessor :progress_documents
@@ -111,14 +107,13 @@ module Google
         # @return [Array<String>]
         attr_accessor :collection_ids
       
-        # The output URI. Currently only supports Google Cloud Storage URIs of the
-        # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
-        # of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
-        # Google Cloud Storage namespace path. When
-        # choosing a name, be sure to consider Google Cloud Storage naming
-        # guidelines: https://cloud.google.com/storage/docs/naming.
-        # If the URI is a bucket (without a namespace path), a prefix will be
-        # generated based on the start time.
+        # The output URI. Currently only supports Google Cloud Storage URIs of the form:
+        # `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the
+        # Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud
+        # Storage namespace path. When choosing a name, be sure to consider Google Cloud
+        # Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If
+        # the URI is a bucket (without a namespace path), a prefix will be generated
+        # based on the start time.
         # Corresponds to the JSON property `outputUriPrefix`
         # @return [String]
         attr_accessor :output_uri_prefix
@@ -138,9 +133,9 @@ module Google
       class GoogleFirestoreAdminV1beta2ExportDocumentsResponse
         include Google::Apis::Core::Hashable
       
-        # Location of the output files. This can be used to begin an import
-        # into Cloud Firestore (this project or another project) after the operation
-        # completes successfully.
+        # Location of the output files. This can be used to begin an import into Cloud
+        # Firestore (this project or another project) after the operation completes
+        # successfully.
         # Corresponds to the JSON property `outputUriPrefix`
         # @return [String]
         attr_accessor :output_uri_prefix
@@ -155,9 +150,9 @@ module Google
         end
       end
       
-      # Represents a single field in the database.
-      # Fields are grouped by their "Collection Group", which represent all
-      # collections in the database with the same id.
+      # Represents a single field in the database. Fields are grouped by their "
+      # Collection Group", which represent all collections in the database with the
+      # same id.
       class GoogleFirestoreAdminV1beta2Field
         include Google::Apis::Core::Hashable
       
@@ -166,28 +161,21 @@ module Google
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexConfig]
         attr_accessor :index_config
       
-        # A field name of the form
-        # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id`
-        # /fields/`field_path``
-        # A field path may be a simple field name, e.g. `address` or a path to fields
-        # within map_value , e.g. `address.city`,
-        # or a special field path. The only valid special field is `*`, which
-        # represents any field.
-        # Field paths may be quoted using ` (backtick). The only character that needs
-        # to be escaped within a quoted field path is the backtick character itself,
-        # escaped using a backslash. Special characters in field paths that
-        # must be quoted include: `*`, `.`,
-        # ``` (backtick), `[`, `]`, as well as any ascii symbolic characters.
-        # Examples:
-        # (Note: Comments here are written in markdown syntax, so there is an
-        # additional layer of backticks to represent a code block)
-        # `\`address.city\`` represents a field named `address.city`, not the map key
-        # `city` in the field `address`.
-        # `\`*\`` represents a field named `*`, not any field.
-        # A special `Field` contains the default indexing settings for all fields.
-        # This field's resource name is:
-        # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/
-        # fields/*`
+        # A field name of the form `projects/`project_id`/databases/`database_id`/
+        # collectionGroups/`collection_id`/fields/`field_path`` A field path may be a
+        # simple field name, e.g. `address` or a path to fields within map_value , e.g. `
+        # address.city`, or a special field path. The only valid special field is `*`,
+        # which represents any field. Field paths may be quoted using ` (backtick). The
+        # only character that needs to be escaped within a quoted field path is the
+        # backtick character itself, escaped using a backslash. Special characters in
+        # field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`,
+        # as well as any ascii symbolic characters. Examples: (Note: Comments here are
+        # written in markdown syntax, so there is an additional layer of backticks to
+        # represent a code block) `\`address.city\`` represents a field named `address.
+        # city`, not the map key `city` in the field `address`. `\`*\`` represents a
+        # field named `*`, not any field. A special `Field` contains the default
+        # indexing settings for all fields. This field's resource name is: `projects/`
+        # project_id`/databases/`database_id`/collectionGroups/__default__/fields/*`
         # Indexes defined on this `Field` will be applied to all fields which do not
         # have their own `Field` index configuration.
         # Corresponds to the JSON property `name`
@@ -205,21 +193,19 @@ module Google
         end
       end
       
-      # Metadata for google.longrunning.Operation results from
-      # FirestoreAdmin.UpdateField.
+      # Metadata for google.longrunning.Operation results from FirestoreAdmin.
+      # UpdateField.
       class GoogleFirestoreAdminV1beta2FieldOperationMetadata
         include Google::Apis::Core::Hashable
       
-        # Describes the progress of the operation.
-        # Unit of work is generic and must be interpreted based on where Progress
-        # is used.
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
         # Corresponds to the JSON property `bytesProgress`
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
         attr_accessor :bytes_progress
       
-        # Describes the progress of the operation.
-        # Unit of work is generic and must be interpreted based on where Progress
-        # is used.
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
         # Corresponds to the JSON property `documentProgress`
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
         attr_accessor :document_progress
@@ -230,15 +216,14 @@ module Google
         # @return [String]
         attr_accessor :end_time
       
-        # The field resource that this operation is acting on. For example:
-        # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id`
-        # /fields/`field_path``
+        # The field resource that this operation is acting on. For example: `projects/`
+        # project_id`/databases/`database_id`/collectionGroups/`collection_id`/fields/`
+        # field_path``
         # Corresponds to the JSON property `field`
         # @return [String]
         attr_accessor :field
       
-        # A list of IndexConfigDelta, which describe the intent of this
-        # operation.
+        # A list of IndexConfigDelta, which describe the intent of this operation.
         # Corresponds to the JSON property `indexConfigDeltas`
         # @return [Array<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexConfigDelta>]
         attr_accessor :index_config_deltas
@@ -269,8 +254,8 @@ module Google
         end
       end
       
-      # Metadata for google.longrunning.Operation results from
-      # FirestoreAdmin.ImportDocuments.
+      # Metadata for google.longrunning.Operation results from FirestoreAdmin.
+      # ImportDocuments.
       class GoogleFirestoreAdminV1beta2ImportDocumentsMetadata
         include Google::Apis::Core::Hashable
       
@@ -295,16 +280,14 @@ module Google
         # @return [String]
         attr_accessor :operation_state
       
-        # Describes the progress of the operation.
-        # Unit of work is generic and must be interpreted based on where Progress
-        # is used.
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
         # Corresponds to the JSON property `progressBytes`
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
         attr_accessor :progress_bytes
       
-        # Describes the progress of the operation.
-        # Unit of work is generic and must be interpreted based on where Progress
-        # is used.
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
         # Corresponds to the JSON property `progressDocuments`
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
         attr_accessor :progress_documents
@@ -334,16 +317,14 @@ module Google
       class GoogleFirestoreAdminV1beta2ImportDocumentsRequest
         include Google::Apis::Core::Hashable
       
-        # Which collection ids to import. Unspecified means all collections included
-        # in the import.
+        # Which collection ids to import. Unspecified means all collections included in
+        # the import.
         # Corresponds to the JSON property `collectionIds`
         # @return [Array<String>]
         attr_accessor :collection_ids
       
-        # Location of the exported files.
-        # This must match the output_uri_prefix of an ExportDocumentsResponse from
-        # an export that has completed successfully.
-        # See:
+        # Location of the exported files. This must match the output_uri_prefix of an
+        # ExportDocumentsResponse from an export that has completed successfully. See:
         # google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix.
         # Corresponds to the JSON property `inputUriPrefix`
         # @return [String]
@@ -360,39 +341,37 @@ module Google
         end
       end
       
-      # Cloud Firestore indexes enable simple and complex queries against
-      # documents in a database.
+      # Cloud Firestore indexes enable simple and complex queries against documents in
+      # a database.
       class GoogleFirestoreAdminV1beta2Index
         include Google::Apis::Core::Hashable
       
-        # The fields supported by this index.
-        # For composite indexes, this is always 2 or more fields.
-        # The last field entry is always for the field path `__name__`. If, on
-        # creation, `__name__` was not specified as the last field, it will be added
+        # The fields supported by this index. For composite indexes, this is always 2 or
+        # more fields. The last field entry is always for the field path `__name__`. If,
+        # on creation, `__name__` was not specified as the last field, it will be added
         # automatically with the same direction as that of the last field defined. If
-        # the final field in a composite index is not directional, the `__name__`
-        # will be ordered ASCENDING (unless explicitly specified).
-        # For single field indexes, this will always be exactly one entry with a
-        # field path equal to the field path of the associated field.
+        # the final field in a composite index is not directional, the `__name__` will
+        # be ordered ASCENDING (unless explicitly specified). For single field indexes,
+        # this will always be exactly one entry with a field path equal to the field
+        # path of the associated field.
         # Corresponds to the JSON property `fields`
         # @return [Array<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexField>]
         attr_accessor :fields
       
-        # Output only. A server defined name for this index.
-        # The form of this name for composite indexes will be:
-        # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id`
-        # /indexes/`composite_index_id``
-        # For single field indexes, this field will be empty.
+        # Output only. A server defined name for this index. The form of this name for
+        # composite indexes will be: `projects/`project_id`/databases/`database_id`/
+        # collectionGroups/`collection_id`/indexes/`composite_index_id`` For single
+        # field indexes, this field will be empty.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
       
-        # Indexes with a collection query scope specified allow queries
-        # against a collection that is the child of a specific document, specified at
-        # query time, and that has the same collection id.
-        # Indexes with a collection group query scope specified allow queries against
-        # all collections descended from a specific document, specified at query
-        # time, and that have the same collection id as this index.
+        # Indexes with a collection query scope specified allow queries against a
+        # collection that is the child of a specific document, specified at query time,
+        # and that has the same collection id. Indexes with a collection group query
+        # scope specified allow queries against all collections descended from a
+        # specific document, specified at query time, and that have the same collection
+        # id as this index.
         # Corresponds to the JSON property `queryScope`
         # @return [String]
         attr_accessor :query_scope
@@ -420,10 +399,9 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Output only. Specifies the resource name of the `Field` from which this field'
-        # s
-        # index configuration is set (when `uses_ancestor_config` is true),
-        # or from which it *would* be set if this field had no index configuration
-        # (when `uses_ancestor_config` is false).
+        # s index configuration is set (when `uses_ancestor_config` is true), or from
+        # which it *would* be set if this field had no index configuration (when `
+        # uses_ancestor_config` is false).
         # Corresponds to the JSON property `ancestorField`
         # @return [String]
         attr_accessor :ancestor_field
@@ -433,19 +411,18 @@ module Google
         # @return [Array<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index>]
         attr_accessor :indexes
       
-        # Output only
-        # When true, the `Field`'s index configuration is in the process of being
-        # reverted. Once complete, the index config will transition to the same
-        # state as the field specified by `ancestor_field`, at which point
-        # `uses_ancestor_config` will be `true` and `reverting` will be `false`.
+        # Output only When true, the `Field`'s index configuration is in the process of
+        # being reverted. Once complete, the index config will transition to the same
+        # state as the field specified by `ancestor_field`, at which point `
+        # uses_ancestor_config` will be `true` and `reverting` will be `false`.
         # Corresponds to the JSON property `reverting`
         # @return [Boolean]
         attr_accessor :reverting
         alias_method :reverting?, :reverting
       
         # Output only. When true, the `Field`'s index configuration is set from the
-        # configuration specified by the `ancestor_field`.
-        # When false, the `Field`'s index configuration is defined explicitly.
+        # configuration specified by the `ancestor_field`. When false, the `Field`'s
+        # index configuration is defined explicitly.
         # Corresponds to the JSON property `usesAncestorConfig`
         # @return [Boolean]
         attr_accessor :uses_ancestor_config
@@ -473,8 +450,8 @@ module Google
         # @return [String]
         attr_accessor :change_type
       
-        # Cloud Firestore indexes enable simple and complex queries against
-        # documents in a database.
+        # Cloud Firestore indexes enable simple and complex queries against documents in
+        # a database.
         # Corresponds to the JSON property `index`
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index]
         attr_accessor :index
@@ -490,9 +467,8 @@ module Google
         end
       end
       
-      # A field in an index.
-      # The field_path describes which field is indexed, the value_mode describes
-      # how the field value is indexed.
+      # A field in an index. The field_path describes which field is indexed, the
+      # value_mode describes how the field value is indexed.
       class GoogleFirestoreAdminV1beta2IndexField
         include Google::Apis::Core::Hashable
       
@@ -501,9 +477,8 @@ module Google
         # @return [String]
         attr_accessor :array_config
       
-        # Can be __name__.
-        # For single field indexes, this must match the name of the field or may
-        # be omitted.
+        # Can be __name__. For single field indexes, this must match the name of the
+        # field or may be omitted.
         # Corresponds to the JSON property `fieldPath`
         # @return [String]
         attr_accessor :field_path
@@ -526,8 +501,8 @@ module Google
         end
       end
       
-      # Metadata for google.longrunning.Operation results from
-      # FirestoreAdmin.CreateIndex.
+      # Metadata for google.longrunning.Operation results from FirestoreAdmin.
+      # CreateIndex.
       class GoogleFirestoreAdminV1beta2IndexOperationMetadata
         include Google::Apis::Core::Hashable
       
@@ -537,23 +512,21 @@ module Google
         # @return [String]
         attr_accessor :end_time
       
-        # The index resource that this operation is acting on. For example:
-        # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id`
-        # /indexes/`index_id``
+        # The index resource that this operation is acting on. For example: `projects/`
+        # project_id`/databases/`database_id`/collectionGroups/`collection_id`/indexes/`
+        # index_id``
         # Corresponds to the JSON property `index`
         # @return [String]
         attr_accessor :index
       
-        # Describes the progress of the operation.
-        # Unit of work is generic and must be interpreted based on where Progress
-        # is used.
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
         # Corresponds to the JSON property `progressBytes`
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
         attr_accessor :progress_bytes
       
-        # Describes the progress of the operation.
-        # Unit of work is generic and must be interpreted based on where Progress
-        # is used.
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
         # Corresponds to the JSON property `progressDocuments`
         # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
         attr_accessor :progress_documents
@@ -635,9 +608,8 @@ module Google
         end
       end
       
-      # Describes the progress of the operation.
-      # Unit of work is generic and must be interpreted based on where Progress
-      # is used.
+      # Describes the progress of the operation. Unit of work is generic and must be
+      # interpreted based on where Progress is used.
       class GoogleFirestoreAdminV1beta2Progress
         include Google::Apis::Core::Hashable
       
@@ -667,47 +639,45 @@ module Google
       class GoogleLongrunningOperation
         include Google::Apis::Core::Hashable
       
-        # If the value is `false`, it means the operation is still in progress.
-        # If `true`, the operation is completed, and either `error` or `response` is
-        # available.
+        # If the value is `false`, it means the operation is still in progress. If `true`
+        # , the operation is completed, and either `error` or `response` is available.
         # Corresponds to the JSON property `done`
         # @return [Boolean]
         attr_accessor :done
         alias_method :done?, :done
       
-        # The `Status` type defines a logical error model that is suitable for
-        # different programming environments, including REST APIs and RPC APIs. It is
-        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
-        # three pieces of data: error code, error message, and error details.
-        # You can find out more about this error model and how to work with it in the
-        # [API Design Guide](https://cloud.google.com/apis/design/errors).
+        # The `Status` type defines a logical error model that is suitable for different
+        # programming environments, including REST APIs and RPC APIs. It is used by [
+        # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
+        # data: error code, error message, and error details. You can find out more
+        # about this error model and how to work with it in the [API Design Guide](https:
+        # //cloud.google.com/apis/design/errors).
         # Corresponds to the JSON property `error`
         # @return [Google::Apis::FirestoreV1beta2::Status]
         attr_accessor :error
       
-        # Service-specific metadata associated with the operation.  It typically
-        # contains progress information and common metadata such as create time.
-        # Some services might not provide such metadata.  Any method that returns a
-        # long-running operation should document the metadata type, if any.
+        # Service-specific metadata associated with the operation. It typically contains
+        # progress information and common metadata such as create time. Some services
+        # might not provide such metadata. Any method that returns a long-running
+        # operation should document the metadata type, if any.
         # Corresponds to the JSON property `metadata`
         # @return [Hash<String,Object>]
         attr_accessor :metadata
       
         # The server-assigned name, which is only unique within the same service that
-        # originally returns it. If you use the default HTTP mapping, the
-        # `name` should be a resource name ending with `operations/`unique_id``.
+        # originally returns it. If you use the default HTTP mapping, the `name` should
+        # be a resource name ending with `operations/`unique_id``.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
       
-        # The normal response of the operation in case of success.  If the original
-        # method returns no data on success, such as `Delete`, the response is
-        # `google.protobuf.Empty`.  If the original method is standard
-        # `Get`/`Create`/`Update`, the response should be the resource.  For other
-        # methods, the response should have the type `XxxResponse`, where `Xxx`
-        # is the original method name.  For example, if the original method name
-        # is `TakeSnapshot()`, the inferred response type is
-        # `TakeSnapshotResponse`.
+        # The normal response of the operation in case of success. If the original
+        # method returns no data on success, such as `Delete`, the response is `google.
+        # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
+        # the response should be the resource. For other methods, the response should
+        # have the type `XxxResponse`, where `Xxx` is the original method name. For
+        # example, if the original method name is `TakeSnapshot()`, the inferred
+        # response type is `TakeSnapshotResponse`.
         # Corresponds to the JSON property `response`
         # @return [Hash<String,Object>]
         attr_accessor :response
@@ -726,12 +696,12 @@ module Google
         end
       end
       
-      # The `Status` type defines a logical error model that is suitable for
-      # different programming environments, including REST APIs and RPC APIs. It is
-      # used by [gRPC](https://github.com/grpc). Each `Status` message contains
-      # three pieces of data: error code, error message, and error details.
-      # You can find out more about this error model and how to work with it in the
-      # [API Design Guide](https://cloud.google.com/apis/design/errors).
+      # The `Status` type defines a logical error model that is suitable for different
+      # programming environments, including REST APIs and RPC APIs. It is used by [
+      # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
+      # data: error code, error message, and error details. You can find out more
+      # about this error model and how to work with it in the [API Design Guide](https:
+      # //cloud.google.com/apis/design/errors).
       class Status
         include Google::Apis::Core::Hashable
       
@@ -740,15 +710,15 @@ module Google
         # @return [Fixnum]
         attr_accessor :code
       
-        # A list of messages that carry the error details.  There is a common set of
+        # A list of messages that carry the error details. There is a common set of
         # message types for APIs to use.
         # Corresponds to the JSON property `details`
         # @return [Array<Hash<String,Object>>]
         attr_accessor :details
       
-        # A developer-facing error message, which should be in English. Any
-        # user-facing error message should be localized and sent in the
-        # google.rpc.Status.details field, or localized by the client.
+        # A developer-facing error message, which should be in English. Any user-facing
+        # error message should be localized and sent in the google.rpc.Status.details
+        # field, or localized by the client.
         # Corresponds to the JSON property `message`
         # @return [String]
         attr_accessor :message