Documentation ¶
Overview ¶
Package networkconnectivity is an auto-generated package for the Network Connectivity API.
This API enables connectivity with and between Google Cloud resources.
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.
// go get cloud.google.com/go/networkconnectivity/apiv1@latest ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client ¶
The following is an example of making an API call with the newly created client, mentioned above.
req := &networkconnectivitypb.AcceptHubSpokeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#AcceptHubSpokeRequest. } op, err := c.AcceptHubSpoke(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 NewHubClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Index ¶
- func DefaultAuthScopes() []string
- type AcceptHubSpokeOperation
- func (op *AcceptHubSpokeOperation) Done() bool
- func (op *AcceptHubSpokeOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *AcceptHubSpokeOperation) Name() string
- func (op *AcceptHubSpokeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.AcceptHubSpokeResponse, error)
- func (op *AcceptHubSpokeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.AcceptHubSpokeResponse, error)
- type CreateHubOperation
- func (op *CreateHubOperation) Done() bool
- func (op *CreateHubOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *CreateHubOperation) Name() string
- func (op *CreateHubOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Hub, error)
- func (op *CreateHubOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Hub, error)
- type CreatePolicyBasedRouteOperation
- func (op *CreatePolicyBasedRouteOperation) Done() bool
- func (op *CreatePolicyBasedRouteOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *CreatePolicyBasedRouteOperation) Name() string
- func (op *CreatePolicyBasedRouteOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.PolicyBasedRoute, error)
- func (op *CreatePolicyBasedRouteOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.PolicyBasedRoute, error)
- type CreateSpokeOperation
- func (op *CreateSpokeOperation) Done() bool
- func (op *CreateSpokeOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *CreateSpokeOperation) Name() string
- func (op *CreateSpokeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Spoke, error)
- func (op *CreateSpokeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Spoke, error)
- type DeleteHubOperation
- func (op *DeleteHubOperation) Done() bool
- func (op *DeleteHubOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *DeleteHubOperation) Name() string
- func (op *DeleteHubOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteHubOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeletePolicyBasedRouteOperation
- func (op *DeletePolicyBasedRouteOperation) Done() bool
- func (op *DeletePolicyBasedRouteOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *DeletePolicyBasedRouteOperation) Name() string
- func (op *DeletePolicyBasedRouteOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeletePolicyBasedRouteOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteSpokeOperation
- func (op *DeleteSpokeOperation) Done() bool
- func (op *DeleteSpokeOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *DeleteSpokeOperation) Name() string
- func (op *DeleteSpokeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteSpokeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type GroupIterator
- type HubCallOptions
- type HubClient
- func (c *HubClient) AcceptHubSpoke(ctx context.Context, req *networkconnectivitypb.AcceptHubSpokeRequest, ...) (*AcceptHubSpokeOperation, error)
- func (c *HubClient) AcceptHubSpokeOperation(name string) *AcceptHubSpokeOperation
- func (c *HubClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *HubClient) Close() error
- func (c *HubClient) Connection() *grpc.ClientConndeprecated
- func (c *HubClient) CreateHub(ctx context.Context, req *networkconnectivitypb.CreateHubRequest, ...) (*CreateHubOperation, error)
- func (c *HubClient) CreateHubOperation(name string) *CreateHubOperation
- func (c *HubClient) CreateSpoke(ctx context.Context, req *networkconnectivitypb.CreateSpokeRequest, ...) (*CreateSpokeOperation, error)
- func (c *HubClient) CreateSpokeOperation(name string) *CreateSpokeOperation
- func (c *HubClient) DeleteHub(ctx context.Context, req *networkconnectivitypb.DeleteHubRequest, ...) (*DeleteHubOperation, error)
- func (c *HubClient) DeleteHubOperation(name string) *DeleteHubOperation
- func (c *HubClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *HubClient) DeleteSpoke(ctx context.Context, req *networkconnectivitypb.DeleteSpokeRequest, ...) (*DeleteSpokeOperation, error)
- func (c *HubClient) DeleteSpokeOperation(name string) *DeleteSpokeOperation
- func (c *HubClient) GetGroup(ctx context.Context, req *networkconnectivitypb.GetGroupRequest, ...) (*networkconnectivitypb.Group, error)
- func (c *HubClient) GetHub(ctx context.Context, req *networkconnectivitypb.GetHubRequest, ...) (*networkconnectivitypb.Hub, error)
- func (c *HubClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *HubClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *HubClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *HubClient) GetRoute(ctx context.Context, req *networkconnectivitypb.GetRouteRequest, ...) (*networkconnectivitypb.Route, error)
- func (c *HubClient) GetRouteTable(ctx context.Context, req *networkconnectivitypb.GetRouteTableRequest, ...) (*networkconnectivitypb.RouteTable, error)
- func (c *HubClient) GetSpoke(ctx context.Context, req *networkconnectivitypb.GetSpokeRequest, ...) (*networkconnectivitypb.Spoke, error)
- func (c *HubClient) ListGroups(ctx context.Context, req *networkconnectivitypb.ListGroupsRequest, ...) *GroupIterator
- func (c *HubClient) ListHubSpokes(ctx context.Context, req *networkconnectivitypb.ListHubSpokesRequest, ...) *SpokeIterator
- func (c *HubClient) ListHubs(ctx context.Context, req *networkconnectivitypb.ListHubsRequest, ...) *HubIterator
- func (c *HubClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *HubClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *HubClient) ListRouteTables(ctx context.Context, req *networkconnectivitypb.ListRouteTablesRequest, ...) *RouteTableIterator
- func (c *HubClient) ListRoutes(ctx context.Context, req *networkconnectivitypb.ListRoutesRequest, ...) *RouteIterator
- func (c *HubClient) ListSpokes(ctx context.Context, req *networkconnectivitypb.ListSpokesRequest, ...) *SpokeIterator
- func (c *HubClient) QueryHubStatus(ctx context.Context, req *networkconnectivitypb.QueryHubStatusRequest, ...) *HubStatusEntryIterator
- func (c *HubClient) RejectHubSpoke(ctx context.Context, req *networkconnectivitypb.RejectHubSpokeRequest, ...) (*RejectHubSpokeOperation, error)
- func (c *HubClient) RejectHubSpokeOperation(name string) *RejectHubSpokeOperation
- func (c *HubClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *HubClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, ...) (*iampb.TestIamPermissionsResponse, error)
- func (c *HubClient) UpdateGroup(ctx context.Context, req *networkconnectivitypb.UpdateGroupRequest, ...) (*UpdateGroupOperation, error)
- func (c *HubClient) UpdateGroupOperation(name string) *UpdateGroupOperation
- func (c *HubClient) UpdateHub(ctx context.Context, req *networkconnectivitypb.UpdateHubRequest, ...) (*UpdateHubOperation, error)
- func (c *HubClient) UpdateHubOperation(name string) *UpdateHubOperation
- func (c *HubClient) UpdateSpoke(ctx context.Context, req *networkconnectivitypb.UpdateSpokeRequest, ...) (*UpdateSpokeOperation, error)
- func (c *HubClient) UpdateSpokeOperation(name string) *UpdateSpokeOperation
- type HubIterator
- type HubStatusEntryIterator
- type LocationIterator
- type OperationIterator
- type PolicyBasedRouteIterator
- type PolicyBasedRoutingCallOptions
- type PolicyBasedRoutingClient
- func (c *PolicyBasedRoutingClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *PolicyBasedRoutingClient) Close() error
- func (c *PolicyBasedRoutingClient) Connection() *grpc.ClientConndeprecated
- func (c *PolicyBasedRoutingClient) CreatePolicyBasedRoute(ctx context.Context, req *networkconnectivitypb.CreatePolicyBasedRouteRequest, ...) (*CreatePolicyBasedRouteOperation, error)
- func (c *PolicyBasedRoutingClient) CreatePolicyBasedRouteOperation(name string) *CreatePolicyBasedRouteOperation
- func (c *PolicyBasedRoutingClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *PolicyBasedRoutingClient) DeletePolicyBasedRoute(ctx context.Context, req *networkconnectivitypb.DeletePolicyBasedRouteRequest, ...) (*DeletePolicyBasedRouteOperation, error)
- func (c *PolicyBasedRoutingClient) DeletePolicyBasedRouteOperation(name string) *DeletePolicyBasedRouteOperation
- func (c *PolicyBasedRoutingClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *PolicyBasedRoutingClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *PolicyBasedRoutingClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *PolicyBasedRoutingClient) GetPolicyBasedRoute(ctx context.Context, req *networkconnectivitypb.GetPolicyBasedRouteRequest, ...) (*networkconnectivitypb.PolicyBasedRoute, error)
- func (c *PolicyBasedRoutingClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *PolicyBasedRoutingClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *PolicyBasedRoutingClient) ListPolicyBasedRoutes(ctx context.Context, req *networkconnectivitypb.ListPolicyBasedRoutesRequest, ...) *PolicyBasedRouteIterator
- func (c *PolicyBasedRoutingClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *PolicyBasedRoutingClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, ...) (*iampb.TestIamPermissionsResponse, error)
- type RejectHubSpokeOperation
- func (op *RejectHubSpokeOperation) Done() bool
- func (op *RejectHubSpokeOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *RejectHubSpokeOperation) Name() string
- func (op *RejectHubSpokeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.RejectHubSpokeResponse, error)
- func (op *RejectHubSpokeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.RejectHubSpokeResponse, error)
- type RouteIterator
- type RouteTableIterator
- type SpokeIterator
- type UpdateGroupOperation
- func (op *UpdateGroupOperation) Done() bool
- func (op *UpdateGroupOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *UpdateGroupOperation) Name() string
- func (op *UpdateGroupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Group, error)
- func (op *UpdateGroupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Group, error)
- type UpdateHubOperation
- func (op *UpdateHubOperation) Done() bool
- func (op *UpdateHubOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *UpdateHubOperation) Name() string
- func (op *UpdateHubOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Hub, error)
- func (op *UpdateHubOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Hub, error)
- type UpdateSpokeOperation
- func (op *UpdateSpokeOperation) Done() bool
- func (op *UpdateSpokeOperation) Metadata() (*networkconnectivitypb.OperationMetadata, error)
- func (op *UpdateSpokeOperation) Name() string
- func (op *UpdateSpokeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Spoke, error)
- func (op *UpdateSpokeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Spoke, error)
Examples ¶
- HubClient.AcceptHubSpoke
- HubClient.CancelOperation
- HubClient.CreateHub
- HubClient.CreateSpoke
- HubClient.DeleteHub
- HubClient.DeleteOperation
- HubClient.DeleteSpoke
- HubClient.GetGroup
- HubClient.GetHub
- HubClient.GetIamPolicy
- HubClient.GetLocation
- HubClient.GetOperation
- HubClient.GetRoute
- HubClient.GetRouteTable
- HubClient.GetSpoke
- HubClient.ListGroups
- HubClient.ListGroups (All)
- HubClient.ListHubSpokes
- HubClient.ListHubSpokes (All)
- HubClient.ListHubs
- HubClient.ListHubs (All)
- HubClient.ListLocations
- HubClient.ListLocations (All)
- HubClient.ListOperations
- HubClient.ListOperations (All)
- HubClient.ListRouteTables
- HubClient.ListRouteTables (All)
- HubClient.ListRoutes
- HubClient.ListRoutes (All)
- HubClient.ListSpokes
- HubClient.ListSpokes (All)
- HubClient.QueryHubStatus
- HubClient.QueryHubStatus (All)
- HubClient.RejectHubSpoke
- HubClient.SetIamPolicy
- HubClient.TestIamPermissions
- HubClient.UpdateGroup
- HubClient.UpdateHub
- HubClient.UpdateSpoke
- NewHubClient
- NewPolicyBasedRoutingClient
- PolicyBasedRoutingClient.CancelOperation
- PolicyBasedRoutingClient.CreatePolicyBasedRoute
- PolicyBasedRoutingClient.DeleteOperation
- PolicyBasedRoutingClient.DeletePolicyBasedRoute
- PolicyBasedRoutingClient.GetIamPolicy
- PolicyBasedRoutingClient.GetLocation
- PolicyBasedRoutingClient.GetOperation
- PolicyBasedRoutingClient.GetPolicyBasedRoute
- PolicyBasedRoutingClient.ListLocations
- PolicyBasedRoutingClient.ListLocations (All)
- PolicyBasedRoutingClient.ListOperations
- PolicyBasedRoutingClient.ListOperations (All)
- PolicyBasedRoutingClient.ListPolicyBasedRoutes
- PolicyBasedRoutingClient.ListPolicyBasedRoutes (All)
- PolicyBasedRoutingClient.SetIamPolicy
- PolicyBasedRoutingClient.TestIamPermissions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type AcceptHubSpokeOperation ¶ added in v1.14.0
type AcceptHubSpokeOperation struct {
// contains filtered or unexported fields
}
AcceptHubSpokeOperation manages a long-running operation from AcceptHubSpoke.
func (*AcceptHubSpokeOperation) Done ¶ added in v1.14.0
func (op *AcceptHubSpokeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*AcceptHubSpokeOperation) Metadata ¶ added in v1.14.0
func (op *AcceptHubSpokeOperation) Metadata() (*networkconnectivitypb.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 (*AcceptHubSpokeOperation) Name ¶ added in v1.14.0
func (op *AcceptHubSpokeOperation) 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 (*AcceptHubSpokeOperation) Poll ¶ added in v1.14.0
func (op *AcceptHubSpokeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.AcceptHubSpokeResponse, 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 (*AcceptHubSpokeOperation) Wait ¶ added in v1.14.0
func (op *AcceptHubSpokeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.AcceptHubSpokeResponse, 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.
type CreateHubOperation ¶
type CreateHubOperation struct {
// contains filtered or unexported fields
}
CreateHubOperation manages a long-running operation from CreateHub.
func (*CreateHubOperation) Done ¶
func (op *CreateHubOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateHubOperation) Metadata ¶
func (op *CreateHubOperation) Metadata() (*networkconnectivitypb.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 (*CreateHubOperation) Name ¶
func (op *CreateHubOperation) 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 (*CreateHubOperation) Poll ¶
func (op *CreateHubOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Hub, 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 (*CreateHubOperation) Wait ¶
func (op *CreateHubOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Hub, 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.
type CreatePolicyBasedRouteOperation ¶ added in v1.8.0
type CreatePolicyBasedRouteOperation struct {
// contains filtered or unexported fields
}
CreatePolicyBasedRouteOperation manages a long-running operation from CreatePolicyBasedRoute.
func (*CreatePolicyBasedRouteOperation) Done ¶ added in v1.8.0
func (op *CreatePolicyBasedRouteOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreatePolicyBasedRouteOperation) Metadata ¶ added in v1.8.0
func (op *CreatePolicyBasedRouteOperation) Metadata() (*networkconnectivitypb.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 (*CreatePolicyBasedRouteOperation) Name ¶ added in v1.8.0
func (op *CreatePolicyBasedRouteOperation) 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 (*CreatePolicyBasedRouteOperation) Poll ¶ added in v1.8.0
func (op *CreatePolicyBasedRouteOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.PolicyBasedRoute, 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 (*CreatePolicyBasedRouteOperation) Wait ¶ added in v1.8.0
func (op *CreatePolicyBasedRouteOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.PolicyBasedRoute, 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.
type CreateSpokeOperation ¶
type CreateSpokeOperation struct {
// contains filtered or unexported fields
}
CreateSpokeOperation manages a long-running operation from CreateSpoke.
func (*CreateSpokeOperation) Done ¶
func (op *CreateSpokeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateSpokeOperation) Metadata ¶
func (op *CreateSpokeOperation) Metadata() (*networkconnectivitypb.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 (*CreateSpokeOperation) Name ¶
func (op *CreateSpokeOperation) 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 (*CreateSpokeOperation) Poll ¶
func (op *CreateSpokeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Spoke, 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 (*CreateSpokeOperation) Wait ¶
func (op *CreateSpokeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Spoke, 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.
type DeleteHubOperation ¶
type DeleteHubOperation struct {
// contains filtered or unexported fields
}
DeleteHubOperation manages a long-running operation from DeleteHub.
func (*DeleteHubOperation) Done ¶
func (op *DeleteHubOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteHubOperation) Metadata ¶
func (op *DeleteHubOperation) Metadata() (*networkconnectivitypb.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 (*DeleteHubOperation) Name ¶
func (op *DeleteHubOperation) 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 (*DeleteHubOperation) Poll ¶
func (op *DeleteHubOperation) 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 (*DeleteHubOperation) Wait ¶
func (op *DeleteHubOperation) 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.
type DeletePolicyBasedRouteOperation ¶ added in v1.8.0
type DeletePolicyBasedRouteOperation struct {
// contains filtered or unexported fields
}
DeletePolicyBasedRouteOperation manages a long-running operation from DeletePolicyBasedRoute.
func (*DeletePolicyBasedRouteOperation) Done ¶ added in v1.8.0
func (op *DeletePolicyBasedRouteOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeletePolicyBasedRouteOperation) Metadata ¶ added in v1.8.0
func (op *DeletePolicyBasedRouteOperation) Metadata() (*networkconnectivitypb.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 (*DeletePolicyBasedRouteOperation) Name ¶ added in v1.8.0
func (op *DeletePolicyBasedRouteOperation) 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 (*DeletePolicyBasedRouteOperation) Poll ¶ added in v1.8.0
func (op *DeletePolicyBasedRouteOperation) 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 (*DeletePolicyBasedRouteOperation) Wait ¶ added in v1.8.0
func (op *DeletePolicyBasedRouteOperation) 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.
type DeleteSpokeOperation ¶
type DeleteSpokeOperation struct {
// contains filtered or unexported fields
}
DeleteSpokeOperation manages a long-running operation from DeleteSpoke.
func (*DeleteSpokeOperation) Done ¶
func (op *DeleteSpokeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteSpokeOperation) Metadata ¶
func (op *DeleteSpokeOperation) Metadata() (*networkconnectivitypb.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 (*DeleteSpokeOperation) Name ¶
func (op *DeleteSpokeOperation) 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 (*DeleteSpokeOperation) Poll ¶
func (op *DeleteSpokeOperation) 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 (*DeleteSpokeOperation) Wait ¶
func (op *DeleteSpokeOperation) 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.
type GroupIterator ¶ added in v1.14.0
type GroupIterator 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 []*networkconnectivitypb.Group, nextPageToken string, err error) // contains filtered or unexported fields }
GroupIterator manages a stream of *networkconnectivitypb.Group.
func (*GroupIterator) All ¶ added in v1.15.1
func (it *GroupIterator) All() iter.Seq2[*networkconnectivitypb.Group, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*GroupIterator) Next ¶ added in v1.14.0
func (it *GroupIterator) Next() (*networkconnectivitypb.Group, 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 (*GroupIterator) PageInfo ¶ added in v1.14.0
func (it *GroupIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type HubCallOptions ¶
type HubCallOptions struct { ListHubs []gax.CallOption GetHub []gax.CallOption CreateHub []gax.CallOption UpdateHub []gax.CallOption DeleteHub []gax.CallOption ListHubSpokes []gax.CallOption QueryHubStatus []gax.CallOption ListSpokes []gax.CallOption GetSpoke []gax.CallOption CreateSpoke []gax.CallOption UpdateSpoke []gax.CallOption RejectHubSpoke []gax.CallOption AcceptHubSpoke []gax.CallOption DeleteSpoke []gax.CallOption GetRouteTable []gax.CallOption GetRoute []gax.CallOption ListRoutes []gax.CallOption ListRouteTables []gax.CallOption GetGroup []gax.CallOption ListGroups []gax.CallOption UpdateGroup []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption GetIamPolicy []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
HubCallOptions contains the retry settings for each method of HubClient.
type HubClient ¶
type HubClient struct { // The call options for this service. CallOptions *HubCallOptions // 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 }
HubClient is a client for interacting with Network Connectivity API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model.
func NewHubClient ¶
NewHubClient creates a new hub service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*HubClient) AcceptHubSpoke ¶ added in v1.14.0
func (c *HubClient) AcceptHubSpoke(ctx context.Context, req *networkconnectivitypb.AcceptHubSpokeRequest, opts ...gax.CallOption) (*AcceptHubSpokeOperation, error)
AcceptHubSpoke accepts a proposal to attach a Network Connectivity Center spoke to a hub.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.AcceptHubSpokeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#AcceptHubSpokeRequest. } op, err := c.AcceptHubSpoke(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) AcceptHubSpokeOperation ¶ added in v1.14.0
func (c *HubClient) AcceptHubSpokeOperation(name string) *AcceptHubSpokeOperation
AcceptHubSpokeOperation returns a new AcceptHubSpokeOperation from a given name. The name must be that of a previously created AcceptHubSpokeOperation, possibly from a different process.
func (*HubClient) CancelOperation ¶ added in v1.8.0
func (c *HubClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*HubClient) Close ¶
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*HubClient) Connection
deprecated
func (c *HubClient) 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 (*HubClient) CreateHub ¶
func (c *HubClient) CreateHub(ctx context.Context, req *networkconnectivitypb.CreateHubRequest, opts ...gax.CallOption) (*CreateHubOperation, error)
CreateHub creates a new Network Connectivity Center hub in the specified project.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.CreateHubRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#CreateHubRequest. } op, err := c.CreateHub(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) CreateHubOperation ¶
func (c *HubClient) CreateHubOperation(name string) *CreateHubOperation
CreateHubOperation returns a new CreateHubOperation from a given name. The name must be that of a previously created CreateHubOperation, possibly from a different process.
func (*HubClient) CreateSpoke ¶
func (c *HubClient) CreateSpoke(ctx context.Context, req *networkconnectivitypb.CreateSpokeRequest, opts ...gax.CallOption) (*CreateSpokeOperation, error)
CreateSpoke creates a Network Connectivity Center spoke.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.CreateSpokeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#CreateSpokeRequest. } op, err := c.CreateSpoke(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) CreateSpokeOperation ¶
func (c *HubClient) CreateSpokeOperation(name string) *CreateSpokeOperation
CreateSpokeOperation returns a new CreateSpokeOperation from a given name. The name must be that of a previously created CreateSpokeOperation, possibly from a different process.
func (*HubClient) DeleteHub ¶
func (c *HubClient) DeleteHub(ctx context.Context, req *networkconnectivitypb.DeleteHubRequest, opts ...gax.CallOption) (*DeleteHubOperation, error)
DeleteHub deletes a Network Connectivity Center hub.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.DeleteHubRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#DeleteHubRequest. } op, err := c.DeleteHub(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*HubClient) DeleteHubOperation ¶
func (c *HubClient) DeleteHubOperation(name string) *DeleteHubOperation
DeleteHubOperation returns a new DeleteHubOperation from a given name. The name must be that of a previously created DeleteHubOperation, possibly from a different process.
func (*HubClient) DeleteOperation ¶ added in v1.8.0
func (c *HubClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*HubClient) DeleteSpoke ¶
func (c *HubClient) DeleteSpoke(ctx context.Context, req *networkconnectivitypb.DeleteSpokeRequest, opts ...gax.CallOption) (*DeleteSpokeOperation, error)
DeleteSpoke deletes a Network Connectivity Center spoke.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.DeleteSpokeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#DeleteSpokeRequest. } op, err := c.DeleteSpoke(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*HubClient) DeleteSpokeOperation ¶
func (c *HubClient) DeleteSpokeOperation(name string) *DeleteSpokeOperation
DeleteSpokeOperation returns a new DeleteSpokeOperation from a given name. The name must be that of a previously created DeleteSpokeOperation, possibly from a different process.
func (*HubClient) GetGroup ¶ added in v1.14.0
func (c *HubClient) GetGroup(ctx context.Context, req *networkconnectivitypb.GetGroupRequest, opts ...gax.CallOption) (*networkconnectivitypb.Group, error)
GetGroup gets details about a Network Connectivity Center group.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.GetGroupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#GetGroupRequest. } resp, err := c.GetGroup(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) GetHub ¶
func (c *HubClient) GetHub(ctx context.Context, req *networkconnectivitypb.GetHubRequest, opts ...gax.CallOption) (*networkconnectivitypb.Hub, error)
GetHub gets details about a Network Connectivity Center hub.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.GetHubRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#GetHubRequest. } resp, err := c.GetHub(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) GetIamPolicy ¶ added in v1.8.0
func (c *HubClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.GetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest. } resp, err := c.GetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) GetLocation ¶ added in v1.8.0
func (c *HubClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) GetOperation ¶ added in v1.8.0
func (c *HubClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) GetRoute ¶ added in v1.14.0
func (c *HubClient) GetRoute(ctx context.Context, req *networkconnectivitypb.GetRouteRequest, opts ...gax.CallOption) (*networkconnectivitypb.Route, error)
GetRoute gets details about the specified route.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.GetRouteRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#GetRouteRequest. } resp, err := c.GetRoute(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) GetRouteTable ¶ added in v1.14.0
func (c *HubClient) GetRouteTable(ctx context.Context, req *networkconnectivitypb.GetRouteTableRequest, opts ...gax.CallOption) (*networkconnectivitypb.RouteTable, error)
GetRouteTable gets details about a Network Connectivity Center route table.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.GetRouteTableRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#GetRouteTableRequest. } resp, err := c.GetRouteTable(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) GetSpoke ¶
func (c *HubClient) GetSpoke(ctx context.Context, req *networkconnectivitypb.GetSpokeRequest, opts ...gax.CallOption) (*networkconnectivitypb.Spoke, error)
GetSpoke gets details about a Network Connectivity Center spoke.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.GetSpokeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#GetSpokeRequest. } resp, err := c.GetSpoke(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) ListGroups ¶ added in v1.14.0
func (c *HubClient) ListGroups(ctx context.Context, req *networkconnectivitypb.ListGroupsRequest, opts ...gax.CallOption) *GroupIterator
ListGroups lists groups in a given hub.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" "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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListGroupsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListGroupsRequest. } it := c.ListGroups(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.(*networkconnectivitypb.ListGroupsResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListGroupsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListGroupsRequest. } for resp, err := range c.ListGroups(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*HubClient) ListHubSpokes ¶ added in v1.14.0
func (c *HubClient) ListHubSpokes(ctx context.Context, req *networkconnectivitypb.ListHubSpokesRequest, opts ...gax.CallOption) *SpokeIterator
ListHubSpokes lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" "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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListHubSpokesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListHubSpokesRequest. } it := c.ListHubSpokes(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.(*networkconnectivitypb.ListHubSpokesResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListHubSpokesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListHubSpokesRequest. } for resp, err := range c.ListHubSpokes(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*HubClient) ListHubs ¶
func (c *HubClient) ListHubs(ctx context.Context, req *networkconnectivitypb.ListHubsRequest, opts ...gax.CallOption) *HubIterator
ListHubs lists the Network Connectivity Center hubs associated with a given project.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" "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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListHubsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListHubsRequest. } it := c.ListHubs(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.(*networkconnectivitypb.ListHubsResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListHubsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListHubsRequest. } for resp, err := range c.ListHubs(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*HubClient) ListLocations ¶ added in v1.8.0
func (c *HubClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(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.(*locationpb.ListLocationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } for resp, err := range c.ListLocations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*HubClient) ListOperations ¶ added in v1.8.0
func (c *HubClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" "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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(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.(*longrunningpb.ListOperationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } for resp, err := range c.ListOperations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*HubClient) ListRouteTables ¶ added in v1.14.0
func (c *HubClient) ListRouteTables(ctx context.Context, req *networkconnectivitypb.ListRouteTablesRequest, opts ...gax.CallOption) *RouteTableIterator
ListRouteTables lists route tables in a given hub.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" "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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListRouteTablesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListRouteTablesRequest. } it := c.ListRouteTables(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.(*networkconnectivitypb.ListRouteTablesResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListRouteTablesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListRouteTablesRequest. } for resp, err := range c.ListRouteTables(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*HubClient) ListRoutes ¶ added in v1.14.0
func (c *HubClient) ListRoutes(ctx context.Context, req *networkconnectivitypb.ListRoutesRequest, opts ...gax.CallOption) *RouteIterator
ListRoutes lists routes in a given route table.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" "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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListRoutesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListRoutesRequest. } it := c.ListRoutes(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.(*networkconnectivitypb.ListRoutesResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListRoutesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListRoutesRequest. } for resp, err := range c.ListRoutes(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*HubClient) ListSpokes ¶
func (c *HubClient) ListSpokes(ctx context.Context, req *networkconnectivitypb.ListSpokesRequest, opts ...gax.CallOption) *SpokeIterator
ListSpokes lists the Network Connectivity Center spokes in a specified project and location.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" "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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListSpokesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListSpokesRequest. } it := c.ListSpokes(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.(*networkconnectivitypb.ListSpokesResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListSpokesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListSpokesRequest. } for resp, err := range c.ListSpokes(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*HubClient) QueryHubStatus ¶ added in v1.16.0
func (c *HubClient) QueryHubStatus(ctx context.Context, req *networkconnectivitypb.QueryHubStatusRequest, opts ...gax.CallOption) *HubStatusEntryIterator
QueryHubStatus query the Private Service Connect propagation status of a Network Connectivity Center hub.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" "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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.QueryHubStatusRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#QueryHubStatusRequest. } it := c.QueryHubStatus(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.(*networkconnectivitypb.QueryHubStatusResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.QueryHubStatusRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#QueryHubStatusRequest. } for resp, err := range c.QueryHubStatus(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*HubClient) RejectHubSpoke ¶ added in v1.14.0
func (c *HubClient) RejectHubSpoke(ctx context.Context, req *networkconnectivitypb.RejectHubSpokeRequest, opts ...gax.CallOption) (*RejectHubSpokeOperation, error)
RejectHubSpoke rejects a Network Connectivity Center spoke from being attached to a hub. If the spoke was previously in the ACTIVE state, it transitions to the INACTIVE state and is no longer able to connect to other spokes that are attached to the hub.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.RejectHubSpokeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#RejectHubSpokeRequest. } op, err := c.RejectHubSpoke(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) RejectHubSpokeOperation ¶ added in v1.14.0
func (c *HubClient) RejectHubSpokeOperation(name string) *RejectHubSpokeOperation
RejectHubSpokeOperation returns a new RejectHubSpokeOperation from a given name. The name must be that of a previously created RejectHubSpokeOperation, possibly from a different process.
func (*HubClient) SetIamPolicy ¶ added in v1.8.0
func (c *HubClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
SetIamPolicy sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.SetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest. } resp, err := c.SetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) TestIamPermissions ¶ added in v1.8.0
func (c *HubClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.TestIamPermissionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest. } resp, err := c.TestIamPermissions(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) UpdateGroup ¶ added in v1.16.0
func (c *HubClient) UpdateGroup(ctx context.Context, req *networkconnectivitypb.UpdateGroupRequest, opts ...gax.CallOption) (*UpdateGroupOperation, error)
UpdateGroup updates the parameters of a Network Connectivity Center group.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.UpdateGroupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#UpdateGroupRequest. } op, err := c.UpdateGroup(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) UpdateGroupOperation ¶ added in v1.16.0
func (c *HubClient) UpdateGroupOperation(name string) *UpdateGroupOperation
UpdateGroupOperation returns a new UpdateGroupOperation from a given name. The name must be that of a previously created UpdateGroupOperation, possibly from a different process.
func (*HubClient) UpdateHub ¶
func (c *HubClient) UpdateHub(ctx context.Context, req *networkconnectivitypb.UpdateHubRequest, opts ...gax.CallOption) (*UpdateHubOperation, error)
UpdateHub updates the description and/or labels of a Network Connectivity Center hub.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.UpdateHubRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#UpdateHubRequest. } op, err := c.UpdateHub(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) UpdateHubOperation ¶
func (c *HubClient) UpdateHubOperation(name string) *UpdateHubOperation
UpdateHubOperation returns a new UpdateHubOperation from a given name. The name must be that of a previously created UpdateHubOperation, possibly from a different process.
func (*HubClient) UpdateSpoke ¶
func (c *HubClient) UpdateSpoke(ctx context.Context, req *networkconnectivitypb.UpdateSpokeRequest, opts ...gax.CallOption) (*UpdateSpokeOperation, error)
UpdateSpoke updates the parameters of a Network Connectivity Center spoke.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewHubClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.UpdateSpokeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#UpdateSpokeRequest. } op, err := c.UpdateSpoke(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*HubClient) UpdateSpokeOperation ¶
func (c *HubClient) UpdateSpokeOperation(name string) *UpdateSpokeOperation
UpdateSpokeOperation returns a new UpdateSpokeOperation from a given name. The name must be that of a previously created UpdateSpokeOperation, possibly from a different process.
type HubIterator ¶
type HubIterator 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 []*networkconnectivitypb.Hub, nextPageToken string, err error) // contains filtered or unexported fields }
HubIterator manages a stream of *networkconnectivitypb.Hub.
func (*HubIterator) All ¶ added in v1.15.1
func (it *HubIterator) All() iter.Seq2[*networkconnectivitypb.Hub, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*HubIterator) Next ¶
func (it *HubIterator) Next() (*networkconnectivitypb.Hub, 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 (*HubIterator) PageInfo ¶
func (it *HubIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type HubStatusEntryIterator ¶ added in v1.16.0
type HubStatusEntryIterator 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 []*networkconnectivitypb.HubStatusEntry, nextPageToken string, err error) // contains filtered or unexported fields }
HubStatusEntryIterator manages a stream of *networkconnectivitypb.HubStatusEntry.
func (*HubStatusEntryIterator) All ¶ added in v1.16.0
func (it *HubStatusEntryIterator) All() iter.Seq2[*networkconnectivitypb.HubStatusEntry, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*HubStatusEntryIterator) Next ¶ added in v1.16.0
func (it *HubStatusEntryIterator) Next() (*networkconnectivitypb.HubStatusEntry, 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 (*HubStatusEntryIterator) PageInfo ¶ added in v1.16.0
func (it *HubStatusEntryIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type LocationIterator ¶ added in v1.8.0
type LocationIterator 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 []*locationpb.Location, nextPageToken string, err error) // contains filtered or unexported fields }
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All ¶ added in v1.15.1
func (it *LocationIterator) All() iter.Seq2[*locationpb.Location, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*LocationIterator) Next ¶ added in v1.8.0
func (it *LocationIterator) Next() (*locationpb.Location, 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 (*LocationIterator) PageInfo ¶ added in v1.8.0
func (it *LocationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type OperationIterator ¶ added in v1.8.0
type OperationIterator 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 []*longrunningpb.Operation, nextPageToken string, err error) // contains filtered or unexported fields }
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All ¶ added in v1.15.1
func (it *OperationIterator) All() iter.Seq2[*longrunningpb.Operation, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*OperationIterator) Next ¶ added in v1.8.0
func (it *OperationIterator) Next() (*longrunningpb.Operation, 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 (*OperationIterator) PageInfo ¶ added in v1.8.0
func (it *OperationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type PolicyBasedRouteIterator ¶ added in v1.8.0
type PolicyBasedRouteIterator 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 []*networkconnectivitypb.PolicyBasedRoute, nextPageToken string, err error) // contains filtered or unexported fields }
PolicyBasedRouteIterator manages a stream of *networkconnectivitypb.PolicyBasedRoute.
func (*PolicyBasedRouteIterator) All ¶ added in v1.15.1
func (it *PolicyBasedRouteIterator) All() iter.Seq2[*networkconnectivitypb.PolicyBasedRoute, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*PolicyBasedRouteIterator) Next ¶ added in v1.8.0
func (it *PolicyBasedRouteIterator) Next() (*networkconnectivitypb.PolicyBasedRoute, 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 (*PolicyBasedRouteIterator) PageInfo ¶ added in v1.8.0
func (it *PolicyBasedRouteIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type PolicyBasedRoutingCallOptions ¶ added in v1.8.0
type PolicyBasedRoutingCallOptions struct { ListPolicyBasedRoutes []gax.CallOption GetPolicyBasedRoute []gax.CallOption CreatePolicyBasedRoute []gax.CallOption DeletePolicyBasedRoute []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption GetIamPolicy []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
PolicyBasedRoutingCallOptions contains the retry settings for each method of PolicyBasedRoutingClient.
type PolicyBasedRoutingClient ¶ added in v1.8.0
type PolicyBasedRoutingClient struct { // The call options for this service. CallOptions *PolicyBasedRoutingCallOptions // 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 }
PolicyBasedRoutingClient is a client for interacting with Network Connectivity API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.
func NewPolicyBasedRoutingClient ¶ added in v1.8.0
func NewPolicyBasedRoutingClient(ctx context.Context, opts ...option.ClientOption) (*PolicyBasedRoutingClient, error)
NewPolicyBasedRoutingClient creates a new policy based routing service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*PolicyBasedRoutingClient) CancelOperation ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*PolicyBasedRoutingClient) Close ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*PolicyBasedRoutingClient) Connection
deprecated
added in
v1.8.0
func (c *PolicyBasedRoutingClient) 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 (*PolicyBasedRoutingClient) CreatePolicyBasedRoute ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) CreatePolicyBasedRoute(ctx context.Context, req *networkconnectivitypb.CreatePolicyBasedRouteRequest, opts ...gax.CallOption) (*CreatePolicyBasedRouteOperation, error)
CreatePolicyBasedRoute creates a new PolicyBasedRoute in a given project and location.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.CreatePolicyBasedRouteRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#CreatePolicyBasedRouteRequest. } op, err := c.CreatePolicyBasedRoute(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*PolicyBasedRoutingClient) CreatePolicyBasedRouteOperation ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) CreatePolicyBasedRouteOperation(name string) *CreatePolicyBasedRouteOperation
CreatePolicyBasedRouteOperation returns a new CreatePolicyBasedRouteOperation from a given name. The name must be that of a previously created CreatePolicyBasedRouteOperation, possibly from a different process.
func (*PolicyBasedRoutingClient) DeleteOperation ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*PolicyBasedRoutingClient) DeletePolicyBasedRoute ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) DeletePolicyBasedRoute(ctx context.Context, req *networkconnectivitypb.DeletePolicyBasedRouteRequest, opts ...gax.CallOption) (*DeletePolicyBasedRouteOperation, error)
DeletePolicyBasedRoute deletes a single PolicyBasedRoute.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.DeletePolicyBasedRouteRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#DeletePolicyBasedRouteRequest. } op, err := c.DeletePolicyBasedRoute(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*PolicyBasedRoutingClient) DeletePolicyBasedRouteOperation ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) DeletePolicyBasedRouteOperation(name string) *DeletePolicyBasedRouteOperation
DeletePolicyBasedRouteOperation returns a new DeletePolicyBasedRouteOperation from a given name. The name must be that of a previously created DeletePolicyBasedRouteOperation, possibly from a different process.
func (*PolicyBasedRoutingClient) GetIamPolicy ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.GetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest. } resp, err := c.GetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*PolicyBasedRoutingClient) GetLocation ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*PolicyBasedRoutingClient) GetOperation ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*PolicyBasedRoutingClient) GetPolicyBasedRoute ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) GetPolicyBasedRoute(ctx context.Context, req *networkconnectivitypb.GetPolicyBasedRouteRequest, opts ...gax.CallOption) (*networkconnectivitypb.PolicyBasedRoute, error)
GetPolicyBasedRoute gets details of a single PolicyBasedRoute.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.GetPolicyBasedRouteRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#GetPolicyBasedRouteRequest. } resp, err := c.GetPolicyBasedRoute(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*PolicyBasedRoutingClient) ListLocations ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(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.(*locationpb.ListLocationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } for resp, err := range c.ListLocations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*PolicyBasedRoutingClient) ListOperations ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" "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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(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.(*longrunningpb.ListOperationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } for resp, err := range c.ListOperations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*PolicyBasedRoutingClient) ListPolicyBasedRoutes ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) ListPolicyBasedRoutes(ctx context.Context, req *networkconnectivitypb.ListPolicyBasedRoutesRequest, opts ...gax.CallOption) *PolicyBasedRouteIterator
ListPolicyBasedRoutes lists PolicyBasedRoutes in a given project and location.
Example ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" "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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListPolicyBasedRoutesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListPolicyBasedRoutesRequest. } it := c.ListPolicyBasedRoutes(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.(*networkconnectivitypb.ListPolicyBasedRoutesResponse) } }
Output:
Example (All) ¶
package main import ( "context" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" networkconnectivitypb "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &networkconnectivitypb.ListPolicyBasedRoutesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb#ListPolicyBasedRoutesRequest. } for resp, err := range c.ListPolicyBasedRoutes(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*PolicyBasedRoutingClient) SetIamPolicy ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
SetIamPolicy sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.SetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest. } resp, err := c.SetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*PolicyBasedRoutingClient) TestIamPermissions ¶ added in v1.8.0
func (c *PolicyBasedRoutingClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" networkconnectivity "cloud.google.com/go/networkconnectivity/apiv1" ) 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 := networkconnectivity.NewPolicyBasedRoutingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.TestIamPermissionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest. } resp, err := c.TestIamPermissions(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
type RejectHubSpokeOperation ¶ added in v1.14.0
type RejectHubSpokeOperation struct {
// contains filtered or unexported fields
}
RejectHubSpokeOperation manages a long-running operation from RejectHubSpoke.
func (*RejectHubSpokeOperation) Done ¶ added in v1.14.0
func (op *RejectHubSpokeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*RejectHubSpokeOperation) Metadata ¶ added in v1.14.0
func (op *RejectHubSpokeOperation) Metadata() (*networkconnectivitypb.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 (*RejectHubSpokeOperation) Name ¶ added in v1.14.0
func (op *RejectHubSpokeOperation) 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 (*RejectHubSpokeOperation) Poll ¶ added in v1.14.0
func (op *RejectHubSpokeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.RejectHubSpokeResponse, 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 (*RejectHubSpokeOperation) Wait ¶ added in v1.14.0
func (op *RejectHubSpokeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.RejectHubSpokeResponse, 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.
type RouteIterator ¶ added in v1.14.0
type RouteIterator 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 []*networkconnectivitypb.Route, nextPageToken string, err error) // contains filtered or unexported fields }
RouteIterator manages a stream of *networkconnectivitypb.Route.
func (*RouteIterator) All ¶ added in v1.15.1
func (it *RouteIterator) All() iter.Seq2[*networkconnectivitypb.Route, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*RouteIterator) Next ¶ added in v1.14.0
func (it *RouteIterator) Next() (*networkconnectivitypb.Route, 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 (*RouteIterator) PageInfo ¶ added in v1.14.0
func (it *RouteIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type RouteTableIterator ¶ added in v1.14.0
type RouteTableIterator 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 []*networkconnectivitypb.RouteTable, nextPageToken string, err error) // contains filtered or unexported fields }
RouteTableIterator manages a stream of *networkconnectivitypb.RouteTable.
func (*RouteTableIterator) All ¶ added in v1.15.1
func (it *RouteTableIterator) All() iter.Seq2[*networkconnectivitypb.RouteTable, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*RouteTableIterator) Next ¶ added in v1.14.0
func (it *RouteTableIterator) Next() (*networkconnectivitypb.RouteTable, 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 (*RouteTableIterator) PageInfo ¶ added in v1.14.0
func (it *RouteTableIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type SpokeIterator ¶
type SpokeIterator 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 []*networkconnectivitypb.Spoke, nextPageToken string, err error) // contains filtered or unexported fields }
SpokeIterator manages a stream of *networkconnectivitypb.Spoke.
func (*SpokeIterator) All ¶ added in v1.15.1
func (it *SpokeIterator) All() iter.Seq2[*networkconnectivitypb.Spoke, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*SpokeIterator) Next ¶
func (it *SpokeIterator) Next() (*networkconnectivitypb.Spoke, 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 (*SpokeIterator) PageInfo ¶
func (it *SpokeIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type UpdateGroupOperation ¶ added in v1.16.0
type UpdateGroupOperation struct {
// contains filtered or unexported fields
}
UpdateGroupOperation manages a long-running operation from UpdateGroup.
func (*UpdateGroupOperation) Done ¶ added in v1.16.0
func (op *UpdateGroupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateGroupOperation) Metadata ¶ added in v1.16.0
func (op *UpdateGroupOperation) Metadata() (*networkconnectivitypb.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 (*UpdateGroupOperation) Name ¶ added in v1.16.0
func (op *UpdateGroupOperation) 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 (*UpdateGroupOperation) Poll ¶ added in v1.16.0
func (op *UpdateGroupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Group, 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 (*UpdateGroupOperation) Wait ¶ added in v1.16.0
func (op *UpdateGroupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Group, 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.
type UpdateHubOperation ¶
type UpdateHubOperation struct {
// contains filtered or unexported fields
}
UpdateHubOperation manages a long-running operation from UpdateHub.
func (*UpdateHubOperation) Done ¶
func (op *UpdateHubOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateHubOperation) Metadata ¶
func (op *UpdateHubOperation) Metadata() (*networkconnectivitypb.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 (*UpdateHubOperation) Name ¶
func (op *UpdateHubOperation) 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 (*UpdateHubOperation) Poll ¶
func (op *UpdateHubOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Hub, 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 (*UpdateHubOperation) Wait ¶
func (op *UpdateHubOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Hub, 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.
type UpdateSpokeOperation ¶
type UpdateSpokeOperation struct {
// contains filtered or unexported fields
}
UpdateSpokeOperation manages a long-running operation from UpdateSpoke.
func (*UpdateSpokeOperation) Done ¶
func (op *UpdateSpokeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateSpokeOperation) Metadata ¶
func (op *UpdateSpokeOperation) Metadata() (*networkconnectivitypb.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 (*UpdateSpokeOperation) Name ¶
func (op *UpdateSpokeOperation) 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 (*UpdateSpokeOperation) Poll ¶
func (op *UpdateSpokeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Spoke, 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 (*UpdateSpokeOperation) Wait ¶
func (op *UpdateSpokeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*networkconnectivitypb.Spoke, 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.