Package vpcaccess is an auto-generated package for the Serverless VPC Access API.
API for managing VPC access connectors.
Example usage
To get started with this package, create a client.
ctx := context . Background () c , err := vpcaccess . NewClient ( 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 () c , err := vpcaccess . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & vpcaccesspb . CreateConnectorRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/vpcaccess/v1#CreateConnectorRequest. } op , err := c . CreateConnector ( 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 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
{
CreateConnector
[]
gax
.
CallOption
GetConnector
[]
gax
.
CallOption
ListConnectors
[]
gax
.
CallOption
DeleteConnector
[]
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 Serverless VPC Access API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.
func NewClient
NewClient creates a new vpc access service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.
Example
package
main
import
(
"context"
vpcaccess
"cloud.google.com/go/vpcaccess/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
vpcaccess
.
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) CreateConnector
func
(
c
*
Client
)
CreateConnector
(
ctx
context
.
Context
,
req
*
vpcaccesspb
.
CreateConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateConnectorOperation
,
error
)
CreateConnector creates a Serverless VPC Access connector, returns an operation.
Example
package
main
import
(
"context"
vpcaccess
"cloud.google.com/go/vpcaccess/apiv1"
vpcaccesspb
"google.golang.org/genproto/googleapis/cloud/vpcaccess/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
vpcaccess
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& vpcaccesspb
.
CreateConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/vpcaccess/v1#CreateConnectorRequest.
}
op
,
err
:=
c
.
CreateConnector
(
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) CreateConnectorOperation
func
(
c
*
Client
)
CreateConnectorOperation
(
name
string
)
*
CreateConnectorOperation
CreateConnectorOperation returns a new CreateConnectorOperation from a given name. The name must be that of a previously created CreateConnectorOperation, possibly from a different process.
func (*Client) DeleteConnector
func
(
c
*
Client
)
DeleteConnector
(
ctx
context
.
Context
,
req
*
vpcaccesspb
.
DeleteConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteConnectorOperation
,
error
)
DeleteConnector deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.
Example
package
main
import
(
"context"
vpcaccess
"cloud.google.com/go/vpcaccess/apiv1"
vpcaccesspb
"google.golang.org/genproto/googleapis/cloud/vpcaccess/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
vpcaccess
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& vpcaccesspb
.
DeleteConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/vpcaccess/v1#DeleteConnectorRequest.
}
op
,
err
:=
c
.
DeleteConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteConnectorOperation
func
(
c
*
Client
)
DeleteConnectorOperation
(
name
string
)
*
DeleteConnectorOperation
DeleteConnectorOperation returns a new DeleteConnectorOperation from a given name. The name must be that of a previously created DeleteConnectorOperation, possibly from a different process.
func (*Client) GetConnector
func
(
c
*
Client
)
GetConnector
(
ctx
context
.
Context
,
req
*
vpcaccesspb
.
GetConnectorRequest
,
opts
...
gax
.
CallOption
)
(
*
vpcaccesspb
.
Connector
,
error
)
GetConnector gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.
Example
package
main
import
(
"context"
vpcaccess
"cloud.google.com/go/vpcaccess/apiv1"
vpcaccesspb
"google.golang.org/genproto/googleapis/cloud/vpcaccess/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
vpcaccess
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& vpcaccesspb
.
GetConnectorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/vpcaccess/v1#GetConnectorRequest.
}
resp
,
err
:=
c
.
GetConnector
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListConnectors
func
(
c
*
Client
)
ListConnectors
(
ctx
context
.
Context
,
req
*
vpcaccesspb
.
ListConnectorsRequest
,
opts
...
gax
.
CallOption
)
*
ConnectorIterator
ListConnectors lists Serverless VPC Access connectors.
Example
package
main
import
(
"context"
vpcaccess
"cloud.google.com/go/vpcaccess/apiv1"
"google.golang.org/api/iterator"
vpcaccesspb
"google.golang.org/genproto/googleapis/cloud/vpcaccess/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
vpcaccess
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& vpcaccesspb
.
ListConnectorsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/vpcaccess/v1#ListConnectorsRequest.
}
it
:=
c
.
ListConnectors
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
ConnectorIterator
type
ConnectorIterator
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
[]
*
vpcaccesspb
.
Connector
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ConnectorIterator manages a stream of *vpcaccesspb.Connector.
func (*ConnectorIterator) Next
func
(
it
*
ConnectorIterator
)
Next
()
(
*
vpcaccesspb
.
Connector
,
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 (*ConnectorIterator) PageInfo
func
(
it
*
ConnectorIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CreateConnectorOperation
type
CreateConnectorOperation
struct
{
// contains filtered or unexported fields
}
CreateConnectorOperation manages a long-running operation from CreateConnector.
func (*CreateConnectorOperation) Done
func
(
op
*
CreateConnectorOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateConnectorOperation) Metadata
func
(
op
*
CreateConnectorOperation
)
Metadata
()
(
*
vpcaccesspb
.
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 (*CreateConnectorOperation) Name
func
(
op
*
CreateConnectorOperation
)
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 (*CreateConnectorOperation) Poll
func
(
op
*
CreateConnectorOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
vpcaccesspb
.
Connector
,
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 (*CreateConnectorOperation) Wait
func
(
op
*
CreateConnectorOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
vpcaccesspb
.
Connector
,
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.
DeleteConnectorOperation
type
DeleteConnectorOperation
struct
{
// contains filtered or unexported fields
}
DeleteConnectorOperation manages a long-running operation from DeleteConnector.
func (*DeleteConnectorOperation) Done
func
(
op
*
DeleteConnectorOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteConnectorOperation) Metadata
func
(
op
*
DeleteConnectorOperation
)
Metadata
()
(
*
vpcaccesspb
.
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 (*DeleteConnectorOperation) Name
func
(
op
*
DeleteConnectorOperation
)
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 (*DeleteConnectorOperation) Poll
func
(
op
*
DeleteConnectorOperation
)
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 (*DeleteConnectorOperation) Wait
func
(
op
*
DeleteConnectorOperation
)
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.
