Class: Google::Apis::DatastoreV1::GoogleDatastoreAdminV1ExportEntitiesRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datastore_v1/classes.rb,
generated/google/apis/datastore_v1/representations.rb,
generated/google/apis/datastore_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleDatastoreAdminV1ExportEntitiesRequest

Returns a new instance of GoogleDatastoreAdminV1ExportEntitiesRequest.


500
501
502
# File 'generated/google/apis/datastore_v1/classes.rb', line 500

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#entity_filterGoogle::Apis::DatastoreV1::GoogleDatastoreAdminV1EntityFilter

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] Corresponds to the JSON property entityFilter


476
477
478
# File 'generated/google/apis/datastore_v1/classes.rb', line 476

def entity_filter
  @entity_filter
end

#labelsHash<String,String>

Client-assigned labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)

481
482
483
# File 'generated/google/apis/datastore_v1/classes.rb', line 481

def labels
  @labels
end

#output_url_prefixString

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. Corresponds to the JSON property outputUrlPrefix

Returns:

  • (String)

498
499
500
# File 'generated/google/apis/datastore_v1/classes.rb', line 498

def output_url_prefix
  @output_url_prefix
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


505
506
507
508
509
# File 'generated/google/apis/datastore_v1/classes.rb', line 505

def update!(**args)
  @entity_filter = args[:entity_filter] if args.key?(:entity_filter)
  @labels = args[:labels] if args.key?(:labels)
  @output_url_prefix = args[:output_url_prefix] if args.key?(:output_url_prefix)
end