go: cloud.google.com/go/firestore/apiv1/admin Index | Examples | Files

package apiv1

import "cloud.google.com/go/firestore/apiv1/admin"

Package apiv1 is an auto-generated package for the Google Cloud Firestore Admin API.

NOTE: This package is in alpha. It is not stable, and is likely to change.

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 godoc.org/cloud.google.com/go.

Index

Examples

Package Files

doc.go firestore_admin_client.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

type FieldIterator Uses

type FieldIterator struct {

    // 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 Uses

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 Uses

func (it *FieldIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type FirestoreAdminCallOptions Uses

type FirestoreAdminCallOptions struct {
    CreateIndex     []gax.CallOption
    ListIndexes     []gax.CallOption
    GetIndex        []gax.CallOption
    DeleteIndex     []gax.CallOption
    ImportDocuments []gax.CallOption
    ExportDocuments []gax.CallOption
    GetField        []gax.CallOption
    ListFields      []gax.CallOption
    UpdateField     []gax.CallOption
}

FirestoreAdminCallOptions contains the retry settings for each method of FirestoreAdminClient.

type FirestoreAdminClient Uses

type FirestoreAdminClient struct {

    // 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 Uses

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.

Code:

ctx := context.Background()
c, err := apiv1.NewFirestoreAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*FirestoreAdminClient) Close Uses

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 Uses

func (c *FirestoreAdminClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*FirestoreAdminClient) CreateIndex Uses

func (c *FirestoreAdminClient) CreateIndex(ctx context.Context, req *adminpb.CreateIndexRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)

CreateIndex creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].

Code:

ctx := context.Background()
c, err := apiv1.NewFirestoreAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &adminpb.CreateIndexRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.CreateIndex(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*FirestoreAdminClient) DeleteIndex Uses

func (c *FirestoreAdminClient) DeleteIndex(ctx context.Context, req *adminpb.DeleteIndexRequest, opts ...gax.CallOption) error

DeleteIndex deletes a composite index.

Code:

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 Uses

func (c *FirestoreAdminClient) ExportDocuments(ctx context.Context, req *adminpb.ExportDocumentsRequest, opts ...gax.CallOption) (*longrunningpb.Operation, 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.

Code:

ctx := context.Background()
c, err := apiv1.NewFirestoreAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &adminpb.ExportDocumentsRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.ExportDocuments(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*FirestoreAdminClient) GetField Uses

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.

Code:

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 Uses

func (c *FirestoreAdminClient) GetIndex(ctx context.Context, req *adminpb.GetIndexRequest, opts ...gax.CallOption) (*adminpb.Index, error)

GetIndex gets a composite index.

Code:

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 Uses

func (c *FirestoreAdminClient) ImportDocuments(ctx context.Context, req *adminpb.ImportDocumentsRequest, opts ...gax.CallOption) (*longrunningpb.Operation, 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.

Code:

ctx := context.Background()
c, err := apiv1.NewFirestoreAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &adminpb.ImportDocumentsRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.ImportDocuments(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*FirestoreAdminClient) ListFields Uses

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][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to indexConfig.usesAncestorConfig:false.

Code:

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 Uses

func (c *FirestoreAdminClient) ListIndexes(ctx context.Context, req *adminpb.ListIndexesRequest, opts ...gax.CallOption) *IndexIterator

ListIndexes lists composite indexes.

Code:

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 Uses

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. Intended for use by Google-written clients.

func (*FirestoreAdminClient) UpdateField Uses

func (c *FirestoreAdminClient) UpdateField(ctx context.Context, req *adminpb.UpdateFieldRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)

UpdateField updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to [FirestoreAdmin.UpdateField][google.firestore.admin.v1.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][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][google.firestore.admin.v1.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/*.

Code:

ctx := context.Background()
c, err := apiv1.NewFirestoreAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &adminpb.UpdateFieldRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.UpdateField(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

type IndexIterator Uses

type IndexIterator struct {

    // 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 Uses

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 Uses

func (it *IndexIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

Package apiv1 imports 18 packages (graph). Updated 2019-09-21. Refresh now. Tools for package owners.