control

package
v1.56.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 19, 2025 License: Apache-2.0 Imports: 33 Imported by: 4

Documentation ΒΆ

Overview ΒΆ

Package control is an auto-generated package for the Storage Control API.

The Storage Control API lets you perform metadata-specific, control plane, and long-running operations. The Storage Control API creates one space to perform metadata-specific, control plane, and long-running operations apart from the Storage API. Separating these operations from the Storage API improves API standardization and lets you run faster releases.

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:

Example usage ΒΆ

To get started with this package, create a client.

// go get cloud.google.com/go/storage/control/apiv2@latest
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 := control.NewStorageControlClient(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, mentioned above.

req := &controlpb.CreateAnywhereCacheRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#CreateAnywhereCacheRequest.
}
op, err := c.CreateAnywhereCache(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 NewStorageControlClient 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.

Index ΒΆ

Examples ΒΆ

Constants ΒΆ

This section is empty.

Variables ΒΆ

This section is empty.

Functions ΒΆ

func DefaultAuthScopes ΒΆ

func DefaultAuthScopes() []string

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

Types ΒΆ

type AnywhereCacheIterator ΒΆ added in v1.53.0

type AnywhereCacheIterator 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 []*controlpb.AnywhereCache, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AnywhereCacheIterator manages a stream of *controlpb.AnywhereCache.

func (*AnywhereCacheIterator) All ΒΆ added in v1.53.0

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*AnywhereCacheIterator) Next ΒΆ added in v1.53.0

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 (*AnywhereCacheIterator) PageInfo ΒΆ added in v1.53.0

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

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

type CreateAnywhereCacheOperation ΒΆ added in v1.53.0

type CreateAnywhereCacheOperation struct {
	// contains filtered or unexported fields
}

CreateAnywhereCacheOperation manages a long-running operation from CreateAnywhereCache.

func (*CreateAnywhereCacheOperation) Done ΒΆ added in v1.53.0

Done reports whether the long-running operation has completed.

func (*CreateAnywhereCacheOperation) Metadata ΒΆ added in v1.53.0

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 (*CreateAnywhereCacheOperation) Name ΒΆ added in v1.53.0

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 (*CreateAnywhereCacheOperation) Poll ΒΆ added in v1.53.0

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 (*CreateAnywhereCacheOperation) Wait ΒΆ added in v1.53.0

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type FolderIterator ΒΆ

type FolderIterator 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 []*controlpb.Folder, nextPageToken string, err error)
	// contains filtered or unexported fields
}

FolderIterator manages a stream of *controlpb.Folder.

func (*FolderIterator) All ΒΆ added in v1.44.0

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*FolderIterator) Next ΒΆ

func (it *FolderIterator) Next() (*controlpb.Folder, 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 (*FolderIterator) PageInfo ΒΆ

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

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

type ManagedFolderIterator ΒΆ added in v1.41.0

type ManagedFolderIterator 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 []*controlpb.ManagedFolder, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ManagedFolderIterator manages a stream of *controlpb.ManagedFolder.

func (*ManagedFolderIterator) All ΒΆ added in v1.44.0

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*ManagedFolderIterator) Next ΒΆ added in v1.41.0

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 (*ManagedFolderIterator) PageInfo ΒΆ added in v1.41.0

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

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

type RenameFolderOperation ΒΆ

type RenameFolderOperation struct {
	// contains filtered or unexported fields
}

RenameFolderOperation manages a long-running operation from RenameFolder.

func (*RenameFolderOperation) Done ΒΆ

func (op *RenameFolderOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RenameFolderOperation) Metadata ΒΆ

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 (*RenameFolderOperation) Name ΒΆ

func (op *RenameFolderOperation) 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 (*RenameFolderOperation) Poll ΒΆ

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 (*RenameFolderOperation) Wait ΒΆ

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type StorageControlCallOptions ΒΆ

type StorageControlCallOptions struct {
	CreateFolder                         []gax.CallOption
	DeleteFolder                         []gax.CallOption
	GetFolder                            []gax.CallOption
	ListFolders                          []gax.CallOption
	RenameFolder                         []gax.CallOption
	GetStorageLayout                     []gax.CallOption
	CreateManagedFolder                  []gax.CallOption
	DeleteManagedFolder                  []gax.CallOption
	GetManagedFolder                     []gax.CallOption
	ListManagedFolders                   []gax.CallOption
	CreateAnywhereCache                  []gax.CallOption
	UpdateAnywhereCache                  []gax.CallOption
	DisableAnywhereCache                 []gax.CallOption
	PauseAnywhereCache                   []gax.CallOption
	ResumeAnywhereCache                  []gax.CallOption
	GetAnywhereCache                     []gax.CallOption
	ListAnywhereCaches                   []gax.CallOption
	GetProjectIntelligenceConfig         []gax.CallOption
	UpdateProjectIntelligenceConfig      []gax.CallOption
	GetFolderIntelligenceConfig          []gax.CallOption
	UpdateFolderIntelligenceConfig       []gax.CallOption
	GetOrganizationIntelligenceConfig    []gax.CallOption
	UpdateOrganizationIntelligenceConfig []gax.CallOption
}

