| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="datastore_v1beta1.html">Cloud Datastore API</a> . <a href="datastore_v1beta1.projects.html">projects</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#export">export(projectId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Exports a copy of all or a subset of entities from Google Cloud Datastore</p> |
| <p class="toc_element"> |
| <code><a href="#import_">import_(projectId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Imports entities into Google Cloud Datastore. Existing entities with the</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="export">export(projectId, body=None, x__xgafv=None)</code> |
| <pre>Exports a copy of all or a subset of entities from Google Cloud Datastore |
| to another storage system, such as Google Cloud Storage. Recent updates to |
| entities may not be reflected in the export. The export occurs in the |
| background and its progress can be monitored and managed via the |
| Operation resource that is created. The output of an export may only be |
| used once the associated operation is done. If an export operation is |
| cancelled before completion it may leave partial data behind in Google |
| Cloud Storage. |
| |
| Args: |
| projectId: string, Project ID against which to make the request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The request for |
| # google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. |
| "labels": { # Client-assigned labels. |
| "a_key": "A String", |
| }, |
| "entityFilter": { # Identifies a subset of entities in a project. This is specified as # Description of what data from the project is included in the export. |
| # 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'] |
| "kinds": [ # If empty, then this represents all kinds. |
| "A String", |
| ], |
| "namespaceIds": [ # An empty list represents all namespaces. This is the preferred |
| # usage for projects that don't use namespaces. |
| # |
| # An empty string element represents the default namespace. This should be |
| # used if the project has data in non-default namespaces, but doesn't want to |
| # include them. |
| # Each namespace in this list must be unique. |
| "A String", |
| ], |
| }, |
| "outputUrlPrefix": "A String", # 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](https://cloud.google.com/storage/docs/naming#object-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.v1beta1.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. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "done": True or False, # 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. |
| "response": { # 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`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # 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}`. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # 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). |
| "message": "A String", # 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. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| }, |
| "metadata": { # 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. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="import_">import_(projectId, body=None, x__xgafv=None)</code> |
| <pre>Imports entities into Google Cloud Datastore. Existing entities with the |
| same key are overwritten. The import occurs in the background and its |
| progress can be monitored and managed via the Operation resource that is |
| created. If an ImportEntities operation is cancelled, it is possible |
| that a subset of the data has already been imported to Cloud Datastore. |
| |
| Args: |
| projectId: string, Project ID against which to make the request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The request for |
| # google.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities. |
| "entityFilter": { # Identifies a subset of entities in a project. This is specified as # 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. |
| # 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'] |
| "kinds": [ # If empty, then this represents all kinds. |
| "A String", |
| ], |
| "namespaceIds": [ # An empty list represents all namespaces. This is the preferred |
| # usage for projects that don't use namespaces. |
| # |
| # An empty string element represents the default namespace. This should be |
| # used if the project has data in non-default namespaces, but doesn't want to |
| # include them. |
| # Each namespace in this list must be unique. |
| "A String", |
| ], |
| }, |
| "labels": { # Client-assigned labels. |
| "a_key": "A String", |
| }, |
| "inputUrl": "A String", # 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](https://cloud.google.com/storage/docs/naming#object-considerations). |
| # |
| # For more information, see |
| # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "done": True or False, # 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. |
| "response": { # 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`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # 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}`. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # 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). |
| "message": "A String", # 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. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| }, |
| "metadata": { # 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. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
