Package apiv1 is an auto-generated package for the Google Cloud Firestore Admin API.
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
Use of Context
The ctx passed to NewClient 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.
For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
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.
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) 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
}
FirestoreAdminCallOptions contains the retry settings for each method of FirestoreAdminClient.
FirestoreAdminClient
type
FirestoreAdminClient
struct
{
// LROClient is used internally to handle longrunning operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient
*
lroauto
.
OperationsClient
// The call options for this service.
CallOptions
*
FirestoreAdminCallOptions
// contains filtered or unexported fields
}
FirestoreAdminClient is a client for interacting with Google Cloud Firestore Admin API.
Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
func NewFirestoreAdminClient
func
NewFirestoreAdminClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
FirestoreAdminClient
,
error
)
NewFirestoreAdminClient creates a new firestore admin client.
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
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use client.
_
=
c
}
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
func
(
c
*
FirestoreAdminClient
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated.
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
"google.golang.org/genproto/googleapis/firestore/admin/v1"
)
func
main
()
{
// import adminpb "google.golang.org/genproto/googleapis/firestore/admin/v1"
ctx
:=
context
.
Background
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
req
:=
& adminpb
.
CreateIndexRequest
{
// TODO: Fill request struct fields.
}
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) 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
"google.golang.org/genproto/googleapis/firestore/admin/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
req
:=
& adminpb
.
DeleteIndexRequest
{
// TODO: Fill request struct fields.
}
err
=
c
.
DeleteIndex
(
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.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
adminpb
"google.golang.org/genproto/googleapis/firestore/admin/v1"
)
func
main
()
{
// import adminpb "google.golang.org/genproto/googleapis/firestore/admin/v1"
ctx
:=
context
.
Background
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
req
:=
& adminpb
.
ExportDocumentsRequest
{
// TODO: Fill request struct fields.
}
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) 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
"google.golang.org/genproto/googleapis/firestore/admin/v1"
)
func
main
()
{
// import adminpb "google.golang.org/genproto/googleapis/firestore/admin/v1"
ctx
:=
context
.
Background
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
req
:=
& adminpb
.
GetFieldRequest
{
// TODO: Fill request struct fields.
}
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
"google.golang.org/genproto/googleapis/firestore/admin/v1"
)
func
main
()
{
// import adminpb "google.golang.org/genproto/googleapis/firestore/admin/v1"
ctx
:=
context
.
Background
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
req
:=
& adminpb
.
GetIndexRequest
{
// TODO: Fill request struct fields.
}
resp
,
err
:=
c
.
GetIndex
(
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
"google.golang.org/genproto/googleapis/firestore/admin/v1"
)
func
main
()
{
// import adminpb "google.golang.org/genproto/googleapis/firestore/admin/v1"
ctx
:=
context
.
Background
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
req
:=
& adminpb
.
ImportDocumentsRequest
{
// TODO: Fill request struct fields.
}
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) 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.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
"google.golang.org/api/iterator"
adminpb
"google.golang.org/genproto/googleapis/firestore/admin/v1"
)
func
main
()
{
// import adminpb "google.golang.org/genproto/googleapis/firestore/admin/v1"
// import "google.golang.org/api/iterator"
ctx
:=
context
.
Background
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
req
:=
& adminpb
.
ListFieldsRequest
{
// TODO: Fill request struct fields.
}
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
}
}
func (*FirestoreAdminClient) ListIndexes
func
(
c
*
FirestoreAdminClient
)
ListIndexes
(
ctx
context
.
Context
,
req
*
adminpb
.
ListIndexesRequest
,
opts
...
gax
.
CallOption
)
*
IndexIterator
ListIndexes lists composite indexes.
Example
package
main
import
(
"context"
apiv1
"cloud.google.com/go/firestore/apiv1/admin"
"google.golang.org/api/iterator"
adminpb
"google.golang.org/genproto/googleapis/firestore/admin/v1"
)
func
main
()
{
// import adminpb "google.golang.org/genproto/googleapis/firestore/admin/v1"
// import "google.golang.org/api/iterator"
ctx
:=
context
.
Background
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
req
:=
& adminpb
.
ListIndexesRequest
{
// TODO: Fill request struct fields.
}
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
}
}
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) 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
"google.golang.org/genproto/googleapis/firestore/admin/v1"
)
func
main
()
{
// import adminpb "google.golang.org/genproto/googleapis/firestore/admin/v1"
ctx
:=
context
.
Background
()
c
,
err
:=
apiv1
.
NewFirestoreAdminClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
req
:=
& adminpb
.
UpdateFieldRequest
{
// TODO: Fill request struct fields.
}
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) 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.
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.
