Firestore in Datastore mode Admin V1 API - Class Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest (v0.5.0)

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

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

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) — Description of what data from the project is included in the export.

#entity_filter=

def entity_filter=(value) -> ::Google::Cloud::Datastore::Admin::V1::EntityFilter

Parameter

value (::Google::Cloud::Datastore::Admin::V1::EntityFilter) — Description of what data from the project is included in the export.

Returns

(::Google::Cloud::Datastore::Admin::V1::EntityFilter) — Description of what data from the project is included in the export.

#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.

#output_url_prefix

def output_url_prefix() -> ::String

Returns

(::String) — Required. Location for the export metadata and data files.

The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Cloud Storage bucket and NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see Object name considerations.

The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations.

By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.

#output_url_prefix=

def output_url_prefix=(value) -> ::String

Parameter

value (::String) — Required. Location for the export metadata and data files.

The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Cloud Storage bucket and NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see Object name considerations.

The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations.

By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.

Returns

(::String) — Required. Location for the export metadata and data files.

The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Cloud Storage bucket and NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see Object name considerations.

The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations.

By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.

#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.