Firestore in Datastore mode Admin V1 API - Class Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest (v1.0.1)

Reference documentation and code samples for the Firestore in Datastore mode Admin V1 API class Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest.

The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#entity_filter

def entity_filter() -> ::Google::Cloud::Datastore::Admin::V1::EntityFilter
Returns
  • (::Google::Cloud::Datastore::Admin::V1::EntityFilter) — Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

#entity_filter=

def entity_filter=(value) -> ::Google::Cloud::Datastore::Admin::V1::EntityFilter
Parameter
  • value (::Google::Cloud::Datastore::Admin::V1::EntityFilter) — Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.
Returns
  • (::Google::Cloud::Datastore::Admin::V1::EntityFilter) — Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

#input_url

def input_url() -> ::String
Returns
  • (::String) — Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

    For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.

#input_url=

def input_url=(value) -> ::String
Parameter
  • value (::String) — Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

    For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.

Returns
  • (::String) — Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

    For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Client-assigned labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Client-assigned labels.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Client-assigned labels.

#project_id

def project_id() -> ::String
Returns
  • (::String) — Required. Project ID against which to make the request.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — Required. Project ID against which to make the request.
Returns
  • (::String) — Required. Project ID against which to make the request.