analyticshubpb

package
v1.61.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2024 License: Apache-2.0 Imports: 15 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Listing_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ACTIVE",
	}
	Listing_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ACTIVE":            1,
	}
)

Enum value maps for Listing_State.

View Source
var (
	Listing_Category_name = map[int32]string{
		0:  "CATEGORY_UNSPECIFIED",
		1:  "CATEGORY_OTHERS",
		2:  "CATEGORY_ADVERTISING_AND_MARKETING",
		3:  "CATEGORY_COMMERCE",
		4:  "CATEGORY_CLIMATE_AND_ENVIRONMENT",
		5:  "CATEGORY_DEMOGRAPHICS",
		6:  "CATEGORY_ECONOMICS",
		7:  "CATEGORY_EDUCATION",
		8:  "CATEGORY_ENERGY",
		9:  "CATEGORY_FINANCIAL",
		10: "CATEGORY_GAMING",
		11: "CATEGORY_GEOSPATIAL",
		12: "CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE",
		13: "CATEGORY_MEDIA",
		14: "CATEGORY_PUBLIC_SECTOR",
		15: "CATEGORY_RETAIL",
		16: "CATEGORY_SPORTS",
		17: "CATEGORY_SCIENCE_AND_RESEARCH",
		18: "CATEGORY_TRANSPORTATION_AND_LOGISTICS",
		19: "CATEGORY_TRAVEL_AND_TOURISM",
	}
	Listing_Category_value = map[string]int32{
		"CATEGORY_UNSPECIFIED":                  0,
		"CATEGORY_OTHERS":                       1,
		"CATEGORY_ADVERTISING_AND_MARKETING":    2,
		"CATEGORY_COMMERCE":                     3,
		"CATEGORY_CLIMATE_AND_ENVIRONMENT":      4,
		"CATEGORY_DEMOGRAPHICS":                 5,
		"CATEGORY_ECONOMICS":                    6,
		"CATEGORY_EDUCATION":                    7,
		"CATEGORY_ENERGY":                       8,
		"CATEGORY_FINANCIAL":                    9,
		"CATEGORY_GAMING":                       10,
		"CATEGORY_GEOSPATIAL":                   11,
		"CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE":  12,
		"CATEGORY_MEDIA":                        13,
		"CATEGORY_PUBLIC_SECTOR":                14,
		"CATEGORY_RETAIL":                       15,
		"CATEGORY_SPORTS":                       16,
		"CATEGORY_SCIENCE_AND_RESEARCH":         17,
		"CATEGORY_TRANSPORTATION_AND_LOGISTICS": 18,
		"CATEGORY_TRAVEL_AND_TOURISM":           19,
	}
)

Enum value maps for Listing_Category.

View Source
var (
	Subscription_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STATE_ACTIVE",
		2: "STATE_STALE",
		3: "STATE_INACTIVE",
	}
	Subscription_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STATE_ACTIVE":      1,
		"STATE_STALE":       2,
		"STATE_INACTIVE":    3,
	}
)

Enum value maps for Subscription_State.

View Source
var File_google_cloud_bigquery_analyticshub_v1_analyticshub_proto protoreflect.FileDescriptor

Functions

func RegisterAnalyticsHubServiceServer

func RegisterAnalyticsHubServiceServer(s *grpc.Server, srv AnalyticsHubServiceServer)

Types

type AnalyticsHubServiceClient

