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:
- 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 := 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.
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
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.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
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
func
(
it
*
FolderIterator
)
All
()
iter
.
Seq2
[
*
controlpb
.
Folder
,
error
]
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.
ManagedFolderIterator
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
func
(
it
*
ManagedFolderIterator
)
All
()
iter
.
Seq2
[
*
controlpb
.
ManagedFolder
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ManagedFolderIterator) Next
func
(
it
*
ManagedFolderIterator
)
Next
()
(
*
controlpb
.
ManagedFolder
,
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 (*ManagedFolderIterator) PageInfo
func
(
it
*
ManagedFolderIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
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
func
(
op
*
RenameFolderOperation
)
Metadata
()
(
*
controlpb
.
RenameFolderMetadata
,
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 (*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
func
(
op
*
RenameFolderOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
controlpb
.
Folder
,
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 (*RenameFolderOperation) Wait
func
(
op
*
RenameFolderOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
controlpb
.
Folder
,
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.
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
}
StorageControlCallOptions contains the retry settings for each method of StorageControlClient.
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 (*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) CreateFolder
func
(
c
*
StorageControlClient
)
CreateFolder
(
ctx
context
.
Context
,
req
*
controlpb
.
CreateFolderRequest
,
opts
...
gax
.
CallOption
)
(
*
controlpb
.
Folder
,
error
)
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
func
(
c
*
StorageControlClient
)
CreateManagedFolder
(
ctx
context
.
Context
,
req
*
controlpb
.
CreateManagedFolderRequest
,
opts
...
gax
.
CallOption
)
(
*
controlpb
.
ManagedFolder
,
error
)
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
func
(
c
*
StorageControlClient
)
DeleteFolder
(
ctx
context
.
Context
,
req
*
controlpb
.
DeleteFolderRequest
,
opts
...
gax
.
CallOption
)
error
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
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) GetFolder
func
(
c
*
StorageControlClient
)
GetFolder
(
ctx
context
.
Context
,
req
*
controlpb
.
GetFolderRequest
,
opts
...
gax
.
CallOption
)
(
*
controlpb
.
Folder
,
error
)
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) GetManagedFolder
func
(
c
*
StorageControlClient
)
GetManagedFolder
(
ctx
context
.
Context
,
req
*
controlpb
.
GetManagedFolderRequest
,
opts
...
gax
.
CallOption
)
(
*
controlpb
.
ManagedFolder
,
error
)
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) GetStorageLayout
func
(
c
*
StorageControlClient
)
GetStorageLayout
(
ctx
context
.
Context
,
req
*
controlpb
.
GetStorageLayoutRequest
,
opts
...
gax
.
CallOption
)
(
*
controlpb
.
StorageLayout
,
error
)
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) ListFolders
func
(
c
*
StorageControlClient
)
ListFolders
(
ctx
context
.
Context
,
req
*
controlpb
.
ListFoldersRequest
,
opts
...
gax
.
CallOption
)
*
FolderIterator
ListFolders retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.
Examples
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
)
}
}
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.
}
// TODO: Use resp.
_
=
resp
}
}
func (*StorageControlClient) ListManagedFolders
func
(
c
*
StorageControlClient
)
ListManagedFolders
(
ctx
context
.
Context
,
req
*
controlpb
.
ListManagedFoldersRequest
,
opts
...
gax
.
CallOption
)
*
ManagedFolderIterator
ListManagedFolders retrieves a list of managed folders for a given bucket.
Examples
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
)
}
}
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.
}
// TODO: Use resp.
_
=
resp
}
}
func (*StorageControlClient) RenameFolder
func
(
c
*
StorageControlClient
)
RenameFolder
(
ctx
context
.
Context
,
req
*
controlpb
.
RenameFolderRequest
,
opts
...
gax
.
CallOption
)
(
*
RenameFolderOperation
,
error
)
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.
