Class: Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/datastore/admin/v1/datastore_admin.rb

Overview

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

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#entity_filter ⇒ ::Google::Cloud::Datastore::Admin::V1::EntityFilter

Returns Description of what data from the project is included in the export.

Returns:



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'proto_docs/google/datastore/admin/v1/datastore_admin.rb', line 131

class ExportEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Client-assigned labels.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Client-assigned labels.



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'proto_docs/google/datastore/admin/v1/datastore_admin.rb', line 131

class ExportEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#output_url_prefix ⇒ ::String

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



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'proto_docs/google/datastore/admin/v1/datastore_admin.rb', line 131

class ExportEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#project_id ⇒ ::String

Returns Required. Project ID against which to make the request.

Returns:

  • (::String) —

    Required. Project ID against which to make the request.



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'proto_docs/google/datastore/admin/v1/datastore_admin.rb', line 131

class ExportEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end