Package apigateway is an auto-generated package for the API Gateway API.
Example usage
To get started with this package, create a client.
ctx := context . Background () c , err := apigateway . 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 := apigateway . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & apigatewaypb . ListGatewaysRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#ListGatewaysRequest. } it := c . ListGateways ( ctx , req ) for { resp , err := it . Next () if err == iterator . Done { break } 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.
ApiConfigIterator
type
ApiConfigIterator
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
[]
*
apigatewaypb
.
ApiConfig
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ApiConfigIterator manages a stream of *apigatewaypb.ApiConfig.
func (*ApiConfigIterator) Next
func
(
it
*
ApiConfigIterator
)
Next
()
(
*
apigatewaypb
.
ApiConfig
,
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 (*ApiConfigIterator) PageInfo
func
(
it
*
ApiConfigIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ApiIterator
type
ApiIterator
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
[]
*
apigatewaypb
.
Api
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ApiIterator manages a stream of *apigatewaypb.Api.
func (*ApiIterator) Next
func
(
it
*
ApiIterator
)
Next
()
(
*
apigatewaypb
.
Api
,
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 (*ApiIterator) PageInfo
func
(
it
*
ApiIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CallOptions
type
CallOptions
struct
{
ListGateways
[]
gax
.
CallOption
GetGateway
[]
gax
.
CallOption
CreateGateway
[]
gax
.
CallOption
UpdateGateway
[]
gax
.
CallOption
DeleteGateway
[]
gax
.
CallOption
ListApis
[]
gax
.
CallOption
GetApi
[]
gax
.
CallOption
CreateApi
[]
gax
.
CallOption
UpdateApi
[]
gax
.
CallOption
DeleteApi
[]
gax
.
CallOption
ListApiConfigs
[]
gax
.
CallOption
GetApiConfig
[]
gax
.
CallOption
CreateApiConfig
[]
gax
.
CallOption
UpdateApiConfig
[]
gax
.
CallOption
DeleteApiConfig
[]
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 API Gateway API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The API Gateway Service is the interface for managing API Gateways.
func NewClient
NewClient creates a new api gateway service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The API Gateway Service is the interface for managing API Gateways.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
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) CreateApi
func
(
c
*
Client
)
CreateApi
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
CreateApiRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateApiOperation
,
error
)
CreateApi creates a new Api in a given project and location.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
CreateApiRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#CreateApiRequest.
}
op
,
err
:=
c
.
CreateApi
(
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) CreateApiConfig
func
(
c
*
Client
)
CreateApiConfig
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
CreateApiConfigRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateApiConfigOperation
,
error
)
CreateApiConfig creates a new ApiConfig in a given project and location.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
CreateApiConfigRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#CreateApiConfigRequest.
}
op
,
err
:=
c
.
CreateApiConfig
(
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) CreateApiConfigOperation
func
(
c
*
Client
)
CreateApiConfigOperation
(
name
string
)
*
CreateApiConfigOperation
CreateApiConfigOperation returns a new CreateApiConfigOperation from a given name. The name must be that of a previously created CreateApiConfigOperation, possibly from a different process.
func (*Client) CreateApiOperation
func
(
c
*
Client
)
CreateApiOperation
(
name
string
)
*
CreateApiOperation
CreateApiOperation returns a new CreateApiOperation from a given name. The name must be that of a previously created CreateApiOperation, possibly from a different process.
func (*Client) CreateGateway
func
(
c
*
Client
)
CreateGateway
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
CreateGatewayRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateGatewayOperation
,
error
)
CreateGateway creates a new Gateway in a given project and location.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
CreateGatewayRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#CreateGatewayRequest.
}
op
,
err
:=
c
.
CreateGateway
(
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) CreateGatewayOperation
func
(
c
*
Client
)
CreateGatewayOperation
(
name
string
)
*
CreateGatewayOperation
CreateGatewayOperation returns a new CreateGatewayOperation from a given name. The name must be that of a previously created CreateGatewayOperation, possibly from a different process.
func (*Client) DeleteApi
func
(
c
*
Client
)
DeleteApi
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
DeleteApiRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteApiOperation
,
error
)
DeleteApi deletes a single Api.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
DeleteApiRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#DeleteApiRequest.
}
op
,
err
:=
c
.
DeleteApi
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteApiConfig
func
(
c
*
Client
)
DeleteApiConfig
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
DeleteApiConfigRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteApiConfigOperation
,
error
)
DeleteApiConfig deletes a single ApiConfig.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
DeleteApiConfigRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#DeleteApiConfigRequest.
}
op
,
err
:=
c
.
DeleteApiConfig
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteApiConfigOperation
func
(
c
*
Client
)
DeleteApiConfigOperation
(
name
string
)
*
DeleteApiConfigOperation
DeleteApiConfigOperation returns a new DeleteApiConfigOperation from a given name. The name must be that of a previously created DeleteApiConfigOperation, possibly from a different process.
func (*Client) DeleteApiOperation
func
(
c
*
Client
)
DeleteApiOperation
(
name
string
)
*
DeleteApiOperation
DeleteApiOperation returns a new DeleteApiOperation from a given name. The name must be that of a previously created DeleteApiOperation, possibly from a different process.
func (*Client) DeleteGateway
func
(
c
*
Client
)
DeleteGateway
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
DeleteGatewayRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteGatewayOperation
,
error
)
DeleteGateway deletes a single Gateway.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
DeleteGatewayRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#DeleteGatewayRequest.
}
op
,
err
:=
c
.
DeleteGateway
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteGatewayOperation
func
(
c
*
Client
)
DeleteGatewayOperation
(
name
string
)
*
DeleteGatewayOperation
DeleteGatewayOperation returns a new DeleteGatewayOperation from a given name. The name must be that of a previously created DeleteGatewayOperation, possibly from a different process.
func (*Client) GetApi
func
(
c
*
Client
)
GetApi
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
GetApiRequest
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Api
,
error
)
GetApi gets details of a single Api.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
GetApiRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#GetApiRequest.
}
resp
,
err
:=
c
.
GetApi
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetApiConfig
func
(
c
*
Client
)
GetApiConfig
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
GetApiConfigRequest
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
ApiConfig
,
error
)
GetApiConfig gets details of a single ApiConfig.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
GetApiConfigRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#GetApiConfigRequest.
}
resp
,
err
:=
c
.
GetApiConfig
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetGateway
func
(
c
*
Client
)
GetGateway
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
GetGatewayRequest
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Gateway
,
error
)
GetGateway gets details of a single Gateway.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
GetGatewayRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#GetGatewayRequest.
}
resp
,
err
:=
c
.
GetGateway
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListApiConfigs
func
(
c
*
Client
)
ListApiConfigs
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
ListApiConfigsRequest
,
opts
...
gax
.
CallOption
)
*
ApiConfigIterator
ListApiConfigs lists ApiConfigs in a given project and location.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
"google.golang.org/api/iterator"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
ListApiConfigsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#ListApiConfigsRequest.
}
it
:=
c
.
ListApiConfigs
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListApis
func
(
c
*
Client
)
ListApis
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
ListApisRequest
,
opts
...
gax
.
CallOption
)
*
ApiIterator
ListApis lists Apis in a given project and location.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
"google.golang.org/api/iterator"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
ListApisRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#ListApisRequest.
}
it
:=
c
.
ListApis
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListGateways
func
(
c
*
Client
)
ListGateways
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
ListGatewaysRequest
,
opts
...
gax
.
CallOption
)
*
GatewayIterator
ListGateways lists Gateways in a given project and location.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
"google.golang.org/api/iterator"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
ListGatewaysRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#ListGatewaysRequest.
}
it
:=
c
.
ListGateways
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) UpdateApi
func
(
c
*
Client
)
UpdateApi
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
UpdateApiRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateApiOperation
,
error
)
UpdateApi updates the parameters of a single Api.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
UpdateApiRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#UpdateApiRequest.
}
op
,
err
:=
c
.
UpdateApi
(
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) UpdateApiConfig
func
(
c
*
Client
)
UpdateApiConfig
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
UpdateApiConfigRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateApiConfigOperation
,
error
)
UpdateApiConfig updates the parameters of a single ApiConfig.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
UpdateApiConfigRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#UpdateApiConfigRequest.
}
op
,
err
:=
c
.
UpdateApiConfig
(
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) UpdateApiConfigOperation
func
(
c
*
Client
)
UpdateApiConfigOperation
(
name
string
)
*
UpdateApiConfigOperation
UpdateApiConfigOperation returns a new UpdateApiConfigOperation from a given name. The name must be that of a previously created UpdateApiConfigOperation, possibly from a different process.
func (*Client) UpdateApiOperation
func
(
c
*
Client
)
UpdateApiOperation
(
name
string
)
*
UpdateApiOperation
UpdateApiOperation returns a new UpdateApiOperation from a given name. The name must be that of a previously created UpdateApiOperation, possibly from a different process.
func (*Client) UpdateGateway
func
(
c
*
Client
)
UpdateGateway
(
ctx
context
.
Context
,
req
*
apigatewaypb
.
UpdateGatewayRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateGatewayOperation
,
error
)
UpdateGateway updates the parameters of a single Gateway.
Example
package
main
import
(
"context"
apigateway
"cloud.google.com/go/apigateway/apiv1"
apigatewaypb
"google.golang.org/genproto/googleapis/cloud/apigateway/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
apigateway
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& apigatewaypb
.
UpdateGatewayRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigateway/v1#UpdateGatewayRequest.
}
op
,
err
:=
c
.
UpdateGateway
(
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) UpdateGatewayOperation
func
(
c
*
Client
)
UpdateGatewayOperation
(
name
string
)
*
UpdateGatewayOperation
UpdateGatewayOperation returns a new UpdateGatewayOperation from a given name. The name must be that of a previously created UpdateGatewayOperation, possibly from a different process.
CreateApiConfigOperation
type
CreateApiConfigOperation
struct
{
// contains filtered or unexported fields
}
CreateApiConfigOperation manages a long-running operation from CreateApiConfig.
func (*CreateApiConfigOperation) Done
func
(
op
*
CreateApiConfigOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateApiConfigOperation) Metadata
func
(
op
*
CreateApiConfigOperation
)
Metadata
()
(
*
apigatewaypb
.
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 (*CreateApiConfigOperation) Name
func
(
op
*
CreateApiConfigOperation
)
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 (*CreateApiConfigOperation) Poll
func
(
op
*
CreateApiConfigOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
ApiConfig
,
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 (*CreateApiConfigOperation) Wait
func
(
op
*
CreateApiConfigOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
ApiConfig
,
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.
CreateApiOperation
type
CreateApiOperation
struct
{
// contains filtered or unexported fields
}
CreateApiOperation manages a long-running operation from CreateApi.
func (*CreateApiOperation) Done
func
(
op
*
CreateApiOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateApiOperation) Metadata
func
(
op
*
CreateApiOperation
)
Metadata
()
(
*
apigatewaypb
.
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 (*CreateApiOperation) Name
func
(
op
*
CreateApiOperation
)
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 (*CreateApiOperation) Poll
func
(
op
*
CreateApiOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Api
,
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 (*CreateApiOperation) Wait
func
(
op
*
CreateApiOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Api
,
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.
CreateGatewayOperation
type
CreateGatewayOperation
struct
{
// contains filtered or unexported fields
}
CreateGatewayOperation manages a long-running operation from CreateGateway.
func (*CreateGatewayOperation) Done
func
(
op
*
CreateGatewayOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateGatewayOperation) Metadata
func
(
op
*
CreateGatewayOperation
)
Metadata
()
(
*
apigatewaypb
.
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 (*CreateGatewayOperation) Name
func
(
op
*
CreateGatewayOperation
)
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 (*CreateGatewayOperation) Poll
func
(
op
*
CreateGatewayOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Gateway
,
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 (*CreateGatewayOperation) Wait
func
(
op
*
CreateGatewayOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Gateway
,
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.
DeleteApiConfigOperation
type
DeleteApiConfigOperation
struct
{
// contains filtered or unexported fields
}
DeleteApiConfigOperation manages a long-running operation from DeleteApiConfig.
func (*DeleteApiConfigOperation) Done
func
(
op
*
DeleteApiConfigOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteApiConfigOperation) Metadata
func
(
op
*
DeleteApiConfigOperation
)
Metadata
()
(
*
apigatewaypb
.
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 (*DeleteApiConfigOperation) Name
func
(
op
*
DeleteApiConfigOperation
)
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 (*DeleteApiConfigOperation) Poll
func
(
op
*
DeleteApiConfigOperation
)
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 (*DeleteApiConfigOperation) Wait
func
(
op
*
DeleteApiConfigOperation
)
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.
DeleteApiOperation
type
DeleteApiOperation
struct
{
// contains filtered or unexported fields
}
DeleteApiOperation manages a long-running operation from DeleteApi.
func (*DeleteApiOperation) Done
func
(
op
*
DeleteApiOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteApiOperation) Metadata
func
(
op
*
DeleteApiOperation
)
Metadata
()
(
*
apigatewaypb
.
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 (*DeleteApiOperation) Name
func
(
op
*
DeleteApiOperation
)
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 (*DeleteApiOperation) Poll
func
(
op
*
DeleteApiOperation
)
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 (*DeleteApiOperation) Wait
func
(
op
*
DeleteApiOperation
)
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.
DeleteGatewayOperation
type
DeleteGatewayOperation
struct
{
// contains filtered or unexported fields
}
DeleteGatewayOperation manages a long-running operation from DeleteGateway.
func (*DeleteGatewayOperation) Done
func
(
op
*
DeleteGatewayOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteGatewayOperation) Metadata
func
(
op
*
DeleteGatewayOperation
)
Metadata
()
(
*
apigatewaypb
.
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 (*DeleteGatewayOperation) Name
func
(
op
*
DeleteGatewayOperation
)
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 (*DeleteGatewayOperation) Poll
func
(
op
*
DeleteGatewayOperation
)
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 (*DeleteGatewayOperation) Wait
func
(
op
*
DeleteGatewayOperation
)
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.
GatewayIterator
type
GatewayIterator
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
[]
*
apigatewaypb
.
Gateway
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
GatewayIterator manages a stream of *apigatewaypb.Gateway.
func (*GatewayIterator) Next
func
(
it
*
GatewayIterator
)
Next
()
(
*
apigatewaypb
.
Gateway
,
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 (*GatewayIterator) PageInfo
func
(
it
*
GatewayIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
UpdateApiConfigOperation
type
UpdateApiConfigOperation
struct
{
// contains filtered or unexported fields
}
UpdateApiConfigOperation manages a long-running operation from UpdateApiConfig.
func (*UpdateApiConfigOperation) Done
func
(
op
*
UpdateApiConfigOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateApiConfigOperation) Metadata
func
(
op
*
UpdateApiConfigOperation
)
Metadata
()
(
*
apigatewaypb
.
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 (*UpdateApiConfigOperation) Name
func
(
op
*
UpdateApiConfigOperation
)
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 (*UpdateApiConfigOperation) Poll
func
(
op
*
UpdateApiConfigOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
ApiConfig
,
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 (*UpdateApiConfigOperation) Wait
func
(
op
*
UpdateApiConfigOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
ApiConfig
,
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.
UpdateApiOperation
type
UpdateApiOperation
struct
{
// contains filtered or unexported fields
}
UpdateApiOperation manages a long-running operation from UpdateApi.
func (*UpdateApiOperation) Done
func
(
op
*
UpdateApiOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateApiOperation) Metadata
func
(
op
*
UpdateApiOperation
)
Metadata
()
(
*
apigatewaypb
.
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 (*UpdateApiOperation) Name
func
(
op
*
UpdateApiOperation
)
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 (*UpdateApiOperation) Poll
func
(
op
*
UpdateApiOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Api
,
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 (*UpdateApiOperation) Wait
func
(
op
*
UpdateApiOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Api
,
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.
UpdateGatewayOperation
type
UpdateGatewayOperation
struct
{
// contains filtered or unexported fields
}
UpdateGatewayOperation manages a long-running operation from UpdateGateway.
func (*UpdateGatewayOperation) Done
func
(
op
*
UpdateGatewayOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateGatewayOperation) Metadata
func
(
op
*
UpdateGatewayOperation
)
Metadata
()
(
*
apigatewaypb
.
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 (*UpdateGatewayOperation) Name
func
(
op
*
UpdateGatewayOperation
)
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 (*UpdateGatewayOperation) Poll
func
(
op
*
UpdateGatewayOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Gateway
,
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 (*UpdateGatewayOperation) Wait
func
(
op
*
UpdateGatewayOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
apigatewaypb
.
Gateway
,
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.
