Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [DatastoreAdmin] Specify limit for properties in Index message in Datastore Admin API #6509

Merged
merged 2 commits into from
Jul 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@
/**
* Creates the specified index.
* A newly created index's initial state is `CREATING`. On completion of the
* returned [google.longrunning.Operation][google.longrunning.Operation], the state will be `READY`.
* If the index already exists, the call will return an `ALREADY_EXISTS`
* status.
* returned [google.longrunning.Operation][google.longrunning.Operation], the
* state will be `READY`. If the index already exists, the call will return an
* `ALREADY_EXISTS` status.
*
* During index creation, the process could result in an error, in which
* case the index will move to the `ERROR` state. The process can be recovered
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
* An index can only be deleted if it is in a `READY` or `ERROR` state. On
* successful execution of the request, the index will be in a `DELETING`
* [state][google.datastore.admin.v1.Index.State]. And on completion of the
* returned [google.longrunning.Operation][google.longrunning.Operation], the index will be removed.
* returned [google.longrunning.Operation][google.longrunning.Operation], the
* index will be removed.
*
* During index deletion, the process could result in an error, in which
* case the index will move to the `ERROR` state. The process can be recovered
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@
*
* 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][google.datastore.admin.v1.ExportEntitiesResponse.output_url] field. That
* value should be used for subsequent ImportEntities operations.
* [google.datastore.admin.v1.ExportEntitiesResponse.output_url][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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@
* that a subset of the data has already been imported to Cloud Datastore.
*
* @param string $projectId Project ID against which to make the request.
* @param string $inputUrl The full resource URL of the external storage location. Currently, only
* Google Cloud Storage is supported. So input_url should be of the form:
* @param string $inputUrl 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,65 +47,51 @@
/**
* Service Description: Google Cloud Datastore Admin API
*
*
* The Datastore Admin API provides several admin services for Cloud Datastore.
*
* -----------------------------------------------------------------------------
* ## Concepts
*
* Project, namespace, kind, and entity as defined in the Google Cloud Datastore
* API.
* Concepts: Project, namespace, kind, and entity as defined in the Google Cloud
* Datastore API.
*
* Operation: An Operation represents work being performed in the background.
*
* EntityFilter: Allows specifying a subset of entities in a project. This is
* specified as a combination of kinds and namespaces (either or both of which
* may be all).
*
* -----------------------------------------------------------------------------
* ## Services
*
* # Export/Import
* Export/Import Service:
*
* The Export/Import service provides the ability to copy all or a subset of
* - The Export/Import service provides the ability to copy all or a subset of
* entities to/from Google Cloud Storage.
*
* Exported data may be imported into Cloud Datastore for any Google Cloud
* - Exported data may be imported into Cloud Datastore for any Google Cloud
* Platform project. It is not restricted to the export source project. It is
* possible to export from one project and then import into another.
*
* Exported data can also be loaded into Google BigQuery for analysis.
*
* Exports and imports are performed asynchronously. An Operation resource is
* - Exported data can also be loaded into Google BigQuery for analysis.
* - Exports and imports are performed asynchronously. An Operation resource is
* created for each export/import. The state (including any errors encountered)
* of the export/import may be queried via the Operation resource.
*
* # Index
* Index Service:
*
* The index service manages Cloud Datastore composite indexes.
*
* Index creation and deletion are performed asynchronously.
* - The index service manages Cloud Datastore composite indexes.
* - Index creation and deletion are performed asynchronously.
* An Operation resource is created for each such asynchronous operation.
* The state of the operation (including any errors encountered)
* may be queried via the Operation resource.
*
* # Operation
* Operation Service:
*
* The Operations collection provides a record of actions performed for the
* - The Operations collection provides a record of actions performed for the
* specified project (including any operations in progress). Operations are not
* created directly but through calls on other collections or resources.
*
* An operation that is not yet done may be cancelled. The request to cancel is
* asynchronous and the operation may continue to run for some time after the
* - An operation that is not yet done may be cancelled. The request to cancel
* is asynchronous and the operation may continue to run for some time after the
* request to cancel is made.
*
* An operation that is done may be deleted so that it is no longer listed as
* - An operation that is done may be deleted so that it is no longer listed as
* part of the Operation collection.
*
* ListOperations returns all pending operations, but not completed operations.
*
* Operations are created by service DatastoreAdmin,
* but are accessed via service google.longrunning.Operations.
* - ListOperations returns all pending operations, but not completed
* operations.
* - Operations are created by service DatastoreAdmin, but are accessed via
* service google.longrunning.Operations.
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods.
Expand Down Expand Up @@ -272,9 +258,9 @@ public function __call($method, $args)
/**
* Creates the specified index.
* A newly created index's initial state is `CREATING`. On completion of the
* returned [google.longrunning.Operation][google.longrunning.Operation], the state will be `READY`.
* If the index already exists, the call will return an `ALREADY_EXISTS`
* status.
* returned [google.longrunning.Operation][google.longrunning.Operation], the
* state will be `READY`. If the index already exists, the call will return an
* `ALREADY_EXISTS` status.
*
* During index creation, the process could result in an error, in which
* case the index will move to the `ERROR` state. The process can be recovered
Expand Down Expand Up @@ -313,7 +299,8 @@ public function createIndex(CreateIndexRequest $request, array $callOptions = []
* An index can only be deleted if it is in a `READY` or `ERROR` state. On
* successful execution of the request, the index will be in a `DELETING`
* [state][google.datastore.admin.v1.Index.State]. And on completion of the
* returned [google.longrunning.Operation][google.longrunning.Operation], the index will be removed.
* returned [google.longrunning.Operation][google.longrunning.Operation], the
* index will be removed.
*
* During index deletion, the process could result in an error, in which
* case the index will move to the `ERROR` state. The process can be recovered
Expand Down
20 changes: 10 additions & 10 deletions DatastoreAdmin/src/V1/ExportEntitiesRequest.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading