func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions contains the retry settings for each method of Client.
type CallOptions struct { ListDataExchanges []gax.CallOption ListOrgDataExchanges []gax.CallOption GetDataExchange []gax.CallOption CreateDataExchange []gax.CallOption UpdateDataExchange []gax.CallOption DeleteDataExchange []gax.CallOption ListListings []gax.CallOption GetListing []gax.CallOption CreateListing []gax.CallOption UpdateListing []gax.CallOption DeleteListing []gax.CallOption SubscribeListing []gax.CallOption SubscribeDataExchange []gax.CallOption RefreshSubscription []gax.CallOption GetSubscription []gax.CallOption ListSubscriptions []gax.CallOption ListSharedResourceSubscriptions []gax.CallOption RevokeSubscription []gax.CallOption DeleteSubscription []gax.CallOption GetIamPolicy []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []gax.CallOption }
Client is a client for interacting with Analytics Hub API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish listings that reference shared datasets. With Analytics Hub, users can discover and search for listings that they have access to. Subscribers can view and subscribe to listings. When you subscribe to a listing, Analytics Hub creates a linked dataset in your project.
type Client struct { // The call options for this service. CallOptions *CallOptions // LROClient is used internally to handle long-running operations. // It is exposed so that its CallOptions can be modified if required. // Users should not Close this client. LROClient *lroauto.OperationsClient // contains filtered or unexported fields }
func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
NewClient creates a new analytics hub service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish listings that reference shared datasets. With Analytics Hub, users can discover and search for listings that they have access to. Subscribers can view and subscribe to listings. When you subscribe to a listing, Analytics Hub creates a linked dataset in your project.
▹ Example
func NewRESTClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
NewRESTClient creates a new analytics hub service rest client.
The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish listings that reference shared datasets. With Analytics Hub, users can discover and search for listings that they have access to. Subscribers can view and subscribe to listings. When you subscribe to a listing, Analytics Hub creates a linked dataset in your project.
▹ Example
func (c *Client) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (c *Client) 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 (c *Client) CreateDataExchange(ctx context.Context, req *analyticshubpb.CreateDataExchangeRequest, opts ...gax.CallOption) (*analyticshubpb.DataExchange, error)
CreateDataExchange creates a new data exchange.
▹ Example
func (c *Client) CreateListing(ctx context.Context, req *analyticshubpb.CreateListingRequest, opts ...gax.CallOption) (*analyticshubpb.Listing, error)
CreateListing creates a new listing.
▹ Example
func (c *Client) DeleteDataExchange(ctx context.Context, req *analyticshubpb.DeleteDataExchangeRequest, opts ...gax.CallOption) error
DeleteDataExchange deletes an existing data exchange.
▹ Example
func (c *Client) DeleteListing(ctx context.Context, req *analyticshubpb.DeleteListingRequest, opts ...gax.CallOption) error
DeleteListing deletes a listing.
▹ Example
func (c *Client) DeleteSubscription(ctx context.Context, req *analyticshubpb.DeleteSubscriptionRequest, opts ...gax.CallOption) (*DeleteSubscriptionOperation, error)
DeleteSubscription deletes a subscription.
▹ Example
func (c *Client) DeleteSubscriptionOperation(name string) *DeleteSubscriptionOperation
DeleteSubscriptionOperation returns a new DeleteSubscriptionOperation from a given name. The name must be that of a previously created DeleteSubscriptionOperation, possibly from a different process.
func (c *Client) GetDataExchange(ctx context.Context, req *analyticshubpb.GetDataExchangeRequest, opts ...gax.CallOption) (*analyticshubpb.DataExchange, error)
GetDataExchange gets the details of a data exchange.
▹ Example
func (c *Client) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy gets the IAM policy.
▹ Example
func (c *Client) GetListing(ctx context.Context, req *analyticshubpb.GetListingRequest, opts ...gax.CallOption) (*analyticshubpb.Listing, error)
GetListing gets the details of a listing.
▹ Example
func (c *Client) GetSubscription(ctx context.Context, req *analyticshubpb.GetSubscriptionRequest, opts ...gax.CallOption) (*analyticshubpb.Subscription, error)
GetSubscription gets the details of a Subscription.
▹ Example
func (c *Client) ListDataExchanges(ctx context.Context, req *analyticshubpb.ListDataExchangesRequest, opts ...gax.CallOption) *DataExchangeIterator
ListDataExchanges lists all data exchanges in a given project and location.
▹ Example
func (c *Client) ListListings(ctx context.Context, req *analyticshubpb.ListListingsRequest, opts ...gax.CallOption) *ListingIterator
ListListings lists all listings in a given project and location.
▹ Example
func (c *Client) ListOrgDataExchanges(ctx context.Context, req *analyticshubpb.ListOrgDataExchangesRequest, opts ...gax.CallOption) *DataExchangeIterator
ListOrgDataExchanges lists all data exchanges from projects in a given organization and location.
▹ Example
func (c *Client) ListSharedResourceSubscriptions(ctx context.Context, req *analyticshubpb.ListSharedResourceSubscriptionsRequest, opts ...gax.CallOption) *SubscriptionIterator
ListSharedResourceSubscriptions lists all subscriptions on a given Data Exchange or Listing.
func (c *Client) ListSubscriptions(ctx context.Context, req *analyticshubpb.ListSubscriptionsRequest, opts ...gax.CallOption) *SubscriptionIterator
ListSubscriptions lists all subscriptions in a given project and location.
▹ Example
func (c *Client) RefreshSubscription(ctx context.Context, req *analyticshubpb.RefreshSubscriptionRequest, opts ...gax.CallOption) (*RefreshSubscriptionOperation, error)
RefreshSubscription refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.
▹ Example
func (c *Client) RefreshSubscriptionOperation(name string) *RefreshSubscriptionOperation
RefreshSubscriptionOperation returns a new RefreshSubscriptionOperation from a given name. The name must be that of a previously created RefreshSubscriptionOperation, possibly from a different process.
func (c *Client) RevokeSubscription(ctx context.Context, req *analyticshubpb.RevokeSubscriptionRequest, opts ...gax.CallOption) (*analyticshubpb.RevokeSubscriptionResponse, error)
RevokeSubscription revokes a given subscription.
▹ Example
func (c *Client) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
SetIamPolicy sets the IAM policy.
▹ Example
func (c *Client) SubscribeDataExchange(ctx context.Context, req *analyticshubpb.SubscribeDataExchangeRequest, opts ...gax.CallOption) (*SubscribeDataExchangeOperation, error)
SubscribeDataExchange creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.
▹ Example
func (c *Client) SubscribeDataExchangeOperation(name string) *SubscribeDataExchangeOperation
SubscribeDataExchangeOperation returns a new SubscribeDataExchangeOperation from a given name. The name must be that of a previously created SubscribeDataExchangeOperation, possibly from a different process.
func (c *Client) SubscribeListing(ctx context.Context, req *analyticshubpb.SubscribeListingRequest, opts ...gax.CallOption) (*analyticshubpb.SubscribeListingResponse, error)
SubscribeListing subscribes to a listing.
Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber’s project.
▹ Example
func (c *Client) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions returns the permissions that a caller has.
▹ Example
func (c *Client) UpdateDataExchange(ctx context.Context, req *analyticshubpb.UpdateDataExchangeRequest, opts ...gax.CallOption) (*analyticshubpb.DataExchange, error)
UpdateDataExchange updates an existing data exchange.
▹ Example
func (c *Client) UpdateListing(ctx context.Context, req *analyticshubpb.UpdateListingRequest, opts ...gax.CallOption) (*analyticshubpb.Listing, error)
UpdateListing updates an existing listing.
▹ Example
DataExchangeIterator manages a stream of *analyticshubpb.DataExchange.
type DataExchangeIterator 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 []*analyticshubpb.DataExchange, nextPageToken string, err error) // contains filtered or unexported fields }
func (it *DataExchangeIterator) Next() (*analyticshubpb.DataExchange, 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 (it *DataExchangeIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
DeleteSubscriptionOperation manages a long-running operation from DeleteSubscription.
type DeleteSubscriptionOperation struct {
// contains filtered or unexported fields
}
func (op *DeleteSubscriptionOperation) Done() bool
Done reports whether the long-running operation has completed.
func (op *DeleteSubscriptionOperation) Metadata() (*analyticshubpb.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 (op *DeleteSubscriptionOperation) 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 (op *DeleteSubscriptionOperation) 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 (op *DeleteSubscriptionOperation) 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.
ListingIterator manages a stream of *analyticshubpb.Listing.
type ListingIterator 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 []*analyticshubpb.Listing, nextPageToken string, err error) // contains filtered or unexported fields }
func (it *ListingIterator) Next() (*analyticshubpb.Listing, 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 (it *ListingIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
RefreshSubscriptionOperation manages a long-running operation from RefreshSubscription.
type RefreshSubscriptionOperation struct {
// contains filtered or unexported fields
}
func (op *RefreshSubscriptionOperation) Done() bool
Done reports whether the long-running operation has completed.
func (op *RefreshSubscriptionOperation) Metadata() (*analyticshubpb.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 (op *RefreshSubscriptionOperation) 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 (op *RefreshSubscriptionOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*analyticshubpb.RefreshSubscriptionResponse, 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 (op *RefreshSubscriptionOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*analyticshubpb.RefreshSubscriptionResponse, 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.
SubscribeDataExchangeOperation manages a long-running operation from SubscribeDataExchange.
type SubscribeDataExchangeOperation struct {
// contains filtered or unexported fields
}
func (op *SubscribeDataExchangeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (op *SubscribeDataExchangeOperation) Metadata() (*analyticshubpb.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 (op *SubscribeDataExchangeOperation) 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 (op *SubscribeDataExchangeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*analyticshubpb.SubscribeDataExchangeResponse, 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 (op *SubscribeDataExchangeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*analyticshubpb.SubscribeDataExchangeResponse, 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.
SubscriptionIterator manages a stream of *analyticshubpb.Subscription.
type SubscriptionIterator 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 []*analyticshubpb.Subscription, nextPageToken string, err error) // contains filtered or unexported fields }
func (it *SubscriptionIterator) Next() (*analyticshubpb.Subscription, 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 (it *SubscriptionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
Name | Synopsis |
---|---|
.. | |
analyticshubpb |