Package apiv1 is an auto-generated package for the Cloud Firestore API.
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := apiv1 . NewFirestoreAdminClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client.
ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := apiv1 . NewFirestoreAdminClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & adminpb . BulkDeleteDocumentsRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#BulkDeleteDocumentsRequest. } op , err := c . BulkDeleteDocuments ( ctx , req ) if err != nil { // TODO: Handle error. } resp , err := op . Wait ( ctx ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewFirestoreAdminClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
BulkDeleteDocumentsOperation
type
BulkDeleteDocumentsOperation
struct
{
// contains filtered or unexported fields
}
BulkDeleteDocumentsOperation manages a long-running operation from BulkDeleteDocuments.
func (*BulkDeleteDocumentsOperation) Done
func
(
op
*
BulkDeleteDocumentsOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*BulkDeleteDocumentsOperation) Metadata
func
(
op
*
BulkDeleteDocumentsOperation
)
Metadata
()
(
*
adminpb
.
BulkDeleteDocumentsMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*BulkDeleteDocumentsOperation) Name
func
(
op
*
BulkDeleteDocumentsOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*BulkDeleteDocumentsOperation) Poll
func
(
op
*
BulkDeleteDocumentsOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
BulkDeleteDocumentsResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*BulkDeleteDocumentsOperation) Wait
func
(
op
*
BulkDeleteDocumentsOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
BulkDeleteDocumentsResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
CreateDatabaseOperation
type
CreateDatabaseOperation
struct
{
// contains filtered or unexported fields
}
CreateDatabaseOperation manages a long-running operation from CreateDatabase.
func (*CreateDatabaseOperation) Done
func
(
op
*
CreateDatabaseOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateDatabaseOperation) Metadata
func
(
op
*
CreateDatabaseOperation
)
Metadata
()
(
*
adminpb
.
CreateDatabaseMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateDatabaseOperation) Name
func
(
op
*
CreateDatabaseOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateDatabaseOperation) Poll
func
(
op
*
CreateDatabaseOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Database
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateDatabaseOperation) Wait
func
(
op
*
CreateDatabaseOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Database
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
CreateIndexOperation
type
CreateIndexOperation
struct
{
// contains filtered or unexported fields
}
CreateIndexOperation manages a long-running operation from CreateIndex.
func (*CreateIndexOperation) Done
func
(
op
*
CreateIndexOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateIndexOperation) Metadata
func
(
op
*
CreateIndexOperation
)
Metadata
()
(
*
adminpb
.
IndexOperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateIndexOperation) Name
func
(
op
*
CreateIndexOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateIndexOperation) Poll
func
(
op
*
CreateIndexOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Index
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateIndexOperation) Wait
func
(
op
*
CreateIndexOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Index
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteDatabaseOperation
type
DeleteDatabaseOperation
struct
{
// contains filtered or unexported fields
}
DeleteDatabaseOperation manages a long-running operation from DeleteDatabase.
func (*DeleteDatabaseOperation) Done
func
(
op
*
DeleteDatabaseOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteDatabaseOperation) Metadata
func
(
op
*
DeleteDatabaseOperation
)
Metadata
()
(
*
adminpb
.
DeleteDatabaseMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteDatabaseOperation) Name
func
(
op
*
DeleteDatabaseOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteDatabaseOperation) Poll
func
(
op
*
DeleteDatabaseOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Database
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteDatabaseOperation) Wait
func
(
op
*
DeleteDatabaseOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Database
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
ExportDocumentsOperation
type
ExportDocumentsOperation
struct
{
// contains filtered or unexported fields
}
ExportDocumentsOperation manages a long-running operation from ExportDocuments.
func (*ExportDocumentsOperation) Done
func
(
op
*
ExportDocumentsOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ExportDocumentsOperation) Metadata
func
(
op
*
ExportDocumentsOperation
)
Metadata
()
(
*
adminpb
.
ExportDocumentsMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ExportDocumentsOperation) Name
func
(
op
*
ExportDocumentsOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ExportDocumentsOperation) Poll
func
(
op
*
ExportDocumentsOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
ExportDocumentsResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ExportDocumentsOperation) Wait
func
(
op
*
ExportDocumentsOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
ExportDocumentsResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
FieldIterator
type
FieldIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
adminpb
.
Field
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
FieldIterator manages a stream of *adminpb.Field.
func (*FieldIterator) All
func
(
it
*
FieldIterator
)
All
()
iter
.
Seq2
[
*
adminpb
.
Field
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*FieldIterator) Next
func
(
it
*
FieldIterator
)
Next
()
(
*
adminpb
.
Field
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*FieldIterator) PageInfo
func
(
it
*
FieldIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
FirestoreAdminCallOptions
type
FirestoreAdminCallOptions
struct
{
CreateIndex
[]
gax
.
CallOption
ListIndexes
[]
gax
.
CallOption
GetIndex
[]
gax
.
CallOption
DeleteIndex
[]
gax
.
CallOption
GetField
[]
gax
.
CallOption
UpdateField
[]
gax
.
CallOption
ListFields
[]
gax
.
CallOption
ExportDocuments
[]
gax
.
CallOption
ImportDocuments
[]
gax
.
CallOption
BulkDeleteDocuments
[]
gax
.
CallOption
CreateDatabase
[]
gax
.
CallOption
GetDatabase
[]
gax
.
CallOption
ListDatabases
[]
gax
.
CallOption
UpdateDatabase
[]
gax
.
CallOption
DeleteDatabase
[]
gax
.
CallOption
GetBackup
[]
gax
.
CallOption
ListBackups
[]
gax
.
CallOption
DeleteBackup
[]
gax
.
CallOption
RestoreDatabase
[]
gax
.
CallOption
CreateBackupSchedule
[]
gax
.
CallOption
GetBackupSchedule
[]
gax
.
CallOption
ListBackupSchedules
[]
gax
.
CallOption
UpdateBackupSchedule
[]
gax
.
CallOption
DeleteBackupSchedule
[]
gax
.
CallOption
CancelOperation
[]
gax
.
CallOption
DeleteOperation
[]
gax
.
CallOption
GetOperation
[]
gax
.
CallOption
ListOperations
[]
gax
.
CallOption
}
FirestoreAdminCallOptions contains the retry settings for each method of FirestoreAdminClient.
FirestoreAdminClient
type
FirestoreAdminClient
struct
{
// The call options for this service.
CallOptions
*
FirestoreAdminCallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient
*
lroauto
.
OperationsClient
// contains filtered or unexported fields
}
FirestoreAdminClient is a client for interacting with Cloud Firestore API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The Cloud Firestore Admin API.
This API provides several administrative services for Cloud Firestore.
Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.
Operation: An Operation represents work being performed in the background.
The index service manages Cloud Firestore indexes.
Index creation is 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.
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 done may be deleted so that it is no longer listed as part of the Operation collection. Operations are garbage collected after 30 days. By default, ListOperations will only return in progress and failed operations. To list completed operation, issue a ListOperations request with the filter done: true.
Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.
func NewFirestoreAdminClient
func
NewFirestoreAdminClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
FirestoreAdminClient
,
error
)
NewFirestoreAdminClient creates a new firestore admin client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The Cloud Firestore Admin API.
This API provides several administrative services for Cloud Firestore.
Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.
Operation: An Operation represents work being performed in the background.
The index service manages Cloud Firestore indexes.
Index creation is 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.
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 done may be deleted so that it is no longer listed as part of the Operation collection. Operations are garbage collected after 30 days. By default, ListOperations will only return in progress and failed operations. To list completed operation, issue a ListOperations request with the filter done: true.
Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewFirestoreAdminRESTClient
func
NewFirestoreAdminRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
FirestoreAdminClient
,
error
)
NewFirestoreAdminRESTClient creates a new firestore admin rest client.
The Cloud Firestore Admin API.
This API provides several administrative services for Cloud Firestore.
Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.
Operation: An Operation represents work being performed in the background.
The index service manages Cloud Firestore indexes.
Index creation is 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.
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 done may be deleted so that it is no longer listed as part of the Operation collection. Operations are garbage collected after 30 days. By default, ListOperations will only return in progress and failed operations. To list completed operation, issue a ListOperations request with the filter done: true.
Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*FirestoreAdminClient) BulkDeleteDocuments
func
(
c
*
FirestoreAdminClient
)
BulkDeleteDocuments
(
ctx
context
.
Context
,
req
*
adminpb
.
BulkDeleteDocumentsRequest
,
opts
...
gax
.
CallOption
)
(
*
BulkDeleteDocumentsOperation
,
error
)
BulkDeleteDocuments bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created.
For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete (at https://cloud.google.com/firestore/docs/manage-data/bulk-delete )
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
BulkDeleteDocumentsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#BulkDeleteDocumentsRequest.
}
op
,
err
:=
c
.
BulkDeleteDocuments
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) BulkDeleteDocumentsOperation
func
(
c
*
FirestoreAdminClient
)
BulkDeleteDocumentsOperation
(
name
string
)
*
BulkDeleteDocumentsOperation
BulkDeleteDocumentsOperation returns a new BulkDeleteDocumentsOperation from a given name. The name must be that of a previously created BulkDeleteDocumentsOperation, possibly from a different process.
func (*FirestoreAdminClient) CancelOperation
func
(
c
*
FirestoreAdminClient
)
CancelOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
CancelOperationRequest
,
opts
...
gax
.
CallOption
)
error
CancelOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
CancelOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.
}
err
=
c
.
CancelOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*FirestoreAdminClient) Close
func
(
c
*
FirestoreAdminClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*FirestoreAdminClient) Connection (deprecated)
func
(
c
*
FirestoreAdminClient
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*FirestoreAdminClient) CreateBackupSchedule
func
(
c
*
FirestoreAdminClient
)
CreateBackupSchedule
(
ctx
context
.
Context
,
req
*
adminpb
.
CreateBackupScheduleRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
BackupSchedule
,
error
)
CreateBackupSchedule creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
CreateBackupScheduleRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#CreateBackupScheduleRequest.
}
resp
,
err
:=
c
.
CreateBackupSchedule
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) CreateDatabase
func
(
c
*
FirestoreAdminClient
)
CreateDatabase
(
ctx
context
.
Context
,
req
*
adminpb
.
CreateDatabaseRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateDatabaseOperation
,
error
)
CreateDatabase create a database.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
CreateDatabaseRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#CreateDatabaseRequest.
}
op
,
err
:=
c
.
CreateDatabase
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) CreateDatabaseOperation
func
(
c
*
FirestoreAdminClient
)
CreateDatabaseOperation
(
name
string
)
*
CreateDatabaseOperation
CreateDatabaseOperation returns a new CreateDatabaseOperation from a given name. The name must be that of a previously created CreateDatabaseOperation, possibly from a different process.
func (*FirestoreAdminClient) CreateIndex
func
(
c
*
FirestoreAdminClient
)
CreateIndex
(
ctx
context
.
Context
,
req
*
adminpb
.
CreateIndexRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateIndexOperation
,
error
)
CreateIndex creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
CreateIndexRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#CreateIndexRequest.
}
op
,
err
:=
c
.
CreateIndex
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) CreateIndexOperation
func
(
c
*
FirestoreAdminClient
)
CreateIndexOperation
(
name
string
)
*
CreateIndexOperation
CreateIndexOperation returns a new CreateIndexOperation from a given name. The name must be that of a previously created CreateIndexOperation, possibly from a different process.
func (*FirestoreAdminClient) DeleteBackup
func
(
c
*
FirestoreAdminClient
)
DeleteBackup
(
ctx
context
.
Context
,
req
*
adminpb
.
DeleteBackupRequest
,
opts
...
gax
.
CallOption
)
error
DeleteBackup deletes a backup.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
DeleteBackupRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#DeleteBackupRequest.
}
err
=
c
.
DeleteBackup
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*FirestoreAdminClient) DeleteBackupSchedule
func
(
c
*
FirestoreAdminClient
)
DeleteBackupSchedule
(
ctx
context
.
Context
,
req
*
adminpb
.
DeleteBackupScheduleRequest
,
opts
...
gax
.
CallOption
)
error
DeleteBackupSchedule deletes a backup schedule.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
DeleteBackupScheduleRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#DeleteBackupScheduleRequest.
}
err
=
c
.
DeleteBackupSchedule
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*FirestoreAdminClient) DeleteDatabase
func
(
c
*
FirestoreAdminClient
)
DeleteDatabase
(
ctx
context
.
Context
,
req
*
adminpb
.
DeleteDatabaseRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteDatabaseOperation
,
error
)
DeleteDatabase deletes a database.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
DeleteDatabaseRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#DeleteDatabaseRequest.
}
op
,
err
:=
c
.
DeleteDatabase
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) DeleteDatabaseOperation
func
(
c
*
FirestoreAdminClient
)
DeleteDatabaseOperation
(
name
string
)
*
DeleteDatabaseOperation
DeleteDatabaseOperation returns a new DeleteDatabaseOperation from a given name. The name must be that of a previously created DeleteDatabaseOperation, possibly from a different process.
func (*FirestoreAdminClient) DeleteIndex
func
(
c
*
FirestoreAdminClient
)
DeleteIndex
(
ctx
context
.
Context
,
req
*
adminpb
.
DeleteIndexRequest
,
opts
...
gax
.
CallOption
)
error
DeleteIndex deletes a composite index.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
DeleteIndexRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#DeleteIndexRequest.
}
err
=
c
.
DeleteIndex
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*FirestoreAdminClient) DeleteOperation
func
(
c
*
FirestoreAdminClient
)
DeleteOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
DeleteOperationRequest
,
opts
...
gax
.
CallOption
)
error
DeleteOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
DeleteOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.
}
err
=
c
.
DeleteOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*FirestoreAdminClient) ExportDocuments
func
(
c
*
FirestoreAdminClient
)
ExportDocuments
(
ctx
context
.
Context
,
req
*
adminpb
.
ExportDocumentsRequest
,
opts
...
gax
.
CallOption
)
(
*
ExportDocumentsOperation
,
error
)
ExportDocuments exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents 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.
For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import (at https://cloud.google.com/firestore/docs/manage-data/export-import )
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
ExportDocumentsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#ExportDocumentsRequest.
}
op
,
err
:=
c
.
ExportDocuments
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) ExportDocumentsOperation
func
(
c
*
FirestoreAdminClient
)
ExportDocumentsOperation
(
name
string
)
*
ExportDocumentsOperation
ExportDocumentsOperation returns a new ExportDocumentsOperation from a given name. The name must be that of a previously created ExportDocumentsOperation, possibly from a different process.
func (*FirestoreAdminClient) GetBackup
func
(
c
*
FirestoreAdminClient
)
GetBackup
(
ctx
context
.
Context
,
req
*
adminpb
.
GetBackupRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Backup
,
error
)
GetBackup gets information about a backup.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
GetBackupRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#GetBackupRequest.
}
resp
,
err
:=
c
.
GetBackup
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) GetBackupSchedule
func
(
c
*
FirestoreAdminClient
)
GetBackupSchedule
(
ctx
context
.
Context
,
req
*
adminpb
.
GetBackupScheduleRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
BackupSchedule
,
error
)
GetBackupSchedule gets information about a backup schedule.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
GetBackupScheduleRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#GetBackupScheduleRequest.
}
resp
,
err
:=
c
.
GetBackupSchedule
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) GetDatabase
func
(
c
*
FirestoreAdminClient
)
GetDatabase
(
ctx
context
.
Context
,
req
*
adminpb
.
GetDatabaseRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Database
,
error
)
GetDatabase gets information about a database.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
GetDatabaseRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#GetDatabaseRequest.
}
resp
,
err
:=
c
.
GetDatabase
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) GetField
func
(
c
*
FirestoreAdminClient
)
GetField
(
ctx
context
.
Context
,
req
*
adminpb
.
GetFieldRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Field
,
error
)
GetField gets the metadata and configuration for a Field.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
GetFieldRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#GetFieldRequest.
}
resp
,
err
:=
c
.
GetField
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) GetIndex
func
(
c
*
FirestoreAdminClient
)
GetIndex
(
ctx
context
.
Context
,
req
*
adminpb
.
GetIndexRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Index
,
error
)
GetIndex gets a composite index.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
GetIndexRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#GetIndexRequest.
}
resp
,
err
:=
c
.
GetIndex
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) GetOperation
func
(
c
*
FirestoreAdminClient
)
GetOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
GetOperationRequest
,
opts
...
gax
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
GetOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
GetOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp
,
err
:=
c
.
GetOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) ImportDocuments
func
(
c
*
FirestoreAdminClient
)
ImportDocuments
(
ctx
context
.
Context
,
req
*
adminpb
.
ImportDocumentsRequest
,
opts
...
gax
.
CallOption
)
(
*
ImportDocumentsOperation
,
error
)
ImportDocuments imports documents into Google Cloud Firestore. Existing documents with the same name 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 ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
ImportDocumentsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#ImportDocumentsRequest.
}
op
,
err
:=
c
.
ImportDocuments
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*FirestoreAdminClient) ImportDocumentsOperation
func
(
c
*
FirestoreAdminClient
)
ImportDocumentsOperation
(
name
string
)
*
ImportDocumentsOperation
ImportDocumentsOperation returns a new ImportDocumentsOperation from a given name. The name must be that of a previously created ImportDocumentsOperation, possibly from a different process.
func (*FirestoreAdminClient) ListBackupSchedules
func
(
c
*
FirestoreAdminClient
)
ListBackupSchedules
(
ctx
context
.
Context
,
req
*
adminpb
.
ListBackupSchedulesRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
ListBackupSchedulesResponse
,
error
)
ListBackupSchedules list backup schedules.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
ListBackupSchedulesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#ListBackupSchedulesRequest.
}
resp
,
err
:=
c
.
ListBackupSchedules
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) ListBackups
func
(
c
*
FirestoreAdminClient
)
ListBackups
(
ctx
context
.
Context
,
req
*
adminpb
.
ListBackupsRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
ListBackupsResponse
,
error
)
ListBackups lists all the backups.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
ListBackupsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#ListBackupsRequest.
}
resp
,
err
:=
c
.
ListBackups
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) ListDatabases
func
(
c
*
FirestoreAdminClient
)
ListDatabases
(
ctx
context
.
Context
,
req
*
adminpb
.
ListDatabasesRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
ListDatabasesResponse
,
error
)
ListDatabases list all the databases in the project.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
ListDatabasesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#ListDatabasesRequest.
}
resp
,
err
:=
c
.
ListDatabases
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) ListFields
func
(
c
*
FirestoreAdminClient
)
ListFields
(
ctx
context
.
Context
,
req
*
adminpb
.
ListFieldsRequest
,
opts
...
gax
.
CallOption
)
*
FieldIterator
ListFields lists the field configuration and metadata for this database.
Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false or ttlConfig:*.
Examples
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
ListFieldsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#ListFieldsRequest.
}
it
:=
c
.
ListFields
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
adminpb
.
ListFieldsResponse
)
}
}
all
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
ListFieldsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#ListFieldsRequest.
}
for
resp
,
err
:=
range
c
.
ListFields
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*FirestoreAdminClient) ListIndexes
func
(
c
*
FirestoreAdminClient
)
ListIndexes
(
ctx
context
.
Context
,
req
*
adminpb
.
ListIndexesRequest
,
opts
...
gax
.
CallOption
)
*
IndexIterator
ListIndexes lists composite indexes.
Examples
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
ListIndexesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#ListIndexesRequest.
}
it
:=
c
.
ListIndexes
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
adminpb
.
ListIndexesResponse
)
}
}
all
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
ListIndexesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#ListIndexesRequest.
}
for
resp
,
err
:=
range
c
.
ListIndexes
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*FirestoreAdminClient) ListOperations
func
(
c
*
FirestoreAdminClient
)
ListOperations
(
ctx
context
.
Context
,
req
*
longrunningpb
.
ListOperationsRequest
,
opts
...
gax
.
CallOption
)
*
OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Examples
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it
:=
c
.
ListOperations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
longrunningpb
.
ListOperationsResponse
)
}
}
all
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for
resp
,
err
:=
range
c
.
ListOperations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*FirestoreAdminClient) RestoreDatabase
func
(
c
*
FirestoreAdminClient
)
RestoreDatabase
(
ctx
context
.
Context
,
req
*
adminpb
.
RestoreDatabaseRequest
,
opts
...
gax
.
CallOption
)
(
*
RestoreDatabaseOperation
,
error
)
RestoreDatabase creates a new database by restoring from an existing backup.
The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup.
The [long-running operation][google.longrunning.Operation] can be used to track the progress of the restore, with the Operation’s metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
RestoreDatabaseRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#RestoreDatabaseRequest.
}
op
,
err
:=
c
.
RestoreDatabase
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) RestoreDatabaseOperation
func
(
c
*
FirestoreAdminClient
)
RestoreDatabaseOperation
(
name
string
)
*
RestoreDatabaseOperation
RestoreDatabaseOperation returns a new RestoreDatabaseOperation from a given name. The name must be that of a previously created RestoreDatabaseOperation, possibly from a different process.
func (*FirestoreAdminClient) SetGoogleClientInfo
func
(
c
*
FirestoreAdminClient
)
SetGoogleClientInfo
(
keyval
string
)
SetGoogleClientInfo sets the name and version of the application in
the x-goog-api-client
header passed on each request. Also passes any
provided key-value pairs. Intended for use by Google-written clients.
Internal use only.
func (*FirestoreAdminClient) UpdateBackupSchedule
func
(
c
*
FirestoreAdminClient
)
UpdateBackupSchedule
(
ctx
context
.
Context
,
req
*
adminpb
.
UpdateBackupScheduleRequest
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
BackupSchedule
,
error
)
UpdateBackupSchedule updates a backup schedule.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
UpdateBackupScheduleRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#UpdateBackupScheduleRequest.
}
resp
,
err
:=
c
.
UpdateBackupSchedule
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) UpdateDatabase
func
(
c
*
FirestoreAdminClient
)
UpdateDatabase
(
ctx
context
.
Context
,
req
*
adminpb
.
UpdateDatabaseRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateDatabaseOperation
,
error
)
UpdateDatabase updates a database.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
UpdateDatabaseRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#UpdateDatabaseRequest.
}
op
,
err
:=
c
.
UpdateDatabase
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) UpdateDatabaseOperation
func
(
c
*
FirestoreAdminClient
)
UpdateDatabaseOperation
(
name
string
)
*
UpdateDatabaseOperation
UpdateDatabaseOperation returns a new UpdateDatabaseOperation from a given name. The name must be that of a previously created UpdateDatabaseOperation, possibly from a different process.
func (*FirestoreAdminClient) UpdateField
func
(
c
*
FirestoreAdminClient
)
UpdateField
(
ctx
context
.
Context
,
req
*
adminpb
.
UpdateFieldRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateFieldOperation
,
error
)
UpdateField updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn’t aware of. The field mask should be specified as: { paths: "index_config" }.
This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata.
To configure the default field settings for the database, use the special Field with resource name: projects/{project_id}/databases/{database_id}/collectionGroups/ default/fields/*.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"cloud.google.com/go/firestore/apiv1/admin/adminpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& adminpb
.
UpdateFieldRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/firestore/apiv1/admin/adminpb#UpdateFieldRequest.
}
op
,
err
:=
c
.
UpdateField
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*FirestoreAdminClient) UpdateFieldOperation
func
(
c
*
FirestoreAdminClient
)
UpdateFieldOperation
(
name
string
)
*
UpdateFieldOperation
UpdateFieldOperation returns a new UpdateFieldOperation from a given name. The name must be that of a previously created UpdateFieldOperation, possibly from a different process.
ImportDocumentsOperation
type
ImportDocumentsOperation
struct
{
// contains filtered or unexported fields
}
ImportDocumentsOperation manages a long-running operation from ImportDocuments.
func (*ImportDocumentsOperation) Done
func
(
op
*
ImportDocumentsOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ImportDocumentsOperation) Metadata
func
(
op
*
ImportDocumentsOperation
)
Metadata
()
(
*
adminpb
.
ImportDocumentsMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ImportDocumentsOperation) Name
func
(
op
*
ImportDocumentsOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ImportDocumentsOperation) Poll
func
(
op
*
ImportDocumentsOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ImportDocumentsOperation) Wait
func
(
op
*
ImportDocumentsOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
IndexIterator
type
IndexIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
adminpb
.
Index
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
IndexIterator manages a stream of *adminpb.Index.
func (*IndexIterator) All
func
(
it
*
IndexIterator
)
All
()
iter
.
Seq2
[
*
adminpb
.
Index
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*IndexIterator) Next
func
(
it
*
IndexIterator
)
Next
()
(
*
adminpb
.
Index
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*IndexIterator) PageInfo
func
(
it
*
IndexIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
OperationIterator
type
OperationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
longrunningpb
.
Operation
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All
func
(
it
*
OperationIterator
)
All
()
iter
.
Seq2
[
*
longrunningpb
.
Operation
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*OperationIterator) Next
func
(
it
*
OperationIterator
)
Next
()
(
*
longrunningpb
.
Operation
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo
func
(
it
*
OperationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
RestoreDatabaseOperation
type
RestoreDatabaseOperation
struct
{
// contains filtered or unexported fields
}
RestoreDatabaseOperation manages a long-running operation from RestoreDatabase.
func (*RestoreDatabaseOperation) Done
func
(
op
*
RestoreDatabaseOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*RestoreDatabaseOperation) Metadata
func
(
op
*
RestoreDatabaseOperation
)
Metadata
()
(
*
adminpb
.
RestoreDatabaseMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*RestoreDatabaseOperation) Name
func
(
op
*
RestoreDatabaseOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*RestoreDatabaseOperation) Poll
func
(
op
*
RestoreDatabaseOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Database
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*RestoreDatabaseOperation) Wait
func
(
op
*
RestoreDatabaseOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Database
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateDatabaseOperation
type
UpdateDatabaseOperation
struct
{
// contains filtered or unexported fields
}
UpdateDatabaseOperation manages a long-running operation from UpdateDatabase.
func (*UpdateDatabaseOperation) Done
func
(
op
*
UpdateDatabaseOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateDatabaseOperation) Metadata
func
(
op
*
UpdateDatabaseOperation
)
Metadata
()
(
*
adminpb
.
UpdateDatabaseMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateDatabaseOperation) Name
func
(
op
*
UpdateDatabaseOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateDatabaseOperation) Poll
func
(
op
*
UpdateDatabaseOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Database
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateDatabaseOperation) Wait
func
(
op
*
UpdateDatabaseOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Database
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateFieldOperation
type
UpdateFieldOperation
struct
{
// contains filtered or unexported fields
}
UpdateFieldOperation manages a long-running operation from UpdateField.
func (*UpdateFieldOperation) Done
func
(
op
*
UpdateFieldOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateFieldOperation) Metadata
func
(
op
*
UpdateFieldOperation
)
Metadata
()
(
*
adminpb
.
FieldOperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateFieldOperation) Name
func
(
op
*
UpdateFieldOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateFieldOperation) Poll
func
(
op
*
UpdateFieldOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Field
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateFieldOperation) Wait
func
(
op
*
UpdateFieldOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
adminpb
.
Field
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