type AnalyticsHubServiceClient interface {
	// Lists all data exchanges in a given project and location.
	ListDataExchanges(ctx context.Context, in *ListDataExchangesRequest, opts ...grpc.CallOption) (*ListDataExchangesResponse, error)
	// Lists all data exchanges from projects in a given organization and
	// location.
	ListOrgDataExchanges(ctx context.Context, in *ListOrgDataExchangesRequest, opts ...grpc.CallOption) (*ListOrgDataExchangesResponse, error)
	// Gets the details of a data exchange.
	GetDataExchange(ctx context.Context, in *GetDataExchangeRequest, opts ...grpc.CallOption) (*DataExchange, error)
	// Creates a new data exchange.
	CreateDataExchange(ctx context.Context, in *CreateDataExchangeRequest, opts ...grpc.CallOption) (*DataExchange, error)
	// Updates an existing data exchange.
	UpdateDataExchange(ctx context.Context, in *UpdateDataExchangeRequest, opts ...grpc.CallOption) (*DataExchange, error)
	// Deletes an existing data exchange.
	DeleteDataExchange(ctx context.Context, in *DeleteDataExchangeRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all listings in a given project and location.
	ListListings(ctx context.Context, in *ListListingsRequest, opts ...grpc.CallOption) (*ListListingsResponse, error)
	// Gets the details of a listing.
	GetListing(ctx context.Context, in *GetListingRequest, opts ...grpc.CallOption) (*Listing, error)
	// Creates a new listing.
	CreateListing(ctx context.Context, in *CreateListingRequest, opts ...grpc.CallOption) (*Listing, error)
	// Updates an existing listing.
	UpdateListing(ctx context.Context, in *UpdateListingRequest, opts ...grpc.CallOption) (*Listing, error)
	// Deletes a listing.
	DeleteListing(ctx context.Context, in *DeleteListingRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// 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.
	SubscribeListing(ctx context.Context, in *SubscribeListingRequest, opts ...grpc.CallOption) (*SubscribeListingResponse, error)
	// Creates a Subscription to a Data Exchange. This is a long-running operation
	// as it will create one or more linked datasets.
	SubscribeDataExchange(ctx context.Context, in *SubscribeDataExchangeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// 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.
	RefreshSubscription(ctx context.Context, in *RefreshSubscriptionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets the details of a Subscription.
	GetSubscription(ctx context.Context, in *GetSubscriptionRequest, opts ...grpc.CallOption) (*Subscription, error)
	// Lists all subscriptions in a given project and location.
	ListSubscriptions(ctx context.Context, in *ListSubscriptionsRequest, opts ...grpc.CallOption) (*ListSubscriptionsResponse, error)
	// Lists all subscriptions on a given Data Exchange or Listing.
	ListSharedResourceSubscriptions(ctx context.Context, in *ListSharedResourceSubscriptionsRequest, opts ...grpc.CallOption) (*ListSharedResourceSubscriptionsResponse, error)
	// Revokes a given subscription.
	RevokeSubscription(ctx context.Context, in *RevokeSubscriptionRequest, opts ...grpc.CallOption) (*RevokeSubscriptionResponse, error)
	// Deletes a subscription.
	DeleteSubscription(ctx context.Context, in *DeleteSubscriptionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets the IAM policy.
	GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Sets the IAM policy.
	SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Returns the permissions that a caller has.
	TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}

AnalyticsHubServiceClient is the client API for AnalyticsHubService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type AnalyticsHubServiceServer

type AnalyticsHubServiceServer interface {
	// Lists all data exchanges in a given project and location.
	ListDataExchanges(context.Context, *ListDataExchangesRequest) (*ListDataExchangesResponse, error)
	// Lists all data exchanges from projects in a given organization and
	// location.
	ListOrgDataExchanges(context.Context, *ListOrgDataExchangesRequest) (*ListOrgDataExchangesResponse, error)
	// Gets the details of a data exchange.
	GetDataExchange(context.Context, *GetDataExchangeRequest) (*DataExchange, error)
	// Creates a new data exchange.
	CreateDataExchange(context.Context, *CreateDataExchangeRequest) (*DataExchange, error)
	// Updates an existing data exchange.
	UpdateDataExchange(context.Context, *UpdateDataExchangeRequest) (*DataExchange, error)
	// Deletes an existing data exchange.
	DeleteDataExchange(context.Context, *DeleteDataExchangeRequest) (*emptypb.Empty, error)
	// Lists all listings in a given project and location.
	ListListings(context.Context, *ListListingsRequest) (*ListListingsResponse, error)
	// Gets the details of a listing.
	GetListing(context.Context, *GetListingRequest) (*Listing, error)
	// Creates a new listing.
	CreateListing(context.Context, *CreateListingRequest) (*Listing, error)
	// Updates an existing listing.
	UpdateListing(context.Context, *UpdateListingRequest) (*Listing, error)
	// Deletes a listing.
	DeleteListing(context.Context, *DeleteListingRequest) (*emptypb.Empty, error)
	// 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.
	SubscribeListing(context.Context, *SubscribeListingRequest) (*SubscribeListingResponse, error)
	// Creates a Subscription to a Data Exchange. This is a long-running operation
	// as it will create one or more linked datasets.
	SubscribeDataExchange(context.Context, *SubscribeDataExchangeRequest) (*longrunningpb.Operation, error)
	// 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.
	RefreshSubscription(context.Context, *RefreshSubscriptionRequest) (*longrunningpb.Operation, error)
	// Gets the details of a Subscription.
	GetSubscription(context.Context, *GetSubscriptionRequest) (*Subscription, error)
	// Lists all subscriptions in a given project and location.
	ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*ListSubscriptionsResponse, error)
	// Lists all subscriptions on a given Data Exchange or Listing.
	ListSharedResourceSubscriptions(context.Context, *ListSharedResourceSubscriptionsRequest) (*ListSharedResourceSubscriptionsResponse, error)
	// Revokes a given subscription.
	RevokeSubscription(context.Context, *RevokeSubscriptionRequest) (*RevokeSubscriptionResponse, error)
	// Deletes a subscription.
	DeleteSubscription(context.Context, *DeleteSubscriptionRequest) (*longrunningpb.Operation, error)
	// Gets the IAM policy.
	GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
	// Sets the IAM policy.
	SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
	// Returns the permissions that a caller has.
	TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}

AnalyticsHubServiceServer is the server API for AnalyticsHubService service.

type CreateDataExchangeRequest

type CreateDataExchangeRequest struct {

	// Required. The parent resource path of the data exchange.
	// e.g. `projects/myproject/locations/US`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The ID of the data exchange.
	// Must contain only Unicode letters, numbers (0-9), underscores (_).
	// Should not use characters that require URL-escaping, or characters
	// outside of ASCII, spaces.
	// Max length: 100 bytes.
	DataExchangeId string `protobuf:"bytes,2,opt,name=data_exchange_id,json=dataExchangeId,proto3" json:"data_exchange_id,omitempty"`
	// Required. The data exchange to create.
	DataExchange *DataExchange `protobuf:"bytes,3,opt,name=data_exchange,json=dataExchange,proto3" json:"data_exchange,omitempty"`
	// contains filtered or unexported fields
}

Message for creating a data exchange.

func (*CreateDataExchangeRequest) Descriptor deprecated

func (*CreateDataExchangeRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*CreateDataExchangeRequest) GetDataExchange

func (x *CreateDataExchangeRequest) GetDataExchange() *DataExchange

func (*CreateDataExchangeRequest) GetDataExchangeId

func (x *CreateDataExchangeRequest) GetDataExchangeId() string

func (*CreateDataExchangeRequest) GetParent

func (x *CreateDataExchangeRequest) GetParent() string

func (*CreateDataExchangeRequest) ProtoMessage

func (*CreateDataExchangeRequest) ProtoMessage()

func (*CreateDataExchangeRequest) ProtoReflect

func (*CreateDataExchangeRequest) Reset

func (x *CreateDataExchangeRequest) Reset()

func (*CreateDataExchangeRequest) String

func (x *CreateDataExchangeRequest) String() string

type CreateListingRequest

type CreateListingRequest struct {

	// Required. The parent resource path of the listing.
	// e.g. `projects/myproject/locations/US/dataExchanges/123`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The ID of the listing to create.
	// Must contain only Unicode letters, numbers (0-9), underscores (_).
	// Should not use characters that require URL-escaping, or characters
	// outside of ASCII, spaces.
	// Max length: 100 bytes.
	ListingId string `protobuf:"bytes,2,opt,name=listing_id,json=listingId,proto3" json:"listing_id,omitempty"`
	// Required. The listing to create.
	Listing *Listing `protobuf:"bytes,3,opt,name=listing,proto3" json:"listing,omitempty"`
	// contains filtered or unexported fields
}

Message for creating a listing.

func (*CreateListingRequest) Descriptor deprecated

func (*CreateListingRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateListingRequest.ProtoReflect.Descriptor instead.

func (*CreateListingRequest) GetListing

func (x *CreateListingRequest) GetListing() *Listing

func (*CreateListingRequest) GetListingId

func (x *CreateListingRequest) GetListingId() string

func (*CreateListingRequest) GetParent

func (x *CreateListingRequest) GetParent() string

func (*CreateListingRequest) ProtoMessage

func (*CreateListingRequest) ProtoMessage()

func (*CreateListingRequest) ProtoReflect

func (x *CreateListingRequest) ProtoReflect() protoreflect.Message

func (*CreateListingRequest) Reset

func (x *CreateListingRequest) Reset()

func (*CreateListingRequest) String

func (x *CreateListingRequest) String() string

type DataExchange

type DataExchange struct {

	// Output only. The resource name of the data exchange.
	// e.g. `projects/myproject/locations/US/dataExchanges/123`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Human-readable display name of the data exchange. The display
	// name must contain only Unicode letters, numbers (0-9), underscores (_),
	// dashes (-), spaces ( ), ampersands (&) and must not start or end with
	// spaces. Default value is an empty string. Max length: 63 bytes.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. Description of the data exchange. The description must not
	// contain Unicode non-characters as well as C0 and C1 control codes except
	// tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF).
	// Default value is an empty string.
	// Max length: 2000 bytes.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Email or URL of the primary point of contact of the data
	// exchange. Max Length: 1000 bytes.
	PrimaryContact string `protobuf:"bytes,4,opt,name=primary_contact,json=primaryContact,proto3" json:"primary_contact,omitempty"`
	// Optional. Documentation describing the data exchange.
	Documentation string `protobuf:"bytes,5,opt,name=documentation,proto3" json:"documentation,omitempty"`
	// Output only. Number of listings contained in the data exchange.
	ListingCount int32 `protobuf:"varint,6,opt,name=listing_count,json=listingCount,proto3" json:"listing_count,omitempty"`
	// Optional. Base64 encoded image representing the data exchange. Max
	// Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API
	// only performs validation on size of the encoded data. Note: For byte
	// fields, the content of the fields are base64-encoded (which increases the
	// size of the data by 33-36%) when using JSON on the wire.
	Icon []byte `protobuf:"bytes,7,opt,name=icon,proto3" json:"icon,omitempty"`
	// Optional. Configurable data sharing environment option for a data exchange.
	SharingEnvironmentConfig *SharingEnvironmentConfig `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.

func (*DataExchange) Descriptor deprecated

func (*DataExchange) Descriptor() ([]byte, []int)

Deprecated: Use DataExchange.ProtoReflect.Descriptor instead.

func (*DataExchange) GetDescription

func (x *DataExchange) GetDescription() string

func (*DataExchange) GetDisplayName

func (x *DataExchange) GetDisplayName() string

func (*DataExchange) GetDocumentation

func (x *DataExchange) GetDocumentation() string

func (*DataExchange) GetIcon

func (x *DataExchange) GetIcon() []byte

func (*DataExchange) GetListingCount

func (x *DataExchange) GetListingCount() int32

func (*DataExchange) GetName

func (x *DataExchange) GetName() string

func (*DataExchange) GetPrimaryContact

func (x *DataExchange) GetPrimaryContact() string

func (*DataExchange) GetSharingEnvironmentConfig added in v1.56.0

func (x *DataExchange) GetSharingEnvironmentConfig() *SharingEnvironmentConfig

func (*DataExchange) ProtoMessage

func (*DataExchange) ProtoMessage()

func (*DataExchange) ProtoReflect

func (x *DataExchange) ProtoReflect() protoreflect.Message

func (*DataExchange) Reset

func (x *DataExchange) Reset()

func (*DataExchange) String

func (x *DataExchange) String() string

type DataProvider

type DataProvider struct {

	// Optional. Name of the data provider.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Email or URL of the data provider.
	// Max Length: 1000 bytes.
	PrimaryContact string `protobuf:"bytes,2,opt,name=primary_contact,json=primaryContact,proto3" json:"primary_contact,omitempty"`
	// contains filtered or unexported fields
}

Contains details of the data provider.

func (*DataProvider) Descriptor deprecated

func (*DataProvider) Descriptor() ([]byte, []int)

Deprecated: Use DataProvider.ProtoReflect.Descriptor instead.

func (*DataProvider) GetName

func (x *DataProvider) GetName() string

func (*DataProvider) GetPrimaryContact

func (x *DataProvider) GetPrimaryContact() string

func (*DataProvider) ProtoMessage

func (*DataProvider) ProtoMessage()

func (*DataProvider) ProtoReflect

func (x *DataProvider) ProtoReflect() protoreflect.Message

func (*DataProvider) Reset

func (x *DataProvider) Reset()

func (*DataProvider) String

func (x *DataProvider) String() string

type DeleteDataExchangeRequest

type DeleteDataExchangeRequest struct {

	// Required. The full name of the data exchange resource that you want to
	// delete. For example, `projects/myproject/locations/US/dataExchanges/123`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for deleting a data exchange.

func (*DeleteDataExchangeRequest) Descriptor deprecated

func (*DeleteDataExchangeRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataExchangeRequest) GetName

func (x *DeleteDataExchangeRequest) GetName() string

func (*DeleteDataExchangeRequest) ProtoMessage

func (*DeleteDataExchangeRequest) ProtoMessage()

func (*DeleteDataExchangeRequest) ProtoReflect

func (*DeleteDataExchangeRequest) Reset

func (x *DeleteDataExchangeRequest) Reset()

func (*DeleteDataExchangeRequest) String

func (x *DeleteDataExchangeRequest) String() string

type DeleteListingRequest

type DeleteListingRequest struct {

	// Required. Resource name of the listing to delete.
	// e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for deleting a listing.

func (*DeleteListingRequest) Descriptor deprecated

func (*DeleteListingRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteListingRequest.ProtoReflect.Descriptor instead.

func (*DeleteListingRequest) GetName

func (x *DeleteListingRequest) GetName() string

func (*DeleteListingRequest) ProtoMessage

func (*DeleteListingRequest) ProtoMessage()

func (*DeleteListingRequest) ProtoReflect

func (x *DeleteListingRequest) ProtoReflect() protoreflect.Message

func (*DeleteListingRequest) Reset

func (x *DeleteListingRequest) Reset()

func (*DeleteListingRequest) String

func (x *DeleteListingRequest) String() string

type DeleteSubscriptionRequest added in v1.56.0

type DeleteSubscriptionRequest struct {

	// Required. Resource name of the subscription to delete.
	// e.g. projects/123/locations/US/subscriptions/456
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for deleting a subscription.

func (*DeleteSubscriptionRequest) Descriptor deprecated added in v1.56.0

func (*DeleteSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*DeleteSubscriptionRequest) GetName added in v1.56.0

func (x *DeleteSubscriptionRequest) GetName() string

func (*DeleteSubscriptionRequest) ProtoMessage added in v1.56.0

func (*DeleteSubscriptionRequest) ProtoMessage()

func (*DeleteSubscriptionRequest) ProtoReflect added in v1.56.0

func (*DeleteSubscriptionRequest) Reset added in v1.56.0

func (x *DeleteSubscriptionRequest) Reset()

func (*DeleteSubscriptionRequest) String added in v1.56.0

func (x *DeleteSubscriptionRequest) String() string

type DestinationDataset

type DestinationDataset struct {

	// Required. A reference that identifies the destination dataset.
	DatasetReference *DestinationDatasetReference `protobuf:"bytes,1,opt,name=dataset_reference,json=datasetReference,proto3" json:"dataset_reference,omitempty"`
	// Optional. A descriptive name for the dataset.
	FriendlyName *wrapperspb.StringValue `protobuf:"bytes,2,opt,name=friendly_name,json=friendlyName,proto3" json:"friendly_name,omitempty"`
	// Optional. A user-friendly description of the dataset.
	Description *wrapperspb.StringValue `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. The labels associated with this dataset. You can use these
	// to organize and group your datasets.
	// You can set this property when inserting or updating a dataset.
	// See https://cloud.google.com/resource-manager/docs/creating-managing-labels
	// for more information.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Required. The geographic location where the dataset should reside. See
	// https://cloud.google.com/bigquery/docs/locations for supported
	// locations.
	Location string `protobuf:"bytes,5,opt,name=location,proto3" json:"location,omitempty"`
	// contains filtered or unexported fields
}

Defines the destination bigquery dataset.

func (*DestinationDataset) Descriptor deprecated

func (*DestinationDataset) Descriptor() ([]byte, []int)

Deprecated: Use DestinationDataset.ProtoReflect.Descriptor instead.

func (*DestinationDataset) GetDatasetReference

func (x *DestinationDataset) GetDatasetReference() *DestinationDatasetReference

func (*DestinationDataset) GetDescription

func (x *DestinationDataset) GetDescription() *wrapperspb.StringValue

func (*DestinationDataset) GetFriendlyName

func (x *DestinationDataset) GetFriendlyName() *wrapperspb.StringValue

func (*DestinationDataset) GetLabels

func (x *DestinationDataset) GetLabels() map[string]string

func (*DestinationDataset) GetLocation

func (x *DestinationDataset) GetLocation() string

func (*DestinationDataset) ProtoMessage

func (*DestinationDataset) ProtoMessage()

func (*DestinationDataset) ProtoReflect

func (x *DestinationDataset) ProtoReflect() protoreflect.Message

func (*DestinationDataset) Reset

func (x *DestinationDataset) Reset()

func (*DestinationDataset) String

func (x *DestinationDataset) String() string

type DestinationDatasetReference

type DestinationDatasetReference struct {

	// Required. A unique ID for this dataset, without the project name. The ID
	// must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
	// The maximum length is 1,024 characters.
	DatasetId string `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// Required. The ID of the project containing this dataset.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// contains filtered or unexported fields
}

Contains the reference that identifies a destination bigquery dataset.

func (*DestinationDatasetReference) Descriptor deprecated

func (*DestinationDatasetReference) Descriptor() ([]byte, []int)

Deprecated: Use DestinationDatasetReference.ProtoReflect.Descriptor instead.

func (*DestinationDatasetReference) GetDatasetId

func (x *DestinationDatasetReference) GetDatasetId() string

func (*DestinationDatasetReference) GetProjectId

func (x *DestinationDatasetReference) GetProjectId() string

func (*DestinationDatasetReference) ProtoMessage

func (*DestinationDatasetReference) ProtoMessage()

func (*DestinationDatasetReference) ProtoReflect

func (*DestinationDatasetReference) Reset

func (x *DestinationDatasetReference) Reset()

func (*DestinationDatasetReference) String

func (x *DestinationDatasetReference) String() string

type GetDataExchangeRequest

type GetDataExchangeRequest struct {

	// Required. The resource name of the data exchange.
	// e.g. `projects/myproject/locations/US/dataExchanges/123`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a data exchange.

func (*GetDataExchangeRequest) Descriptor deprecated

func (*GetDataExchangeRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*GetDataExchangeRequest) GetName

func (x *GetDataExchangeRequest) GetName() string

func (*GetDataExchangeRequest) ProtoMessage

func (*GetDataExchangeRequest) ProtoMessage()

func (*GetDataExchangeRequest) ProtoReflect

func (x *GetDataExchangeRequest) ProtoReflect() protoreflect.Message

func (*GetDataExchangeRequest) Reset

func (x *GetDataExchangeRequest) Reset()

func (*GetDataExchangeRequest) String

func (x *GetDataExchangeRequest) String() string

type GetListingRequest

type GetListingRequest struct {

	// Required. The resource name of the listing.
	// e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a listing.

func (*GetListingRequest) Descriptor deprecated

func (*GetListingRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetListingRequest.ProtoReflect.Descriptor instead.

func (*GetListingRequest) GetName

func (x *GetListingRequest) GetName() string

func (*GetListingRequest) ProtoMessage

func (*GetListingRequest) ProtoMessage()

func (*GetListingRequest) ProtoReflect

func (x *GetListingRequest) ProtoReflect() protoreflect.Message

func (*GetListingRequest) Reset

func (x *GetListingRequest) Reset()

func (*GetListingRequest) String

func (x *GetListingRequest) String() string

type GetSubscriptionRequest added in v1.56.0

type GetSubscriptionRequest struct {

	// Required. Resource name of the subscription.
	// e.g. projects/123/locations/US/subscriptions/456
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a subscription.

func (*GetSubscriptionRequest) Descriptor deprecated added in v1.56.0

func (*GetSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*GetSubscriptionRequest) GetName added in v1.56.0

func (x *GetSubscriptionRequest) GetName() string

func (*GetSubscriptionRequest) ProtoMessage added in v1.56.0

func (*GetSubscriptionRequest) ProtoMessage()

func (*GetSubscriptionRequest) ProtoReflect added in v1.56.0

func (x *GetSubscriptionRequest) ProtoReflect() protoreflect.Message

func (*GetSubscriptionRequest) Reset added in v1.56.0

func (x *GetSubscriptionRequest) Reset()

func (*GetSubscriptionRequest) String added in v1.56.0

func (x *GetSubscriptionRequest) String() string

type ListDataExchangesRequest

type ListDataExchangesRequest struct {

	// Required. The parent resource path of the data exchanges.
	// e.g. `projects/myproject/locations/US`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of results to return in a single response page. Leverage
	// the page tokens to iterate through the entire collection.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token, returned by a previous call, to request the next page of
	// results.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting the list of data exchanges.

func (*ListDataExchangesRequest) Descriptor deprecated

func (*ListDataExchangesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDataExchangesRequest.ProtoReflect.Descriptor instead.

func (*ListDataExchangesRequest) GetPageSize

func (x *ListDataExchangesRequest) GetPageSize() int32

func (*ListDataExchangesRequest) GetPageToken

func (x *ListDataExchangesRequest) GetPageToken() string

func (*ListDataExchangesRequest) GetParent

func (x *ListDataExchangesRequest) GetParent() string

func (*ListDataExchangesRequest) ProtoMessage

func (*ListDataExchangesRequest) ProtoMessage()

func (*ListDataExchangesRequest) ProtoReflect

func (x *ListDataExchangesRequest) ProtoReflect() protoreflect.Message

func (*ListDataExchangesRequest) Reset

func (x *ListDataExchangesRequest) Reset()

func (*ListDataExchangesRequest) String

func (x *ListDataExchangesRequest) String() string

type ListDataExchangesResponse

type ListDataExchangesResponse struct {

	// The list of data exchanges.
	DataExchanges []*DataExchange `protobuf:"bytes,1,rep,name=data_exchanges,json=dataExchanges,proto3" json:"data_exchanges,omitempty"`
	// A token to request the next page of results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for response to the list of data exchanges.

func (*ListDataExchangesResponse) Descriptor deprecated

func (*ListDataExchangesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDataExchangesResponse.ProtoReflect.Descriptor instead.

func (*ListDataExchangesResponse) GetDataExchanges

func (x *ListDataExchangesResponse) GetDataExchanges() []*DataExchange

func (*ListDataExchangesResponse) GetNextPageToken

func (x *ListDataExchangesResponse) GetNextPageToken() string

func (*ListDataExchangesResponse) ProtoMessage

func (*ListDataExchangesResponse) ProtoMessage()

func (*ListDataExchangesResponse) ProtoReflect

func (*ListDataExchangesResponse) Reset

func (x *ListDataExchangesResponse) Reset()

func (*ListDataExchangesResponse) String

func (x *ListDataExchangesResponse) String() string

type ListListingsRequest

type ListListingsRequest struct {

	// Required. The parent resource path of the listing.
	// e.g. `projects/myproject/locations/US/dataExchanges/123`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of results to return in a single response page. Leverage
	// the page tokens to iterate through the entire collection.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token, returned by a previous call, to request the next page of
	// results.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting the list of listings.

func (*ListListingsRequest) Descriptor deprecated

func (*ListListingsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListListingsRequest.ProtoReflect.Descriptor instead.

func (*ListListingsRequest) GetPageSize

func (x *ListListingsRequest) GetPageSize() int32

func (*ListListingsRequest) GetPageToken

func (x *ListListingsRequest) GetPageToken() string

func (*ListListingsRequest) GetParent

func (x *ListListingsRequest) GetParent() string

func (*ListListingsRequest) ProtoMessage

func (*ListListingsRequest) ProtoMessage()

func (*ListListingsRequest) ProtoReflect

func (x *ListListingsRequest) ProtoReflect() protoreflect.Message

func (*ListListingsRequest) Reset

func (x *ListListingsRequest) Reset()

func (*ListListingsRequest) String

func (x *ListListingsRequest) String() string

type ListListingsResponse

type ListListingsResponse struct {

	// The list of Listing.
	Listings []*Listing `protobuf:"bytes,1,rep,name=listings,proto3" json:"listings,omitempty"`
	// A token to request the next page of results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for response to the list of Listings.

func (*ListListingsResponse) Descriptor deprecated

func (*ListListingsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListListingsResponse.ProtoReflect.Descriptor instead.

func (*ListListingsResponse) GetListings

func (x *ListListingsResponse) GetListings() []*Listing

func (*ListListingsResponse) GetNextPageToken

func (x *ListListingsResponse) GetNextPageToken() string

func (*ListListingsResponse) ProtoMessage

func (*ListListingsResponse) ProtoMessage()

func (*ListListingsResponse) ProtoReflect

func (x *ListListingsResponse) ProtoReflect() protoreflect.Message

func (*ListListingsResponse) Reset

func (x *ListListingsResponse) Reset()

func (*ListListingsResponse) String

func (x *ListListingsResponse) String() string

type ListOrgDataExchangesRequest

type ListOrgDataExchangesRequest struct {

	// Required. The organization resource path of the projects containing
	// DataExchanges. e.g. `organizations/myorg/locations/US`.
	Organization string `protobuf:"bytes,1,opt,name=organization,proto3" json:"organization,omitempty"`
	// The maximum number of results to return in a single response page. Leverage
	// the page tokens to iterate through the entire collection.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token, returned by a previous call, to request the next page of
	// results.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting the list of data exchanges from projects in an organization and location.

func (*ListOrgDataExchangesRequest) Descriptor deprecated

func (*ListOrgDataExchangesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListOrgDataExchangesRequest.ProtoReflect.Descriptor instead.

func (*ListOrgDataExchangesRequest) GetOrganization

func (x *ListOrgDataExchangesRequest) GetOrganization() string

func (*ListOrgDataExchangesRequest) GetPageSize

func (x *ListOrgDataExchangesRequest) GetPageSize() int32

func (*ListOrgDataExchangesRequest) GetPageToken

func (x *ListOrgDataExchangesRequest) GetPageToken() string

func (*ListOrgDataExchangesRequest) ProtoMessage

func (*ListOrgDataExchangesRequest) ProtoMessage()

func (*ListOrgDataExchangesRequest) ProtoReflect

func (*ListOrgDataExchangesRequest) Reset

func (x *ListOrgDataExchangesRequest) Reset()

func (*ListOrgDataExchangesRequest) String

func (x *ListOrgDataExchangesRequest) String() string

type ListOrgDataExchangesResponse

type ListOrgDataExchangesResponse struct {

	// The list of data exchanges.
	DataExchanges []*DataExchange `protobuf:"bytes,1,rep,name=data_exchanges,json=dataExchanges,proto3" json:"data_exchanges,omitempty"`
	// A token to request the next page of results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing data exchanges in an organization and location.

func (*ListOrgDataExchangesResponse) Descriptor deprecated

func (*ListOrgDataExchangesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListOrgDataExchangesResponse.ProtoReflect.Descriptor instead.

func (*ListOrgDataExchangesResponse) GetDataExchanges

func (x *ListOrgDataExchangesResponse) GetDataExchanges() []*DataExchange

func (*ListOrgDataExchangesResponse) GetNextPageToken

func (x *ListOrgDataExchangesResponse) GetNextPageToken() string

func (*ListOrgDataExchangesResponse) ProtoMessage

func (*ListOrgDataExchangesResponse) ProtoMessage()

func (*ListOrgDataExchangesResponse) ProtoReflect

func (*ListOrgDataExchangesResponse) Reset

func (x *ListOrgDataExchangesResponse) Reset()

func (*ListOrgDataExchangesResponse) String

type ListSharedResourceSubscriptionsRequest added in v1.56.0

type ListSharedResourceSubscriptionsRequest struct {

	// Required. Resource name of the requested target. This resource may be
	// either a Listing or a DataExchange. e.g.
	// projects/123/locations/US/dataExchanges/456 OR e.g.
	// projects/123/locations/US/dataExchanges/456/listings/789
	Resource string `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// If selected, includes deleted subscriptions in the response
	// (up to 63 days after deletion).
	IncludeDeletedSubscriptions bool `` /* 145-byte string literal not displayed */
	// The maximum number of results to return in a single response page.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token, returned by a previous call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for listing subscriptions of a shared resource.

func (*ListSharedResourceSubscriptionsRequest) Descriptor deprecated added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSharedResourceSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListSharedResourceSubscriptionsRequest) GetIncludeDeletedSubscriptions added in v1.56.0

func (x *ListSharedResourceSubscriptionsRequest) GetIncludeDeletedSubscriptions() bool

func (*ListSharedResourceSubscriptionsRequest) GetPageSize added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) GetPageToken added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) GetResource added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) ProtoMessage added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) ProtoReflect added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) Reset added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) String added in v1.56.0

type ListSharedResourceSubscriptionsResponse added in v1.56.0

type ListSharedResourceSubscriptionsResponse struct {

	// The list of subscriptions.
	SharedResourceSubscriptions []*Subscription `` /* 144-byte string literal not displayed */
	// Next page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for response to the listing of shared resource subscriptions.

func (*ListSharedResourceSubscriptionsResponse) Descriptor deprecated added in v1.56.0

func (*ListSharedResourceSubscriptionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSharedResourceSubscriptionsResponse.ProtoReflect.Descriptor instead.

func (*ListSharedResourceSubscriptionsResponse) GetNextPageToken added in v1.56.0

func (x *ListSharedResourceSubscriptionsResponse) GetNextPageToken() string

func (*ListSharedResourceSubscriptionsResponse) GetSharedResourceSubscriptions added in v1.56.0

func (x *ListSharedResourceSubscriptionsResponse) GetSharedResourceSubscriptions() []*Subscription

func (*ListSharedResourceSubscriptionsResponse) ProtoMessage added in v1.56.0

func (*ListSharedResourceSubscriptionsResponse) ProtoReflect added in v1.56.0

func (*ListSharedResourceSubscriptionsResponse) Reset added in v1.56.0

func (*ListSharedResourceSubscriptionsResponse) String added in v1.56.0

type ListSubscriptionsRequest added in v1.56.0

type ListSubscriptionsRequest struct {

	// Required. The parent resource path of the subscription.
	// e.g. projects/myproject/locations/US
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The filter expression may be used to filter by Data Exchange or Listing.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The maximum number of results to return in a single response page.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token, returned by a previous call.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for listing subscriptions.

func (*ListSubscriptionsRequest) Descriptor deprecated added in v1.56.0

func (*ListSubscriptionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListSubscriptionsRequest) GetFilter added in v1.56.0

func (x *ListSubscriptionsRequest) GetFilter() string

func (*ListSubscriptionsRequest) GetPageSize added in v1.56.0

func (x *ListSubscriptionsRequest) GetPageSize() int32

func (*ListSubscriptionsRequest) GetPageToken added in v1.56.0

func (x *ListSubscriptionsRequest) GetPageToken() string

func (*ListSubscriptionsRequest) GetParent added in v1.56.0

func (x *ListSubscriptionsRequest) GetParent() string

func (*ListSubscriptionsRequest) ProtoMessage added in v1.56.0

func (*ListSubscriptionsRequest) ProtoMessage()

func (*ListSubscriptionsRequest) ProtoReflect added in v1.56.0

func (x *ListSubscriptionsRequest) ProtoReflect() protoreflect.Message

func (*ListSubscriptionsRequest) Reset added in v1.56.0

func (x *ListSubscriptionsRequest) Reset()

func (*ListSubscriptionsRequest) String added in v1.56.0

func (x *ListSubscriptionsRequest) String() string

type ListSubscriptionsResponse added in v1.56.0

type ListSubscriptionsResponse struct {

	// The list of subscriptions.
	Subscriptions []*Subscription `protobuf:"bytes,1,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
	// Next page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for response to the listing of subscriptions.

func (*ListSubscriptionsResponse) Descriptor deprecated added in v1.56.0

func (*ListSubscriptionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSubscriptionsResponse.ProtoReflect.Descriptor instead.

func (*ListSubscriptionsResponse) GetNextPageToken added in v1.56.0

func (x *ListSubscriptionsResponse) GetNextPageToken() string

func (*ListSubscriptionsResponse) GetSubscriptions added in v1.56.0

func (x *ListSubscriptionsResponse) GetSubscriptions() []*Subscription

func (*ListSubscriptionsResponse) ProtoMessage added in v1.56.0

func (*ListSubscriptionsResponse) ProtoMessage()

func (*ListSubscriptionsResponse) ProtoReflect added in v1.56.0

func (*ListSubscriptionsResponse) Reset added in v1.56.0

func (x *ListSubscriptionsResponse) Reset()

func (*ListSubscriptionsResponse) String added in v1.56.0

func (x *ListSubscriptionsResponse) String() string

type Listing

type Listing struct {

	// Listing source.
	//
	// Types that are assignable to Source:
	//
	//	*Listing_BigqueryDataset
	Source isListing_Source `protobuf_oneof:"source"`
	// Output only. The resource name of the listing.
	// e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Human-readable display name of the listing. The display name must
	// contain only Unicode letters, numbers (0-9), underscores (_), dashes (-),
	// spaces ( ), ampersands (&) and can't start or end with spaces. Default
	// value is an empty string. Max length: 63 bytes.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. Short description of the listing. The description must not
	// contain Unicode non-characters and C0 and C1 control codes except tabs
	// (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default
	// value is an empty string. Max length: 2000 bytes.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Email or URL of the primary point of contact of the listing.
	// Max Length: 1000 bytes.
	PrimaryContact string `protobuf:"bytes,4,opt,name=primary_contact,json=primaryContact,proto3" json:"primary_contact,omitempty"`
	// Optional. Documentation describing the listing.
	Documentation string `protobuf:"bytes,5,opt,name=documentation,proto3" json:"documentation,omitempty"`
	// Output only. Current state of the listing.
	State Listing_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.bigquery.analyticshub.v1.Listing_State" json:"state,omitempty"`
	// Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB
	// Expected image dimensions are 512x512 pixels, however the API only
	// performs validation on size of the encoded data.
	// Note: For byte fields, the contents of the field are base64-encoded (which
	// increases the size of the data by 33-36%) when using JSON on the wire.
	Icon []byte `protobuf:"bytes,8,opt,name=icon,proto3" json:"icon,omitempty"`
	// Optional. Details of the data provider who owns the source data.
	DataProvider *DataProvider `protobuf:"bytes,9,opt,name=data_provider,json=dataProvider,proto3" json:"data_provider,omitempty"`
	// Optional. Categories of the listing. Up to two categories are allowed.
	Categories []Listing_Category `` /* 142-byte string literal not displayed */
	// Optional. Details of the publisher who owns the listing and who can share
	// the source data.
	Publisher *Publisher `protobuf:"bytes,11,opt,name=publisher,proto3" json:"publisher,omitempty"`
	// Optional. Email or URL of the request access of the listing.
	// Subscribers can use this reference to request access.
	// Max Length: 1000 bytes.
	RequestAccess string `protobuf:"bytes,12,opt,name=request_access,json=requestAccess,proto3" json:"request_access,omitempty"`
	// Optional. If set, restricted export configuration will be propagated and
	// enforced on the linked dataset.
	RestrictedExportConfig *Listing_RestrictedExportConfig `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.

func (*Listing) Descriptor deprecated

func (*Listing) Descriptor() ([]byte, []int)

Deprecated: Use Listing.ProtoReflect.Descriptor instead.

func (*Listing) GetBigqueryDataset

func (x *Listing) GetBigqueryDataset() *Listing_BigQueryDatasetSource

func (*Listing) GetCategories

func (x *Listing) GetCategories() []Listing_Category

func (*Listing) GetDataProvider

func (x *Listing) GetDataProvider() *DataProvider

func (*Listing) GetDescription

func (x *Listing) GetDescription() string

func (*Listing) GetDisplayName

func (x *Listing) GetDisplayName() string

func (*Listing) GetDocumentation

func (x *Listing) GetDocumentation() string

func (*Listing) GetIcon

func (x *Listing) GetIcon() []byte

func (*Listing) GetName

func (x *Listing) GetName() string

func (*Listing) GetPrimaryContact

func (x *Listing) GetPrimaryContact() string

func (*Listing) GetPublisher

func (x *Listing) GetPublisher() *Publisher

func (*Listing) GetRequestAccess

func (x *Listing) GetRequestAccess() string

func (*Listing) GetRestrictedExportConfig added in v1.56.0

func (x *Listing) GetRestrictedExportConfig() *Listing_RestrictedExportConfig

func (*Listing) GetSource

func (m *Listing) GetSource() isListing_Source

func (*Listing) GetState

func (x *Listing) GetState() Listing_State

func (*Listing) ProtoMessage

func (*Listing) ProtoMessage()

func (*Listing) ProtoReflect

func (x *Listing) ProtoReflect() protoreflect.Message

func (*Listing) Reset

func (x *Listing) Reset()

func (*Listing) String

func (x *Listing) String() string

type Listing_BigQueryDatasetSource

type Listing_BigQueryDatasetSource struct {

	// Resource name of the dataset source for this listing.
	// e.g. `projects/myproject/datasets/123`
	Dataset string `protobuf:"bytes,1,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Optional. Resources in this dataset that are selectively shared.
	// If this field is empty, then the entire dataset (all resources) are
	// shared. This field is only valid for data clean room exchanges.
	SelectedResources []*Listing_BigQueryDatasetSource_SelectedResource `protobuf:"bytes,2,rep,name=selected_resources,json=selectedResources,proto3" json:"selected_resources,omitempty"`
	// contains filtered or unexported fields
}

A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset.

func (*Listing_BigQueryDatasetSource) Descriptor deprecated

func (*Listing_BigQueryDatasetSource) Descriptor() ([]byte, []int)

Deprecated: Use Listing_BigQueryDatasetSource.ProtoReflect.Descriptor instead.

func (*Listing_BigQueryDatasetSource) GetDataset

func (x *Listing_BigQueryDatasetSource) GetDataset() string

func (*Listing_BigQueryDatasetSource) GetSelectedResources added in v1.60.0

func (*Listing_BigQueryDatasetSource) ProtoMessage

func (*Listing_BigQueryDatasetSource) ProtoMessage()

func (*Listing_BigQueryDatasetSource) ProtoReflect

func (*Listing_BigQueryDatasetSource) Reset

func (x *Listing_BigQueryDatasetSource) Reset()

func (*Listing_BigQueryDatasetSource) String

type Listing_BigQueryDatasetSource_SelectedResource added in v1.60.0

type Listing_BigQueryDatasetSource_SelectedResource struct {

	// Types that are assignable to Resource:
	//
	//	*Listing_BigQueryDatasetSource_SelectedResource_Table
	Resource isListing_BigQueryDatasetSource_SelectedResource_Resource `protobuf_oneof:"resource"`
	// contains filtered or unexported fields
}

Resource in this dataset that are selectively shared.

func (*Listing_BigQueryDatasetSource_SelectedResource) Descriptor deprecated added in v1.60.0

Deprecated: Use Listing_BigQueryDatasetSource_SelectedResource.ProtoReflect.Descriptor instead.

func (*Listing_BigQueryDatasetSource_SelectedResource) GetResource added in v1.60.0

func (m *Listing_BigQueryDatasetSource_SelectedResource) GetResource() isListing_BigQueryDatasetSource_SelectedResource_Resource

func (*Listing_BigQueryDatasetSource_SelectedResource) GetTable added in v1.60.0

func (*Listing_BigQueryDatasetSource_SelectedResource) ProtoMessage added in v1.60.0

func (*Listing_BigQueryDatasetSource_SelectedResource) ProtoReflect added in v1.60.0

func (*Listing_BigQueryDatasetSource_SelectedResource) Reset added in v1.60.0

func (*Listing_BigQueryDatasetSource_SelectedResource) String added in v1.60.0

type Listing_BigQueryDatasetSource_SelectedResource_Table added in v1.60.0

type Listing_BigQueryDatasetSource_SelectedResource_Table struct {
	// Optional. Format:
	// For table:
	// `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
	// Example:"projects/test_project/datasets/test_dataset/tables/test_table"
	Table string `protobuf:"bytes,1,opt,name=table,proto3,oneof"`
}

type Listing_BigqueryDataset

type Listing_BigqueryDataset struct {
	// Required. Shared dataset i.e. BigQuery dataset source.
	BigqueryDataset *Listing_BigQueryDatasetSource `protobuf:"bytes,6,opt,name=bigquery_dataset,json=bigqueryDataset,proto3,oneof"`
}

type Listing_Category

type Listing_Category int32

Listing categories.

const (
	Listing_CATEGORY_UNSPECIFIED                  Listing_Category = 0
	Listing_CATEGORY_OTHERS                       Listing_Category = 1
	Listing_CATEGORY_ADVERTISING_AND_MARKETING    Listing_Category = 2
	Listing_CATEGORY_COMMERCE                     Listing_Category = 3
	Listing_CATEGORY_CLIMATE_AND_ENVIRONMENT      Listing_Category = 4
	Listing_CATEGORY_DEMOGRAPHICS                 Listing_Category = 5
	Listing_CATEGORY_ECONOMICS                    Listing_Category = 6
	Listing_CATEGORY_EDUCATION                    Listing_Category = 7
	Listing_CATEGORY_ENERGY                       Listing_Category = 8
	Listing_CATEGORY_FINANCIAL                    Listing_Category = 9
	Listing_CATEGORY_GAMING                       Listing_Category = 10
	Listing_CATEGORY_GEOSPATIAL                   Listing_Category = 11
	Listing_CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE  Listing_Category = 12
	Listing_CATEGORY_MEDIA                        Listing_Category = 13
	Listing_CATEGORY_PUBLIC_SECTOR                Listing_Category = 14
	Listing_CATEGORY_RETAIL                       Listing_Category = 15
	Listing_CATEGORY_SPORTS                       Listing_Category = 16
	Listing_CATEGORY_SCIENCE_AND_RESEARCH         Listing_Category = 17
	Listing_CATEGORY_TRANSPORTATION_AND_LOGISTICS Listing_Category = 18
	Listing_CATEGORY_TRAVEL_AND_TOURISM           Listing_Category = 19
)

func (Listing_Category) Descriptor

func (Listing_Category) Enum

func (Listing_Category) EnumDescriptor deprecated

func (Listing_Category) EnumDescriptor() ([]byte, []int)

Deprecated: Use Listing_Category.Descriptor instead.

func (Listing_Category) Number

func (Listing_Category) String

func (x Listing_Category) String() string

func (Listing_Category) Type

type Listing_RestrictedExportConfig added in v1.56.0

type Listing_RestrictedExportConfig struct {

	// Optional. If true, enable restricted export.
	Enabled bool `protobuf:"varint,3,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Output only. If true, restrict direct table access(read
	// api/tabledata.list) on linked table.
	RestrictDirectTableAccess bool `` /* 141-byte string literal not displayed */
	// Optional. If true, restrict export of query result derived from
	// restricted linked dataset table.
	RestrictQueryResult bool `protobuf:"varint,2,opt,name=restrict_query_result,json=restrictQueryResult,proto3" json:"restrict_query_result,omitempty"`
	// contains filtered or unexported fields
}

Restricted export config, used to configure restricted export on linked dataset.

func (*Listing_RestrictedExportConfig) Descriptor deprecated added in v1.56.0

func (*Listing_RestrictedExportConfig) Descriptor() ([]byte, []int)

Deprecated: Use Listing_RestrictedExportConfig.ProtoReflect.Descriptor instead.

func (*Listing_RestrictedExportConfig) GetEnabled added in v1.56.0

func (x *Listing_RestrictedExportConfig) GetEnabled() bool

func (*Listing_RestrictedExportConfig) GetRestrictDirectTableAccess added in v1.56.0

func (x *Listing_RestrictedExportConfig) GetRestrictDirectTableAccess() bool

func (*Listing_RestrictedExportConfig) GetRestrictQueryResult added in v1.56.0

func (x *Listing_RestrictedExportConfig) GetRestrictQueryResult() bool

func (*Listing_RestrictedExportConfig) ProtoMessage added in v1.56.0

func (*Listing_RestrictedExportConfig) ProtoMessage()

func (*Listing_RestrictedExportConfig) ProtoReflect added in v1.56.0

func (*Listing_RestrictedExportConfig) Reset added in v1.56.0

func (x *Listing_RestrictedExportConfig) Reset()

func (*Listing_RestrictedExportConfig) String added in v1.56.0

type Listing_State

type Listing_State int32

State of the listing.

const (
	// Default value. This value is unused.
	Listing_STATE_UNSPECIFIED Listing_State = 0
	// Subscribable state. Users with dataexchange.listings.subscribe permission
	// can subscribe to this listing.
	Listing_ACTIVE Listing_State = 1
)

func (Listing_State) Descriptor

func (Listing_State) Enum

func (x Listing_State) Enum() *Listing_State

func (Listing_State) EnumDescriptor deprecated

func (Listing_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Listing_State.Descriptor instead.

func (Listing_State) Number

func (Listing_State) String

func (x Listing_State) String() string

func (Listing_State) Type

type OperationMetadata added in v1.56.0

type OperationMetadata struct {

	// Output only. The time the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time the operation finished running.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Server-defined resource path for the target of the operation.
	Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// Output only. Name of the verb executed by the operation.
	Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
	// Output only. Human-readable status of the operation, if any.
	StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
	// Output only. Identifies whether the user has requested cancellation
	// of the operation. Operations that have successfully been cancelled
	// have [Operation.error][] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
	// `Code.CANCELLED`.
	RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
	// Output only. API version used to start the operation.
	ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// contains filtered or unexported fields
}

Represents the metadata of a long-running operation in Analytics Hub.

func (*OperationMetadata) Descriptor deprecated added in v1.56.0

func (*OperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion added in v1.56.0

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetCreateTime added in v1.56.0

func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*OperationMetadata) GetEndTime added in v1.56.0

func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*OperationMetadata) GetRequestedCancellation added in v1.56.0

func (x *OperationMetadata) GetRequestedCancellation() bool

func (*OperationMetadata) GetStatusMessage added in v1.56.0

func (x *OperationMetadata) GetStatusMessage() string

func (*OperationMetadata) GetTarget added in v1.56.0

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb added in v1.56.0

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage added in v1.56.0

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect added in v1.56.0

func (x *OperationMetadata) ProtoReflect() protoreflect.Message

func (*OperationMetadata) Reset added in v1.56.0

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String added in v1.56.0

func (x *OperationMetadata) String() string

type Publisher

type Publisher struct {

	// Optional. Name of the listing publisher.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Email or URL of the listing publisher.
	// Max Length: 1000 bytes.
	PrimaryContact string `protobuf:"bytes,2,opt,name=primary_contact,json=primaryContact,proto3" json:"primary_contact,omitempty"`
	// contains filtered or unexported fields
}

Contains details of the listing publisher.

func (*Publisher) Descriptor deprecated

func (*Publisher) Descriptor() ([]byte, []int)

Deprecated: Use Publisher.ProtoReflect.Descriptor instead.

func (*Publisher) GetName

func (x *Publisher) GetName() string

func (*Publisher) GetPrimaryContact

func (x *Publisher) GetPrimaryContact() string

func (*Publisher) ProtoMessage

func (*Publisher) ProtoMessage()

func (*Publisher) ProtoReflect

func (x *Publisher) ProtoReflect() protoreflect.Message

func (*Publisher) Reset

func (x *Publisher) Reset()

func (*Publisher) String

func (x *Publisher) String() string

type RefreshSubscriptionRequest added in v1.56.0

type RefreshSubscriptionRequest struct {

	// Required. Resource name of the Subscription to refresh.
	// e.g. `projects/subscriberproject/locations/US/subscriptions/123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for refreshing a subscription.

func (*RefreshSubscriptionRequest) Descriptor deprecated added in v1.56.0

func (*RefreshSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use RefreshSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*RefreshSubscriptionRequest) GetName added in v1.56.0

func (x *RefreshSubscriptionRequest) GetName() string

func (*RefreshSubscriptionRequest) ProtoMessage added in v1.56.0

func (*RefreshSubscriptionRequest) ProtoMessage()

func (*RefreshSubscriptionRequest) ProtoReflect added in v1.56.0

func (*RefreshSubscriptionRequest) Reset added in v1.56.0

func (x *RefreshSubscriptionRequest) Reset()

func (*RefreshSubscriptionRequest) String added in v1.56.0

func (x *RefreshSubscriptionRequest) String() string

type RefreshSubscriptionResponse added in v1.56.0

type RefreshSubscriptionResponse struct {

	// The refreshed subscription resource.
	Subscription *Subscription `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
	// contains filtered or unexported fields
}

Message for response when you refresh a subscription.

func (*RefreshSubscriptionResponse) Descriptor deprecated added in v1.56.0

func (*RefreshSubscriptionResponse) Descriptor() ([]byte, []int)

Deprecated: Use RefreshSubscriptionResponse.ProtoReflect.Descriptor instead.

func (*RefreshSubscriptionResponse) GetSubscription added in v1.56.0

func (x *RefreshSubscriptionResponse) GetSubscription() *Subscription

func (*RefreshSubscriptionResponse) ProtoMessage added in v1.56.0

func (*RefreshSubscriptionResponse) ProtoMessage()

func (*RefreshSubscriptionResponse) ProtoReflect added in v1.56.0

func (*RefreshSubscriptionResponse) Reset added in v1.56.0

func (x *RefreshSubscriptionResponse) Reset()

func (*RefreshSubscriptionResponse) String added in v1.56.0

func (x *RefreshSubscriptionResponse) String() string

type RevokeSubscriptionRequest added in v1.56.0

type RevokeSubscriptionRequest struct {

	// Required. Resource name of the subscription to revoke.
	// e.g. projects/123/locations/US/subscriptions/456
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for revoking a subscription.

func (*RevokeSubscriptionRequest) Descriptor deprecated added in v1.56.0

func (*RevokeSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use RevokeSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*RevokeSubscriptionRequest) GetName added in v1.56.0

func (x *RevokeSubscriptionRequest) GetName() string

func (*RevokeSubscriptionRequest) ProtoMessage added in v1.56.0

func (*RevokeSubscriptionRequest) ProtoMessage()

func (*RevokeSubscriptionRequest) ProtoReflect added in v1.56.0

func (*RevokeSubscriptionRequest) Reset added in v1.56.0

func (x *RevokeSubscriptionRequest) Reset()

func (*RevokeSubscriptionRequest) String added in v1.56.0

func (x *RevokeSubscriptionRequest) String() string

type RevokeSubscriptionResponse added in v1.56.0

type RevokeSubscriptionResponse struct {
	// contains filtered or unexported fields
}

Message for response when you revoke a subscription.

func (*RevokeSubscriptionResponse) Descriptor deprecated added in v1.56.0

func (*RevokeSubscriptionResponse) Descriptor() ([]byte, []int)

Deprecated: Use RevokeSubscriptionResponse.ProtoReflect.Descriptor instead.

func (*RevokeSubscriptionResponse) ProtoMessage added in v1.56.0

func (*RevokeSubscriptionResponse) ProtoMessage()

func (*RevokeSubscriptionResponse) ProtoReflect added in v1.56.0

func (*RevokeSubscriptionResponse) Reset added in v1.56.0

func (x *RevokeSubscriptionResponse) Reset()

func (*RevokeSubscriptionResponse) String added in v1.56.0

func (x *RevokeSubscriptionResponse) String() string

type SharingEnvironmentConfig added in v1.56.0

type SharingEnvironmentConfig struct {

	// Types that are assignable to Environment:
	//
	//	*SharingEnvironmentConfig_DefaultExchangeConfig_
	//	*SharingEnvironmentConfig_DcrExchangeConfig_
	Environment isSharingEnvironmentConfig_Environment `protobuf_oneof:"environment"`
	// contains filtered or unexported fields
}

Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange.

func (*SharingEnvironmentConfig) Descriptor deprecated added in v1.56.0

func (*SharingEnvironmentConfig) Descriptor() ([]byte, []int)

Deprecated: Use SharingEnvironmentConfig.ProtoReflect.Descriptor instead.

func (*SharingEnvironmentConfig) GetDcrExchangeConfig added in v1.56.0

func (*SharingEnvironmentConfig) GetDefaultExchangeConfig added in v1.56.0

func (*SharingEnvironmentConfig) GetEnvironment added in v1.56.0

func (m *SharingEnvironmentConfig) GetEnvironment() isSharingEnvironmentConfig_Environment

func (*SharingEnvironmentConfig) ProtoMessage added in v1.56.0

func (*SharingEnvironmentConfig) ProtoMessage()

func (*SharingEnvironmentConfig) ProtoReflect added in v1.56.0

func (x *SharingEnvironmentConfig) ProtoReflect() protoreflect.Message

func (*SharingEnvironmentConfig) Reset added in v1.56.0

func (x *SharingEnvironmentConfig) Reset()

func (*SharingEnvironmentConfig) String added in v1.56.0

func (x *SharingEnvironmentConfig) String() string

type SharingEnvironmentConfig_DcrExchangeConfig added in v1.56.0

type SharingEnvironmentConfig_DcrExchangeConfig struct {

	// Output only. If True, this DCR restricts the contributors to sharing
	// only a single resource in a Listing. And no two resources should have the
	// same IDs. So if a contributor adds a view with a conflicting name, the
	// CreateListing API will reject the request. if False, the data contributor
	// can publish an entire dataset (as before). This is not configurable, and
	// by default, all new DCRs will have the restriction set to True.
	SingleSelectedResourceSharingRestriction *bool `` /* 194-byte string literal not displayed */
	// Output only. If True, when subscribing to this DCR, it will create only
	// one linked dataset containing all resources shared within the
	// cleanroom. If False, when subscribing to this DCR, it will
	// create 1 linked dataset per listing. This is not configurable, and by
	// default, all new DCRs will have the restriction set to True.
	SingleLinkedDatasetPerCleanroom *bool `` /* 167-byte string literal not displayed */
	// contains filtered or unexported fields
}

Data Clean Room (DCR), used for privacy-safe and secured data sharing.

func (*SharingEnvironmentConfig_DcrExchangeConfig) Descriptor deprecated added in v1.56.0

Deprecated: Use SharingEnvironmentConfig_DcrExchangeConfig.ProtoReflect.Descriptor instead.

func (*SharingEnvironmentConfig_DcrExchangeConfig) GetSingleLinkedDatasetPerCleanroom added in v1.60.0

func (x *SharingEnvironmentConfig_DcrExchangeConfig) GetSingleLinkedDatasetPerCleanroom() bool

func (*SharingEnvironmentConfig_DcrExchangeConfig) GetSingleSelectedResourceSharingRestriction added in v1.60.0

func (x *SharingEnvironmentConfig_DcrExchangeConfig) GetSingleSelectedResourceSharingRestriction() bool

func (*SharingEnvironmentConfig_DcrExchangeConfig) ProtoMessage added in v1.56.0

func (*SharingEnvironmentConfig_DcrExchangeConfig) ProtoReflect added in v1.56.0

func (*SharingEnvironmentConfig_DcrExchangeConfig) Reset added in v1.56.0

func (*SharingEnvironmentConfig_DcrExchangeConfig) String added in v1.56.0

type SharingEnvironmentConfig_DcrExchangeConfig_ added in v1.56.0

type SharingEnvironmentConfig_DcrExchangeConfig_ struct {
	// Data Clean Room (DCR), used for privacy-safe and secured data sharing.
	DcrExchangeConfig *SharingEnvironmentConfig_DcrExchangeConfig `protobuf:"bytes,2,opt,name=dcr_exchange_config,json=dcrExchangeConfig,proto3,oneof"`
}

type SharingEnvironmentConfig_DefaultExchangeConfig added in v1.56.0

type SharingEnvironmentConfig_DefaultExchangeConfig struct {
	// contains filtered or unexported fields
}

Default Analytics Hub data exchange, used for secured data sharing.

func (*SharingEnvironmentConfig_DefaultExchangeConfig) Descriptor deprecated added in v1.56.0

Deprecated: Use SharingEnvironmentConfig_DefaultExchangeConfig.ProtoReflect.Descriptor instead.

func (*SharingEnvironmentConfig_DefaultExchangeConfig) ProtoMessage added in v1.56.0

func (*SharingEnvironmentConfig_DefaultExchangeConfig) ProtoReflect added in v1.56.0

func (*SharingEnvironmentConfig_DefaultExchangeConfig) Reset added in v1.56.0

func (*SharingEnvironmentConfig_DefaultExchangeConfig) String added in v1.56.0

type SharingEnvironmentConfig_DefaultExchangeConfig_ added in v1.56.0

type SharingEnvironmentConfig_DefaultExchangeConfig_ struct {
	// Default Analytics Hub data exchange, used for secured data sharing.
	DefaultExchangeConfig *SharingEnvironmentConfig_DefaultExchangeConfig `protobuf:"bytes,1,opt,name=default_exchange_config,json=defaultExchangeConfig,proto3,oneof"`
}

type SubscribeDataExchangeRequest added in v1.56.0

type SubscribeDataExchangeRequest struct {

	// Required. Resource name of the Data Exchange.
	// e.g. `projects/publisherproject/locations/US/dataExchanges/123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The parent resource path of the Subscription.
	// e.g. `projects/subscriberproject/locations/US`
	Destination string `protobuf:"bytes,2,opt,name=destination,proto3" json:"destination,omitempty"`
	// Required. Name of the subscription to create.
	// e.g. `subscription1`
	Subscription string `protobuf:"bytes,4,opt,name=subscription,proto3" json:"subscription,omitempty"`
	// Email of the subscriber.
	SubscriberContact string `protobuf:"bytes,3,opt,name=subscriber_contact,json=subscriberContact,proto3" json:"subscriber_contact,omitempty"`
	// contains filtered or unexported fields
}

Message for subscribing to a Data Exchange.

func (*SubscribeDataExchangeRequest) Descriptor deprecated added in v1.56.0

func (*SubscribeDataExchangeRequest) Descriptor() ([]byte, []int)

Deprecated: Use SubscribeDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*SubscribeDataExchangeRequest) GetDestination added in v1.56.0

func (x *SubscribeDataExchangeRequest) GetDestination() string

func (*SubscribeDataExchangeRequest) GetName added in v1.56.0

func (x *SubscribeDataExchangeRequest) GetName() string

func (*SubscribeDataExchangeRequest) GetSubscriberContact added in v1.56.0

func (x *SubscribeDataExchangeRequest) GetSubscriberContact() string

func (*SubscribeDataExchangeRequest) GetSubscription added in v1.56.0

func (x *SubscribeDataExchangeRequest) GetSubscription() string

func (*SubscribeDataExchangeRequest) ProtoMessage added in v1.56.0

func (*SubscribeDataExchangeRequest) ProtoMessage()

func (*SubscribeDataExchangeRequest) ProtoReflect added in v1.56.0

func (*SubscribeDataExchangeRequest) Reset added in v1.56.0

func (x *SubscribeDataExchangeRequest) Reset()

func (*SubscribeDataExchangeRequest) String added in v1.56.0

type SubscribeDataExchangeResponse added in v1.56.0

type SubscribeDataExchangeResponse struct {

	// Subscription object created from this subscribe action.
	Subscription *Subscription `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
	// contains filtered or unexported fields
}

Message for response when you subscribe to a Data Exchange.

func (*SubscribeDataExchangeResponse) Descriptor deprecated added in v1.56.0

func (*SubscribeDataExchangeResponse) Descriptor() ([]byte, []int)

Deprecated: Use SubscribeDataExchangeResponse.ProtoReflect.Descriptor instead.

func (*SubscribeDataExchangeResponse) GetSubscription added in v1.56.0

func (x *SubscribeDataExchangeResponse) GetSubscription() *Subscription

func (*SubscribeDataExchangeResponse) ProtoMessage added in v1.56.0

func (*SubscribeDataExchangeResponse) ProtoMessage()

func (*SubscribeDataExchangeResponse) ProtoReflect added in v1.56.0

func (*SubscribeDataExchangeResponse) Reset added in v1.56.0

func (x *SubscribeDataExchangeResponse) Reset()

func (*SubscribeDataExchangeResponse) String added in v1.56.0

type SubscribeListingRequest

type SubscribeListingRequest struct {

	// Resulting destination of the listing that you subscribed to.
	//
	// Types that are assignable to Destination:
	//
	//	*SubscribeListingRequest_DestinationDataset
	Destination isSubscribeListingRequest_Destination `protobuf_oneof:"destination"`
	// Required. Resource name of the listing that you want to subscribe to.
	// e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for subscribing to a listing.

func (*SubscribeListingRequest) Descriptor deprecated

func (*SubscribeListingRequest) Descriptor() ([]byte, []int)

Deprecated: Use SubscribeListingRequest.ProtoReflect.Descriptor instead.

func (*SubscribeListingRequest) GetDestination

func (m *SubscribeListingRequest) GetDestination() isSubscribeListingRequest_Destination

func (*SubscribeListingRequest) GetDestinationDataset

func (x *SubscribeListingRequest) GetDestinationDataset() *DestinationDataset

func (*SubscribeListingRequest) GetName

func (x *SubscribeListingRequest) GetName() string

func (*SubscribeListingRequest) ProtoMessage

func (*SubscribeListingRequest) ProtoMessage()

func (*SubscribeListingRequest) ProtoReflect

func (x *SubscribeListingRequest) ProtoReflect() protoreflect.Message

func (*SubscribeListingRequest) Reset

func (x *SubscribeListingRequest) Reset()

func (*SubscribeListingRequest) String

func (x *SubscribeListingRequest) String() string

type SubscribeListingRequest_DestinationDataset

type SubscribeListingRequest_DestinationDataset struct {
	// BigQuery destination dataset to create for the subscriber.
	DestinationDataset *DestinationDataset `protobuf:"bytes,3,opt,name=destination_dataset,json=destinationDataset,proto3,oneof"`
}

type SubscribeListingResponse

type SubscribeListingResponse struct {

	// Subscription object created from this subscribe action.
	Subscription *Subscription `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
	// contains filtered or unexported fields
}

Message for response when you subscribe to a listing.

func (*SubscribeListingResponse) Descriptor deprecated

func (*SubscribeListingResponse) Descriptor() ([]byte, []int)

Deprecated: Use SubscribeListingResponse.ProtoReflect.Descriptor instead.

func (*SubscribeListingResponse) GetSubscription added in v1.56.0

func (x *SubscribeListingResponse) GetSubscription() *Subscription

func (*SubscribeListingResponse) ProtoMessage

func (*SubscribeListingResponse) ProtoMessage()

func (*SubscribeListingResponse) ProtoReflect

func (x *SubscribeListingResponse) ProtoReflect() protoreflect.Message

func (*SubscribeListingResponse) Reset

func (x *SubscribeListingResponse) Reset()

func (*SubscribeListingResponse) String

func (x *SubscribeListingResponse) String() string

type Subscription added in v1.56.0

type Subscription struct {

	// Types that are assignable to ResourceName:
	//
	//	*Subscription_Listing
	//	*Subscription_DataExchange
	ResourceName isSubscription_ResourceName `protobuf_oneof:"resource_name"`
	// Output only. The resource name of the subscription.
	// e.g. `projects/myproject/locations/US/subscriptions/123`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Timestamp when the subscription was created.
	CreationTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=creation_time,json=creationTime,proto3" json:"creation_time,omitempty"`
	// Output only. Timestamp when the subscription was last modified.
	LastModifyTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=last_modify_time,json=lastModifyTime,proto3" json:"last_modify_time,omitempty"`
	// Output only. Organization of the project this subscription belongs to.
	OrganizationId string `protobuf:"bytes,4,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Output only. Display name of the project of this subscription.
	OrganizationDisplayName string `` /* 133-byte string literal not displayed */
	// Output only. Current state of the subscription.
	State Subscription_State `` /* 126-byte string literal not displayed */
	// Output only. Map of listing resource names to associated linked resource,
	// e.g. projects/123/locations/US/dataExchanges/456/listings/789
	// ->
	// projects/123/datasets/my_dataset
	//
	// For listing-level subscriptions, this is a map of size 1.
	// Only contains values if state == STATE_ACTIVE.
	LinkedDatasetMap map[string]*Subscription_LinkedResource `` /* 199-byte string literal not displayed */
	// Output only. Email of the subscriber.
	SubscriberContact string `protobuf:"bytes,9,opt,name=subscriber_contact,json=subscriberContact,proto3" json:"subscriber_contact,omitempty"`
	// contains filtered or unexported fields
}

A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.

func (*Subscription) Descriptor deprecated added in v1.56.0

func (*Subscription) Descriptor() ([]byte, []int)

Deprecated: Use Subscription.ProtoReflect.Descriptor instead.

func (*Subscription) GetCreationTime added in v1.56.0

func (x *Subscription) GetCreationTime() *timestamppb.Timestamp

func (*Subscription) GetDataExchange added in v1.56.0

func (x *Subscription) GetDataExchange() string

func (*Subscription) GetLastModifyTime added in v1.56.0

func (x *Subscription) GetLastModifyTime() *timestamppb.Timestamp

func (*Subscription) GetLinkedDatasetMap added in v1.56.0

func (x *Subscription) GetLinkedDatasetMap() map[string]*Subscription_LinkedResource

func (*Subscription) GetListing added in v1.56.0

func (x *Subscription) GetListing() string

func (*Subscription) GetName added in v1.56.0

func (x *Subscription) GetName() string

func (*Subscription) GetOrganizationDisplayName added in v1.56.0

func (x *Subscription) GetOrganizationDisplayName() string

func (*Subscription) GetOrganizationId added in v1.56.0

func (x *Subscription) GetOrganizationId() string

func (*Subscription) GetResourceName added in v1.56.0

func (m *Subscription) GetResourceName() isSubscription_ResourceName

func (*Subscription) GetState added in v1.56.0

func (x *Subscription) GetState() Subscription_State

func (*Subscription) GetSubscriberContact added in v1.56.0

func (x *Subscription) GetSubscriberContact() string

func (*Subscription) ProtoMessage added in v1.56.0

func (*Subscription) ProtoMessage()

func (*Subscription) ProtoReflect added in v1.56.0

func (x *Subscription) ProtoReflect() protoreflect.Message

func (*Subscription) Reset added in v1.56.0

func (x *Subscription) Reset()

func (*Subscription) String added in v1.56.0

func (x *Subscription) String() string

type Subscription_DataExchange added in v1.56.0

type Subscription_DataExchange struct {
	// Output only. Resource name of the source Data Exchange.
	// e.g. projects/123/locations/US/dataExchanges/456
	DataExchange string `protobuf:"bytes,6,opt,name=data_exchange,json=dataExchange,proto3,oneof"`
}

type Subscription_LinkedResource added in v1.56.0

type Subscription_LinkedResource struct {

	// Types that are assignable to Reference:
	//
	//	*Subscription_LinkedResource_LinkedDataset
	Reference isSubscription_LinkedResource_Reference `protobuf_oneof:"reference"`
	// contains filtered or unexported fields
}

Reference to a linked resource tracked by this Subscription.

func (*Subscription_LinkedResource) Descriptor deprecated added in v1.56.0

func (*Subscription_LinkedResource) Descriptor() ([]byte, []int)

Deprecated: Use Subscription_LinkedResource.ProtoReflect.Descriptor instead.

func (*Subscription_LinkedResource) GetLinkedDataset added in v1.56.0

func (x *Subscription_LinkedResource) GetLinkedDataset() string

func (*Subscription_LinkedResource) GetReference added in v1.56.0

func (m *Subscription_LinkedResource) GetReference() isSubscription_LinkedResource_Reference

func (*Subscription_LinkedResource) ProtoMessage added in v1.56.0

func (*Subscription_LinkedResource) ProtoMessage()

func (*Subscription_LinkedResource) ProtoReflect added in v1.56.0

func (*Subscription_LinkedResource) Reset added in v1.56.0

func (x *Subscription_LinkedResource) Reset()

func (*Subscription_LinkedResource) String added in v1.56.0

func (x *Subscription_LinkedResource) String() string

type Subscription_LinkedResource_LinkedDataset added in v1.56.0

type Subscription_LinkedResource_LinkedDataset struct {
	// Output only. Name of the linked dataset, e.g.
	// projects/subscriberproject/datasets/linked_dataset
	LinkedDataset string `protobuf:"bytes,1,opt,name=linked_dataset,json=linkedDataset,proto3,oneof"`
}

type Subscription_Listing added in v1.56.0

type Subscription_Listing struct {
	// Output only. Resource name of the source Listing.
	// e.g. projects/123/locations/US/dataExchanges/456/listings/789
	Listing string `protobuf:"bytes,5,opt,name=listing,proto3,oneof"`
}

type Subscription_State added in v1.56.0

type Subscription_State int32

State of the subscription.

const (
	// Default value. This value is unused.
	Subscription_STATE_UNSPECIFIED Subscription_State = 0
	// This subscription is active and the data is accessible.
	Subscription_STATE_ACTIVE Subscription_State = 1
	// The data referenced by this subscription is out of date and should be
	// refreshed. This can happen when a data provider adds or removes datasets.
	Subscription_STATE_STALE Subscription_State = 2
	// This subscription has been cancelled or revoked and the data is no longer
	// accessible.
	Subscription_STATE_INACTIVE Subscription_State = 3
)

func (Subscription_State) Descriptor added in v1.56.0

func (Subscription_State) Enum added in v1.56.0

func (Subscription_State) EnumDescriptor deprecated added in v1.56.0

func (Subscription_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Subscription_State.Descriptor instead.

func (Subscription_State) Number added in v1.56.0

func (Subscription_State) String added in v1.56.0

func (x Subscription_State) String() string

func (Subscription_State) Type added in v1.56.0

type UnimplementedAnalyticsHubServiceServer

type UnimplementedAnalyticsHubServiceServer struct {
}

UnimplementedAnalyticsHubServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedAnalyticsHubServiceServer) CreateDataExchange

func (*UnimplementedAnalyticsHubServiceServer) CreateListing

func (*UnimplementedAnalyticsHubServiceServer) DeleteDataExchange

func (*UnimplementedAnalyticsHubServiceServer) DeleteListing

func (*UnimplementedAnalyticsHubServiceServer) DeleteSubscription added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) GetDataExchange

func (*UnimplementedAnalyticsHubServiceServer) GetIamPolicy

func (*UnimplementedAnalyticsHubServiceServer) GetListing

func (*UnimplementedAnalyticsHubServiceServer) GetSubscription added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) ListDataExchanges

func (*UnimplementedAnalyticsHubServiceServer) ListListings

func (*UnimplementedAnalyticsHubServiceServer) ListOrgDataExchanges

func (*UnimplementedAnalyticsHubServiceServer) ListSharedResourceSubscriptions added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) ListSubscriptions added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) RefreshSubscription added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) RevokeSubscription added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) SetIamPolicy

func (*UnimplementedAnalyticsHubServiceServer) SubscribeDataExchange added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) SubscribeListing

func (*UnimplementedAnalyticsHubServiceServer) TestIamPermissions

func (*UnimplementedAnalyticsHubServiceServer) UpdateDataExchange

func (*UnimplementedAnalyticsHubServiceServer) UpdateListing

type UpdateDataExchangeRequest

type UpdateDataExchangeRequest struct {

	// Required. Field mask specifies the fields to update in the data exchange
	// resource. The fields specified in the
	// `updateMask` are relative to the resource and are not a full request.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The data exchange to update.
	DataExchange *DataExchange `protobuf:"bytes,2,opt,name=data_exchange,json=dataExchange,proto3" json:"data_exchange,omitempty"`
	// contains filtered or unexported fields
}

Message for updating a data exchange.

func (*UpdateDataExchangeRequest) Descriptor deprecated

func (*UpdateDataExchangeRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*UpdateDataExchangeRequest) GetDataExchange

func (x *UpdateDataExchangeRequest) GetDataExchange() *DataExchange

func (*UpdateDataExchangeRequest) GetUpdateMask

func (x *UpdateDataExchangeRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDataExchangeRequest) ProtoMessage

func (*UpdateDataExchangeRequest) ProtoMessage()

func (*UpdateDataExchangeRequest) ProtoReflect

func (*UpdateDataExchangeRequest) Reset

func (x *UpdateDataExchangeRequest) Reset()

func (*UpdateDataExchangeRequest) String

func (x *UpdateDataExchangeRequest) String() string

type UpdateListingRequest

type UpdateListingRequest struct {

	// Required. Field mask specifies the fields to update in the listing
	// resource. The fields specified in the `updateMask` are relative to the
	// resource and are not a full request.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The listing to update.
	Listing *Listing `protobuf:"bytes,2,opt,name=listing,proto3" json:"listing,omitempty"`
	// contains filtered or unexported fields
}

Message for updating a Listing.

func (*UpdateListingRequest) Descriptor deprecated

func (*UpdateListingRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateListingRequest.ProtoReflect.Descriptor instead.

func (*UpdateListingRequest) GetListing

func (x *UpdateListingRequest) GetListing() *Listing

func (*UpdateListingRequest) GetUpdateMask

func (x *UpdateListingRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateListingRequest) ProtoMessage

func (*UpdateListingRequest) ProtoMessage()

func (*UpdateListingRequest) ProtoReflect

func (x *UpdateListingRequest) ProtoReflect() protoreflect.Message

func (*UpdateListingRequest) Reset

func (x *UpdateListingRequest) Reset()

func (*UpdateListingRequest) String

func (x *UpdateListingRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL