Package artifactregistry is an auto-generated package for the Artifact Registry API.
Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.
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 https://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.
CallOptions
type CallOptions struct {
ListRepositories [] gax
. CallOption
GetRepository [] gax
. CallOption
CreateRepository [] gax
. CallOption
UpdateRepository [] gax
. CallOption
DeleteRepository [] gax
. CallOption
ListPackages [] gax
. CallOption
GetPackage [] gax
. CallOption
DeletePackage [] gax
. CallOption
ListVersions [] gax
. CallOption
GetVersion [] gax
. CallOption
DeleteVersion [] gax
. CallOption
ListFiles [] gax
. CallOption
GetFile [] gax
. CallOption
ListTags [] gax
. CallOption
GetTag [] gax
. CallOption
CreateTag [] gax
. CallOption
UpdateTag [] gax
. CallOption
DeleteTag [] gax
. CallOption
SetIamPolicy [] gax
. CallOption
GetIamPolicy [] gax
. CallOption
TestIamPermissions [] gax
. CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type Client struct {
// The call options for this service.
CallOptions * CallOptions
// 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
}
Client is a client for interacting with Artifact Registry API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The Artifact Registry API service.
Artifact Registry is an artifact management system for storing artifacts from different package management systems.
The resources managed by this API are:
Repositories, which group packages and their data.
Packages, which group versions and their tags.
Versions, which are specific forms of a package.
Tags, which represent alternative names for versions.
Files, which contain content and are optionally associated with a Package or Version.
func NewClient
NewClient creates a new artifact registry client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The Artifact Registry API service.
Artifact Registry is an artifact management system for storing artifacts from different package management systems.
The resources managed by this API are:
Repositories, which group packages and their data.
Packages, which group versions and their tags.
Versions, which are specific forms of a package.
Tags, which represent alternative names for versions.
Files, which contain content and are optionally associated with a Package or Version.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection
func (c * Client
) Connection() * grpc
. ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) CreateRepository
func (c * Client
) CreateRepository(ctx context
. Context
, req * artifactregistrypb
. CreateRepositoryRequest
, opts ... gax
. CallOption
) (* CreateRepositoryOperation
, error
)
CreateRepository creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.CreateRepositoryRequest{
// TODO: Fill request struct fields.
}
op, err := c.CreateRepository(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) CreateRepositoryOperation
func (c * Client
) CreateRepositoryOperation(name string
) * CreateRepositoryOperation
CreateRepositoryOperation returns a new CreateRepositoryOperation from a given name. The name must be that of a previously created CreateRepositoryOperation, possibly from a different process.
func (*Client) CreateTag
func (c * Client
) CreateTag(ctx context
. Context
, req * artifactregistrypb
. CreateTagRequest
, opts ... gax
. CallOption
) (* artifactregistrypb
. Tag
, error
)
CreateTag creates a tag.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.CreateTagRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateTag(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) DeletePackage
func (c * Client
) DeletePackage(ctx context
. Context
, req * artifactregistrypb
. DeletePackageRequest
, opts ... gax
. CallOption
) (* DeletePackageOperation
, error
)
DeletePackage deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.DeletePackageRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeletePackage(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) DeletePackageOperation
func (c * Client
) DeletePackageOperation(name string
) * DeletePackageOperation
DeletePackageOperation returns a new DeletePackageOperation from a given name. The name must be that of a previously created DeletePackageOperation, possibly from a different process.
func (*Client) DeleteRepository
func (c * Client
) DeleteRepository(ctx context
. Context
, req * artifactregistrypb
. DeleteRepositoryRequest
, opts ... gax
. CallOption
) (* DeleteRepositoryOperation
, error
)
DeleteRepository deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.DeleteRepositoryRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteRepository(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) DeleteRepositoryOperation
func (c * Client
) DeleteRepositoryOperation(name string
) * DeleteRepositoryOperation
DeleteRepositoryOperation returns a new DeleteRepositoryOperation from a given name. The name must be that of a previously created DeleteRepositoryOperation, possibly from a different process.
func (*Client) DeleteTag
func (c * Client
) DeleteTag(ctx context
. Context
, req * artifactregistrypb
. DeleteTagRequest
, opts ... gax
. CallOption
) error
DeleteTag deletes a tag.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.DeleteTagRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteTag(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) DeleteVersion
func (c * Client
) DeleteVersion(ctx context
. Context
, req * artifactregistrypb
. DeleteVersionRequest
, opts ... gax
. CallOption
) (* DeleteVersionOperation
, error
)
DeleteVersion deletes a version and all of its content. The returned operation will complete once the version has been deleted.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.DeleteVersionRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteVersion(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) DeleteVersionOperation
func (c * Client
) DeleteVersionOperation(name string
) * DeleteVersionOperation
DeleteVersionOperation returns a new DeleteVersionOperation from a given name. The name must be that of a previously created DeleteVersionOperation, possibly from a different process.
func (*Client) GetFile
func (c * Client
) GetFile(ctx context
. Context
, req * artifactregistrypb
. GetFileRequest
, opts ... gax
. CallOption
) (* artifactregistrypb
. File
, error
)
GetFile gets a file.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.GetFileRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetFile(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetIamPolicy
func (c * Client
) GetIamPolicy(ctx context
. Context
, req * iampb
. GetIamPolicyRequest
, opts ... gax
. CallOption
) (* iampb
. Policy
, error
)
GetIamPolicy gets the IAM policy for a given resource.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
iampb "google.golang.org/genproto/googleapis/iam/v1"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.GetIamPolicyRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetIamPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetPackage
func (c * Client
) GetPackage(ctx context
. Context
, req * artifactregistrypb
. GetPackageRequest
, opts ... gax
. CallOption
) (* artifactregistrypb
. Package
, error
)
GetPackage gets a package.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.GetPackageRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetPackage(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetRepository
func (c * Client
) GetRepository(ctx context
. Context
, req * artifactregistrypb
. GetRepositoryRequest
, opts ... gax
. CallOption
) (* artifactregistrypb
. Repository
, error
)
GetRepository gets a repository.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.GetRepositoryRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetRepository(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetTag
func (c * Client
) GetTag(ctx context
. Context
, req * artifactregistrypb
. GetTagRequest
, opts ... gax
. CallOption
) (* artifactregistrypb
. Tag
, error
)
GetTag gets a tag.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.GetTagRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetTag(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetVersion
func (c * Client
) GetVersion(ctx context
. Context
, req * artifactregistrypb
. GetVersionRequest
, opts ... gax
. CallOption
) (* artifactregistrypb
. Version
, error
)
GetVersion gets a version
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.GetVersionRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetVersion(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) ListFiles
func (c * Client
) ListFiles(ctx context
. Context
, req * artifactregistrypb
. ListFilesRequest
, opts ... gax
. CallOption
) * FileIterator
ListFiles lists files.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
"google.golang.org/api/iterator"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.ListFilesRequest{
// TODO: Fill request struct fields.
}
it := c.ListFiles(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListPackages
func (c * Client
) ListPackages(ctx context
. Context
, req * artifactregistrypb
. ListPackagesRequest
, opts ... gax
. CallOption
) * PackageIterator
ListPackages lists packages.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
"google.golang.org/api/iterator"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.ListPackagesRequest{
// TODO: Fill request struct fields.
}
it := c.ListPackages(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListRepositories
func (c * Client
) ListRepositories(ctx context
. Context
, req * artifactregistrypb
. ListRepositoriesRequest
, opts ... gax
. CallOption
) * RepositoryIterator
ListRepositories lists repositories.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
"google.golang.org/api/iterator"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.ListRepositoriesRequest{
// TODO: Fill request struct fields.
}
it := c.ListRepositories(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListTags
func (c * Client
) ListTags(ctx context
. Context
, req * artifactregistrypb
. ListTagsRequest
, opts ... gax
. CallOption
) * TagIterator
ListTags lists tags.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
"google.golang.org/api/iterator"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.ListTagsRequest{
// TODO: Fill request struct fields.
}
it := c.ListTags(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListVersions
func (c * Client
) ListVersions(ctx context
. Context
, req * artifactregistrypb
. ListVersionsRequest
, opts ... gax
. CallOption
) * VersionIterator
ListVersions lists versions.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
"google.golang.org/api/iterator"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.ListVersionsRequest{
// TODO: Fill request struct fields.
}
it := c.ListVersions(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) SetIamPolicy
func (c * Client
) SetIamPolicy(ctx context
. Context
, req * iampb
. SetIamPolicyRequest
, opts ... gax
. CallOption
) (* iampb
. Policy
, error
)
SetIamPolicy updates the IAM policy for a given resource.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
iampb "google.golang.org/genproto/googleapis/iam/v1"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.SetIamPolicyRequest{
// TODO: Fill request struct fields.
}
resp, err := c.SetIamPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) TestIamPermissions
func (c * Client
) TestIamPermissions(ctx context
. Context
, req * iampb
. TestIamPermissionsRequest
, opts ... gax
. CallOption
) (* iampb
. TestIamPermissionsResponse
, error
)
TestIamPermissions tests if the caller has a list of permissions on a resource.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
iampb "google.golang.org/genproto/googleapis/iam/v1"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.TestIamPermissionsRequest{
// TODO: Fill request struct fields.
}
resp, err := c.TestIamPermissions(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) UpdateRepository
func (c * Client
) UpdateRepository(ctx context
. Context
, req * artifactregistrypb
. UpdateRepositoryRequest
, opts ... gax
. CallOption
) (* artifactregistrypb
. Repository
, error
)
UpdateRepository updates a repository.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.UpdateRepositoryRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateRepository(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) UpdateTag
func (c * Client
) UpdateTag(ctx context
. Context
, req * artifactregistrypb
. UpdateTagRequest
, opts ... gax
. CallOption
) (* artifactregistrypb
. Tag
, error
)
UpdateTag updates a tag.
Example
package main
import (
artifactregistry "cloud.google.com/go/artifactregistry/apiv1beta2"
"context"
artifactregistrypb "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1beta2"
)
func main() {
ctx := context.Background()
c, err := artifactregistry.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &artifactregistrypb.UpdateTagRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateTag(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
CreateRepositoryOperation
type CreateRepositoryOperation struct {
// contains filtered or unexported fields
}
CreateRepositoryOperation manages a long-running operation from CreateRepository.
func (*CreateRepositoryOperation) Done
func (op * CreateRepositoryOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateRepositoryOperation) Metadata
func (op * CreateRepositoryOperation
) Metadata() (* artifactregistrypb
. OperationMetadata
, 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 (*CreateRepositoryOperation) Name
func (op * CreateRepositoryOperation
) 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 (*CreateRepositoryOperation) Poll
func (op * CreateRepositoryOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* artifactregistrypb
. Repository
, 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 (*CreateRepositoryOperation) Wait
func (op * CreateRepositoryOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* artifactregistrypb
. Repository
, 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.
DeletePackageOperation
type DeletePackageOperation struct {
// contains filtered or unexported fields
}
DeletePackageOperation manages a long-running operation from DeletePackage.
func (*DeletePackageOperation) Done
func (op * DeletePackageOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*DeletePackageOperation) Metadata
func (op * DeletePackageOperation
) Metadata() (* artifactregistrypb
. OperationMetadata
, 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 (*DeletePackageOperation) Name
func (op * DeletePackageOperation
) 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 (*DeletePackageOperation) Poll
func (op * DeletePackageOperation
) 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 (*DeletePackageOperation) Wait
func (op * DeletePackageOperation
) 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.
DeleteRepositoryOperation
type DeleteRepositoryOperation struct {
// contains filtered or unexported fields
}
DeleteRepositoryOperation manages a long-running operation from DeleteRepository.
func (*DeleteRepositoryOperation) Done
func (op * DeleteRepositoryOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteRepositoryOperation) Metadata
func (op * DeleteRepositoryOperation
) Metadata() (* artifactregistrypb
. OperationMetadata
, 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 (*DeleteRepositoryOperation) Name
func (op * DeleteRepositoryOperation
) 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 (*DeleteRepositoryOperation) Poll
func (op * DeleteRepositoryOperation
) 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 (*DeleteRepositoryOperation) Wait
func (op * DeleteRepositoryOperation
) 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.
DeleteVersionOperation
type DeleteVersionOperation struct {
// contains filtered or unexported fields
}
DeleteVersionOperation manages a long-running operation from DeleteVersion.
func (*DeleteVersionOperation) Done
func (op * DeleteVersionOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteVersionOperation) Metadata
func (op * DeleteVersionOperation
) Metadata() (* artifactregistrypb
. OperationMetadata
, 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 (*DeleteVersionOperation) Name
func (op * DeleteVersionOperation
) 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 (*DeleteVersionOperation) Poll
func (op * DeleteVersionOperation
) 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 (*DeleteVersionOperation) Wait
func (op * DeleteVersionOperation
) 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.
FileIterator
type FileIterator 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 []* artifactregistrypb
. File
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
FileIterator manages a stream of *artifactregistrypb.File.
func (*FileIterator) Next
func (it * FileIterator
) Next() (* artifactregistrypb
. File
, 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 (*FileIterator) PageInfo
func (it * FileIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
PackageIterator
type PackageIterator 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 []* artifactregistrypb
. Package
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
PackageIterator manages a stream of *artifactregistrypb.Package.
func (*PackageIterator) Next
func (it * PackageIterator
) Next() (* artifactregistrypb
. Package
, 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 (*PackageIterator) PageInfo
func (it * PackageIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
RepositoryIterator
type RepositoryIterator 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 []* artifactregistrypb
. Repository
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
RepositoryIterator manages a stream of *artifactregistrypb.Repository.
func (*RepositoryIterator) Next
func (it * RepositoryIterator
) Next() (* artifactregistrypb
. Repository
, 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 (*RepositoryIterator) PageInfo
func (it * RepositoryIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
TagIterator
type TagIterator 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 []* artifactregistrypb
. Tag
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
TagIterator manages a stream of *artifactregistrypb.Tag.
func (*TagIterator) Next
func (it * TagIterator
) Next() (* artifactregistrypb
. Tag
, 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 (*TagIterator) PageInfo
func (it * TagIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
VersionIterator
type VersionIterator 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 []* artifactregistrypb
. Version
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
VersionIterator manages a stream of *artifactregistrypb.Version.
func (*VersionIterator) Next
func (it * VersionIterator
) Next() (* artifactregistrypb
. Version
, 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 (*VersionIterator) PageInfo
func (it * VersionIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