StorageControlCallOptions contains the retry settings for each method of StorageControlClient.

type StorageControlClient ΒΆ

type StorageControlClient struct {

	// The call options for this service.
	CallOptions *StorageControlCallOptions

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

StorageControlClient is a client for interacting with Storage Control API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

StorageControl service includes selected control plane operations.

func NewStorageControlClient ΒΆ

func NewStorageControlClient(ctx context.Context, opts ...option.ClientOption) (*StorageControlClient, error)

NewStorageControlClient creates a new storage control client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

StorageControl service includes selected control plane operations.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewStorageControlRESTClient ΒΆ added in v1.56.0

func NewStorageControlRESTClient(ctx context.Context, opts ...option.ClientOption) (*StorageControlClient, error)

NewStorageControlRESTClient creates a new storage control rest client.

StorageControl service includes selected control plane operations.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
)

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 := control.NewStorageControlRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*StorageControlClient) Close ΒΆ

func (c *StorageControlClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*StorageControlClient) Connection deprecated

func (c *StorageControlClient) 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 (*StorageControlClient) CreateAnywhereCache ΒΆ added in v1.53.0

CreateAnywhereCache creates an Anywhere Cache instance.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.CreateAnywhereCacheRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#CreateAnywhereCacheRequest.
	}
	op, err := c.CreateAnywhereCache(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) CreateAnywhereCacheOperation ΒΆ added in v1.53.0

func (c *StorageControlClient) CreateAnywhereCacheOperation(name string) *CreateAnywhereCacheOperation

CreateAnywhereCacheOperation returns a new CreateAnywhereCacheOperation from a given name. The name must be that of a previously created CreateAnywhereCacheOperation, possibly from a different process.

func (*StorageControlClient) CreateFolder ΒΆ

CreateFolder creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.CreateFolderRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#CreateFolderRequest.
	}
	resp, err := c.CreateFolder(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) CreateManagedFolder ΒΆ added in v1.41.0

CreateManagedFolder creates a new managed folder.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.CreateManagedFolderRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#CreateManagedFolderRequest.
	}
	resp, err := c.CreateManagedFolder(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) DeleteFolder ΒΆ

DeleteFolder permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.DeleteFolderRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#DeleteFolderRequest.
	}
	err = c.DeleteFolder(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*StorageControlClient) DeleteManagedFolder ΒΆ added in v1.41.0

func (c *StorageControlClient) DeleteManagedFolder(ctx context.Context, req *controlpb.DeleteManagedFolderRequest, opts ...gax.CallOption) error

DeleteManagedFolder permanently deletes an empty managed folder.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.DeleteManagedFolderRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#DeleteManagedFolderRequest.
	}
	err = c.DeleteManagedFolder(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*StorageControlClient) DisableAnywhereCache ΒΆ added in v1.53.0

DisableAnywhereCache disables an Anywhere Cache instance. A disabled instance is read-only. The disablement could be revoked by calling ResumeAnywhereCache. The cache instance will be deleted automatically if it remains in the disabled state for at least one hour.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.DisableAnywhereCacheRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#DisableAnywhereCacheRequest.
	}
	resp, err := c.DisableAnywhereCache(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) GetAnywhereCache ΒΆ added in v1.53.0

GetAnywhereCache gets an Anywhere Cache instance.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.GetAnywhereCacheRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#GetAnywhereCacheRequest.
	}
	resp, err := c.GetAnywhereCache(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) GetFolder ΒΆ

GetFolder returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.GetFolderRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#GetFolderRequest.
	}
	resp, err := c.GetFolder(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) GetFolderIntelligenceConfig ΒΆ added in v1.55.0

GetFolderIntelligenceConfig returns the Folder scoped singleton IntelligenceConfig resource.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.GetFolderIntelligenceConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#GetFolderIntelligenceConfigRequest.
	}
	resp, err := c.GetFolderIntelligenceConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) GetManagedFolder ΒΆ added in v1.41.0

GetManagedFolder returns metadata for the specified managed folder.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.GetManagedFolderRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#GetManagedFolderRequest.
	}
	resp, err := c.GetManagedFolder(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) GetOrganizationIntelligenceConfig ΒΆ added in v1.55.0

GetOrganizationIntelligenceConfig returns the Organization scoped singleton IntelligenceConfig resource.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.GetOrganizationIntelligenceConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#GetOrganizationIntelligenceConfigRequest.
	}
	resp, err := c.GetOrganizationIntelligenceConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) GetProjectIntelligenceConfig ΒΆ added in v1.55.0

GetProjectIntelligenceConfig returns the Project scoped singleton IntelligenceConfig resource.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.GetProjectIntelligenceConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#GetProjectIntelligenceConfigRequest.
	}
	resp, err := c.GetProjectIntelligenceConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) GetStorageLayout ΒΆ

GetStorageLayout returns the storage layout configuration for a given bucket.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.GetStorageLayoutRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#GetStorageLayoutRequest.
	}
	resp, err := c.GetStorageLayout(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) ListAnywhereCaches ΒΆ added in v1.53.0

ListAnywhereCaches lists Anywhere Cache instances for a given bucket.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
	"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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.ListAnywhereCachesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#ListAnywhereCachesRequest.
	}
	it := c.ListAnywhereCaches(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.(*controlpb.ListAnywhereCachesResponse)
	}
}
Example (All) ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.ListAnywhereCachesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#ListAnywhereCachesRequest.
	}
	for resp, err := range c.ListAnywhereCaches(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*StorageControlClient) ListFolders ΒΆ

ListFolders retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
	"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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.ListFoldersRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#ListFoldersRequest.
	}
	it := c.ListFolders(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.(*controlpb.ListFoldersResponse)
	}
}
Example (All) ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.ListFoldersRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#ListFoldersRequest.
	}
	for resp, err := range c.ListFolders(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*StorageControlClient) ListManagedFolders ΒΆ added in v1.41.0

ListManagedFolders retrieves a list of managed folders for a given bucket.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
	"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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.ListManagedFoldersRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#ListManagedFoldersRequest.
	}
	it := c.ListManagedFolders(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.(*controlpb.ListManagedFoldersResponse)
	}
}
Example (All) ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.ListManagedFoldersRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#ListManagedFoldersRequest.
	}
	for resp, err := range c.ListManagedFolders(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*StorageControlClient) PauseAnywhereCache ΒΆ added in v1.53.0

PauseAnywhereCache pauses an Anywhere Cache instance.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.PauseAnywhereCacheRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#PauseAnywhereCacheRequest.
	}
	resp, err := c.PauseAnywhereCache(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) RenameFolder ΒΆ

RenameFolder renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.RenameFolderRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#RenameFolderRequest.
	}
	op, err := c.RenameFolder(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) RenameFolderOperation ΒΆ

func (c *StorageControlClient) RenameFolderOperation(name string) *RenameFolderOperation

RenameFolderOperation returns a new RenameFolderOperation from a given name. The name must be that of a previously created RenameFolderOperation, possibly from a different process.

func (*StorageControlClient) ResumeAnywhereCache ΒΆ added in v1.53.0

ResumeAnywhereCache resumes a disabled or paused Anywhere Cache instance.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.ResumeAnywhereCacheRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#ResumeAnywhereCacheRequest.
	}
	resp, err := c.ResumeAnywhereCache(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) UpdateAnywhereCache ΒΆ added in v1.53.0

UpdateAnywhereCache updates an Anywhere Cache instance. Mutable fields include ttl and admission_policy.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.UpdateAnywhereCacheRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#UpdateAnywhereCacheRequest.
	}
	op, err := c.UpdateAnywhereCache(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) UpdateAnywhereCacheOperation ΒΆ added in v1.53.0

func (c *StorageControlClient) UpdateAnywhereCacheOperation(name string) *UpdateAnywhereCacheOperation

UpdateAnywhereCacheOperation returns a new UpdateAnywhereCacheOperation from a given name. The name must be that of a previously created UpdateAnywhereCacheOperation, possibly from a different process.

func (*StorageControlClient) UpdateFolderIntelligenceConfig ΒΆ added in v1.55.0

UpdateFolderIntelligenceConfig updates the Folder scoped singleton IntelligenceConfig resource.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.UpdateFolderIntelligenceConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#UpdateFolderIntelligenceConfigRequest.
	}
	resp, err := c.UpdateFolderIntelligenceConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) UpdateOrganizationIntelligenceConfig ΒΆ added in v1.55.0

UpdateOrganizationIntelligenceConfig updates the Organization scoped singleton IntelligenceConfig resource.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.UpdateOrganizationIntelligenceConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#UpdateOrganizationIntelligenceConfigRequest.
	}
	resp, err := c.UpdateOrganizationIntelligenceConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*StorageControlClient) UpdateProjectIntelligenceConfig ΒΆ added in v1.55.0

UpdateProjectIntelligenceConfig updates the Project scoped singleton IntelligenceConfig resource.

Example ΒΆ
package main

import (
	"context"

	control "cloud.google.com/go/storage/control/apiv2"
	controlpb "cloud.google.com/go/storage/control/apiv2/controlpb"
)

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 := control.NewStorageControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &controlpb.UpdateProjectIntelligenceConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/storage/control/apiv2/controlpb#UpdateProjectIntelligenceConfigRequest.
	}
	resp, err := c.UpdateProjectIntelligenceConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

type UpdateAnywhereCacheOperation ΒΆ added in v1.53.0

type UpdateAnywhereCacheOperation struct {
	// contains filtered or unexported fields
}

UpdateAnywhereCacheOperation manages a long-running operation from UpdateAnywhereCache.

func (*UpdateAnywhereCacheOperation) Done ΒΆ added in v1.53.0

Done reports whether the long-running operation has completed.

func (*UpdateAnywhereCacheOperation) Metadata ΒΆ added in v1.53.0

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 (*UpdateAnywhereCacheOperation) Name ΒΆ added in v1.53.0

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 (*UpdateAnywhereCacheOperation) Poll ΒΆ added in v1.53.0

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 (*UpdateAnywhereCacheOperation) Wait ΒΆ added in v1.53.0

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

Directories ΒΆ

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL