- 1.72.0 (latest)
- 1.71.0
- 1.70.0
- 1.69.0
- 1.68.0
- 1.67.0
- 1.66.2
- 1.65.0
- 1.64.0
- 1.63.1
- 1.62.0
- 1.61.0
- 1.60.0
- 1.59.1
- 1.58.0
- 1.57.1
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.2
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.1
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.2
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.1
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
Constants
AnalyticsHubService_ListDataExchanges_FullMethodName, AnalyticsHubService_ListOrgDataExchanges_FullMethodName, AnalyticsHubService_GetDataExchange_FullMethodName, AnalyticsHubService_CreateDataExchange_FullMethodName, AnalyticsHubService_UpdateDataExchange_FullMethodName, AnalyticsHubService_DeleteDataExchange_FullMethodName, AnalyticsHubService_ListListings_FullMethodName, AnalyticsHubService_GetListing_FullMethodName, AnalyticsHubService_CreateListing_FullMethodName, AnalyticsHubService_UpdateListing_FullMethodName, AnalyticsHubService_DeleteListing_FullMethodName, AnalyticsHubService_SubscribeListing_FullMethodName, AnalyticsHubService_SubscribeDataExchange_FullMethodName, AnalyticsHubService_RefreshSubscription_FullMethodName, AnalyticsHubService_GetSubscription_FullMethodName, AnalyticsHubService_ListSubscriptions_FullMethodName, AnalyticsHubService_ListSharedResourceSubscriptions_FullMethodName, AnalyticsHubService_RevokeSubscription_FullMethodName, AnalyticsHubService_DeleteSubscription_FullMethodName, AnalyticsHubService_GetIamPolicy_FullMethodName, AnalyticsHubService_SetIamPolicy_FullMethodName, AnalyticsHubService_TestIamPermissions_FullMethodName, AnalyticsHubService_CreateQueryTemplate_FullMethodName, AnalyticsHubService_GetQueryTemplate_FullMethodName, AnalyticsHubService_ListQueryTemplates_FullMethodName, AnalyticsHubService_UpdateQueryTemplate_FullMethodName, AnalyticsHubService_DeleteQueryTemplate_FullMethodName, AnalyticsHubService_SubmitQueryTemplate_FullMethodName, AnalyticsHubService_ApproveQueryTemplate_FullMethodName
const (
AnalyticsHubService_ListDataExchanges_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/ListDataExchanges"
AnalyticsHubService_ListOrgDataExchanges_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/ListOrgDataExchanges"
AnalyticsHubService_GetDataExchange_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/GetDataExchange"
AnalyticsHubService_CreateDataExchange_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/CreateDataExchange"
AnalyticsHubService_UpdateDataExchange_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/UpdateDataExchange"
AnalyticsHubService_DeleteDataExchange_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/DeleteDataExchange"
AnalyticsHubService_ListListings_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/ListListings"
AnalyticsHubService_GetListing_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/GetListing"
AnalyticsHubService_CreateListing_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/CreateListing"
AnalyticsHubService_UpdateListing_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/UpdateListing"
AnalyticsHubService_DeleteListing_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/DeleteListing"
AnalyticsHubService_SubscribeListing_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/SubscribeListing"
AnalyticsHubService_SubscribeDataExchange_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/SubscribeDataExchange"
AnalyticsHubService_RefreshSubscription_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/RefreshSubscription"
AnalyticsHubService_GetSubscription_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/GetSubscription"
AnalyticsHubService_ListSubscriptions_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/ListSubscriptions"
AnalyticsHubService_ListSharedResourceSubscriptions_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/ListSharedResourceSubscriptions"
AnalyticsHubService_RevokeSubscription_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/RevokeSubscription"
AnalyticsHubService_DeleteSubscription_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/DeleteSubscription"
AnalyticsHubService_GetIamPolicy_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/GetIamPolicy"
AnalyticsHubService_SetIamPolicy_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/SetIamPolicy"
AnalyticsHubService_TestIamPermissions_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/TestIamPermissions"
AnalyticsHubService_CreateQueryTemplate_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/CreateQueryTemplate"
AnalyticsHubService_GetQueryTemplate_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/GetQueryTemplate"
AnalyticsHubService_ListQueryTemplates_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/ListQueryTemplates"
AnalyticsHubService_UpdateQueryTemplate_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/UpdateQueryTemplate"
AnalyticsHubService_DeleteQueryTemplate_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/DeleteQueryTemplate"
AnalyticsHubService_SubmitQueryTemplate_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/SubmitQueryTemplate"
AnalyticsHubService_ApproveQueryTemplate_FullMethodName = "/google.cloud.bigquery.analyticshub.v1.AnalyticsHubService/ApproveQueryTemplate"
)Variables
DiscoveryType_name, DiscoveryType_value
var (
DiscoveryType_name = map[int32]string{
0: "DISCOVERY_TYPE_UNSPECIFIED",
1: "DISCOVERY_TYPE_PRIVATE",
2: "DISCOVERY_TYPE_PUBLIC",
}
DiscoveryType_value = map[string]int32{
"DISCOVERY_TYPE_UNSPECIFIED": 0,
"DISCOVERY_TYPE_PRIVATE": 1,
"DISCOVERY_TYPE_PUBLIC": 2,
}
)Enum value maps for DiscoveryType.
SharedResourceType_name, SharedResourceType_value
var (
SharedResourceType_name = map[int32]string{
0: "SHARED_RESOURCE_TYPE_UNSPECIFIED",
1: "BIGQUERY_DATASET",
2: "PUBSUB_TOPIC",
}
SharedResourceType_value = map[string]int32{
"SHARED_RESOURCE_TYPE_UNSPECIFIED": 0,
"BIGQUERY_DATASET": 1,
"PUBSUB_TOPIC": 2,
}
)Enum value maps for SharedResourceType.
QueryTemplate_State_name, QueryTemplate_State_value
var (
QueryTemplate_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "DRAFTED",
2: "PENDING",
3: "DELETED",
4: "APPROVED",
}
QueryTemplate_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"DRAFTED": 1,
"PENDING": 2,
"DELETED": 3,
"APPROVED": 4,
}
)Enum value maps for QueryTemplate_State.
Routine_RoutineType_name, Routine_RoutineType_value
var (
Routine_RoutineType_name = map[int32]string{
0: "ROUTINE_TYPE_UNSPECIFIED",
1: "TABLE_VALUED_FUNCTION",
}
Routine_RoutineType_value = map[string]int32{
"ROUTINE_TYPE_UNSPECIFIED": 0,
"TABLE_VALUED_FUNCTION": 1,
}
)Enum value maps for Routine_RoutineType.
Listing_State_name, Listing_State_value
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.
Listing_Category_name, Listing_Category_value
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",
20: "CATEGORY_GOOGLE_EARTH_ENGINE",
}
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,
"CATEGORY_GOOGLE_EARTH_ENGINE": 20,
}
)Enum value maps for Listing_Category.
Listing_BigQueryDatasetSource_Replica_ReplicaState_name, Listing_BigQueryDatasetSource_Replica_ReplicaState_value
var (
Listing_BigQueryDatasetSource_Replica_ReplicaState_name = map[int32]string{
0: "REPLICA_STATE_UNSPECIFIED",
1: "READY_TO_USE",
2: "UNAVAILABLE",
}
Listing_BigQueryDatasetSource_Replica_ReplicaState_value = map[string]int32{
"REPLICA_STATE_UNSPECIFIED": 0,
"READY_TO_USE": 1,
"UNAVAILABLE": 2,
}
)Enum value maps for Listing_BigQueryDatasetSource_Replica_ReplicaState.
Listing_BigQueryDatasetSource_Replica_PrimaryState_name, Listing_BigQueryDatasetSource_Replica_PrimaryState_value
var (
Listing_BigQueryDatasetSource_Replica_PrimaryState_name = map[int32]string{
0: "PRIMARY_STATE_UNSPECIFIED",
1: "PRIMARY_REPLICA",
}
Listing_BigQueryDatasetSource_Replica_PrimaryState_value = map[string]int32{
"PRIMARY_STATE_UNSPECIFIED": 0,
"PRIMARY_REPLICA": 1,
}
)Enum value maps for Listing_BigQueryDatasetSource_Replica_PrimaryState.
Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState_name, Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState_value
var (
Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState_name = map[int32]string{
0: "COMMERCIAL_STATE_UNSPECIFIED",
1: "ONBOARDING",
2: "ACTIVE",
}
Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState_value = map[string]int32{
"COMMERCIAL_STATE_UNSPECIFIED": 0,
"ONBOARDING": 1,
"ACTIVE": 2,
}
)Enum value maps for Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState.
Subscription_State_name, Subscription_State_value
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.
AnalyticsHubService_ServiceDesc
var AnalyticsHubService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService",
HandlerType: (*AnalyticsHubServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ListDataExchanges",
Handler: _AnalyticsHubService_ListDataExchanges_Handler,
},
{
MethodName: "ListOrgDataExchanges",
Handler: _AnalyticsHubService_ListOrgDataExchanges_Handler,
},
{
MethodName: "GetDataExchange",
Handler: _AnalyticsHubService_GetDataExchange_Handler,
},
{
MethodName: "CreateDataExchange",
Handler: _AnalyticsHubService_CreateDataExchange_Handler,
},
{
MethodName: "UpdateDataExchange",
Handler: _AnalyticsHubService_UpdateDataExchange_Handler,
},
{
MethodName: "DeleteDataExchange",
Handler: _AnalyticsHubService_DeleteDataExchange_Handler,
},
{
MethodName: "ListListings",
Handler: _AnalyticsHubService_ListListings_Handler,
},
{
MethodName: "GetListing",
Handler: _AnalyticsHubService_GetListing_Handler,
},
{
MethodName: "CreateListing",
Handler: _AnalyticsHubService_CreateListing_Handler,
},
{
MethodName: "UpdateListing",
Handler: _AnalyticsHubService_UpdateListing_Handler,
},
{
MethodName: "DeleteListing",
Handler: _AnalyticsHubService_DeleteListing_Handler,
},
{
MethodName: "SubscribeListing",
Handler: _AnalyticsHubService_SubscribeListing_Handler,
},
{
MethodName: "SubscribeDataExchange",
Handler: _AnalyticsHubService_SubscribeDataExchange_Handler,
},
{
MethodName: "RefreshSubscription",
Handler: _AnalyticsHubService_RefreshSubscription_Handler,
},
{
MethodName: "GetSubscription",
Handler: _AnalyticsHubService_GetSubscription_Handler,
},
{
MethodName: "ListSubscriptions",
Handler: _AnalyticsHubService_ListSubscriptions_Handler,
},
{
MethodName: "ListSharedResourceSubscriptions",
Handler: _AnalyticsHubService_ListSharedResourceSubscriptions_Handler,
},
{
MethodName: "RevokeSubscription",
Handler: _AnalyticsHubService_RevokeSubscription_Handler,
},
{
MethodName: "DeleteSubscription",
Handler: _AnalyticsHubService_DeleteSubscription_Handler,
},
{
MethodName: "GetIamPolicy",
Handler: _AnalyticsHubService_GetIamPolicy_Handler,
},
{
MethodName: "SetIamPolicy",
Handler: _AnalyticsHubService_SetIamPolicy_Handler,
},
{
MethodName: "TestIamPermissions",
Handler: _AnalyticsHubService_TestIamPermissions_Handler,
},
{
MethodName: "CreateQueryTemplate",
Handler: _AnalyticsHubService_CreateQueryTemplate_Handler,
},
{
MethodName: "GetQueryTemplate",
Handler: _AnalyticsHubService_GetQueryTemplate_Handler,
},
{
MethodName: "ListQueryTemplates",
Handler: _AnalyticsHubService_ListQueryTemplates_Handler,
},
{
MethodName: "UpdateQueryTemplate",
Handler: _AnalyticsHubService_UpdateQueryTemplate_Handler,
},
{
MethodName: "DeleteQueryTemplate",
Handler: _AnalyticsHubService_DeleteQueryTemplate_Handler,
},
{
MethodName: "SubmitQueryTemplate",
Handler: _AnalyticsHubService_SubmitQueryTemplate_Handler,
},
{
MethodName: "ApproveQueryTemplate",
Handler: _AnalyticsHubService_ApproveQueryTemplate_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/bigquery/analyticshub/v1/analyticshub.proto",
}AnalyticsHubService_ServiceDesc is the grpc.ServiceDesc for AnalyticsHubService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
File_google_cloud_bigquery_analyticshub_v1_analyticshub_proto
var File_google_cloud_bigquery_analyticshub_v1_analyticshub_proto protoreflect.FileDescriptorFile_google_cloud_bigquery_analyticshub_v1_pubsub_proto
var File_google_cloud_bigquery_analyticshub_v1_pubsub_proto protoreflect.FileDescriptorFunctions
func RegisterAnalyticsHubServiceServer
func RegisterAnalyticsHubServiceServer(s grpc.ServiceRegistrar, srv AnalyticsHubServiceServer)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 Clean Room. This is a
// long-running operation as it will create one or more linked datasets.
// Throws a Bad Request error if the Data Exchange does not contain any
// listings.
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)
// Creates a new QueryTemplate
CreateQueryTemplate(ctx context.Context, in *CreateQueryTemplateRequest, opts ...grpc.CallOption) (*QueryTemplate, error)
// Gets a QueryTemplate
GetQueryTemplate(ctx context.Context, in *GetQueryTemplateRequest, opts ...grpc.CallOption) (*QueryTemplate, error)
// Lists all QueryTemplates in a given project and location.
ListQueryTemplates(ctx context.Context, in *ListQueryTemplatesRequest, opts ...grpc.CallOption) (*ListQueryTemplatesResponse, error)
// Updates an existing QueryTemplate
UpdateQueryTemplate(ctx context.Context, in *UpdateQueryTemplateRequest, opts ...grpc.CallOption) (*QueryTemplate, error)
// Deletes a query template.
DeleteQueryTemplate(ctx context.Context, in *DeleteQueryTemplateRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Submits a query template for approval.
SubmitQueryTemplate(ctx context.Context, in *SubmitQueryTemplateRequest, opts ...grpc.CallOption) (*QueryTemplate, error)
// Approves a query template.
ApproveQueryTemplate(ctx context.Context, in *ApproveQueryTemplateRequest, opts ...grpc.CallOption) (*QueryTemplate, error)
}AnalyticsHubServiceClient is the client API for AnalyticsHubService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewAnalyticsHubServiceClient
func NewAnalyticsHubServiceClient(cc grpc.ClientConnInterface) AnalyticsHubServiceClientAnalyticsHubServiceServer
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 Clean Room. This is a
// long-running operation as it will create one or more linked datasets.
// Throws a Bad Request error if the Data Exchange does not contain any
// listings.
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)
// Creates a new QueryTemplate
CreateQueryTemplate(context.Context, *CreateQueryTemplateRequest) (*QueryTemplate, error)
// Gets a QueryTemplate
GetQueryTemplate(context.Context, *GetQueryTemplateRequest) (*QueryTemplate, error)
// Lists all QueryTemplates in a given project and location.
ListQueryTemplates(context.Context, *ListQueryTemplatesRequest) (*ListQueryTemplatesResponse, error)
// Updates an existing QueryTemplate
UpdateQueryTemplate(context.Context, *UpdateQueryTemplateRequest) (*QueryTemplate, error)
// Deletes a query template.
DeleteQueryTemplate(context.Context, *DeleteQueryTemplateRequest) (*emptypb.Empty, error)
// Submits a query template for approval.
SubmitQueryTemplate(context.Context, *SubmitQueryTemplateRequest) (*QueryTemplate, error)
// Approves a query template.
ApproveQueryTemplate(context.Context, *ApproveQueryTemplateRequest) (*QueryTemplate, error)
}AnalyticsHubServiceServer is the server API for AnalyticsHubService service. All implementations should embed UnimplementedAnalyticsHubServiceServer for forward compatibility
ApproveQueryTemplateRequest
type ApproveQueryTemplateRequest struct {
// Required. The resource path of the QueryTemplate.
// e.g.
// `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Message for approving a QueryTemplate.
func (*ApproveQueryTemplateRequest) Descriptor
func (*ApproveQueryTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use ApproveQueryTemplateRequest.ProtoReflect.Descriptor instead.
func (*ApproveQueryTemplateRequest) GetName
func (x *ApproveQueryTemplateRequest) GetName() stringfunc (*ApproveQueryTemplateRequest) ProtoMessage
func (*ApproveQueryTemplateRequest) ProtoMessage()func (*ApproveQueryTemplateRequest) ProtoReflect
func (x *ApproveQueryTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*ApproveQueryTemplateRequest) Reset
func (x *ApproveQueryTemplateRequest) Reset()func (*ApproveQueryTemplateRequest) String
func (x *ApproveQueryTemplateRequest) String() stringBigQueryConfig
type BigQueryConfig struct {
// Optional. The name of the table to which to write data, of the form
// {projectId}.{datasetId}.{tableId}
Table string `protobuf:"bytes,1,opt,name=table,proto3" json:"table,omitempty"`
// Optional. When true, use the topic's schema as the columns to write to in
// BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be
// enabled at the same time.
UseTopicSchema bool `protobuf:"varint,2,opt,name=use_topic_schema,json=useTopicSchema,proto3" json:"use_topic_schema,omitempty"`
// Optional. When true, write the subscription name, message_id, publish_time,
// attributes, and ordering_key to additional columns in the table. The
// subscription name, message_id, and publish_time fields are put in their own
// columns while all other message properties (other than data) are written to
// a JSON object in the attributes column.
WriteMetadata bool `protobuf:"varint,3,opt,name=write_metadata,json=writeMetadata,proto3" json:"write_metadata,omitempty"`
// Optional. When true and use_topic_schema is true, any fields that are a
// part of the topic schema that are not part of the BigQuery table schema are
// dropped when writing to BigQuery. Otherwise, the schemas must be kept in
// sync and any messages with extra fields are not written and remain in the
// subscription's backlog.
DropUnknownFields bool `protobuf:"varint,4,opt,name=drop_unknown_fields,json=dropUnknownFields,proto3" json:"drop_unknown_fields,omitempty"`
// Optional. When true, use the BigQuery table's schema as the columns to
// write to in BigQuery. `use_table_schema` and `use_topic_schema` cannot be
// enabled at the same time.
UseTableSchema bool `protobuf:"varint,6,opt,name=use_table_schema,json=useTableSchema,proto3" json:"use_table_schema,omitempty"`
// Optional. The service account to use to write to BigQuery. The subscription
// creator or updater that specifies this field must have
// `iam.serviceAccounts.actAs` permission on the service account. If not
// specified, the Pub/Sub [service
// agent](https://cloud.google.com/iam/docs/service-agents),
// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
ServiceAccountEmail string `protobuf:"bytes,7,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// contains filtered or unexported fields
}Configuration for a BigQuery subscription.
func (*BigQueryConfig) Descriptor
func (*BigQueryConfig) Descriptor() ([]byte, []int)Deprecated: Use BigQueryConfig.ProtoReflect.Descriptor instead.
func (*BigQueryConfig) GetDropUnknownFields
func (x *BigQueryConfig) GetDropUnknownFields() boolfunc (*BigQueryConfig) GetServiceAccountEmail
func (x *BigQueryConfig) GetServiceAccountEmail() stringfunc (*BigQueryConfig) GetTable
func (x *BigQueryConfig) GetTable() stringfunc (*BigQueryConfig) GetUseTableSchema
func (x *BigQueryConfig) GetUseTableSchema() boolfunc (*BigQueryConfig) GetUseTopicSchema
func (x *BigQueryConfig) GetUseTopicSchema() boolfunc (*BigQueryConfig) GetWriteMetadata
func (x *BigQueryConfig) GetWriteMetadata() boolfunc (*BigQueryConfig) ProtoMessage
func (*BigQueryConfig) ProtoMessage()func (*BigQueryConfig) ProtoReflect
func (x *BigQueryConfig) ProtoReflect() protoreflect.Messagefunc (*BigQueryConfig) Reset
func (x *BigQueryConfig) Reset()func (*BigQueryConfig) String
func (x *BigQueryConfig) String() stringCloudStorageConfig
type CloudStorageConfig struct {
// Defaults to text format.
//
// Types that are assignable to OutputFormat:
//
// *CloudStorageConfig_TextConfig_
// *CloudStorageConfig_AvroConfig_
OutputFormat isCloudStorageConfig_OutputFormat `protobuf_oneof:"output_format"`
// Required. User-provided name for the Cloud Storage bucket.
// The bucket must be created by the user. The bucket name must be without
// any prefix like "gs://". See the [bucket naming
// requirements] (https://cloud.google.com/storage/docs/buckets#naming).
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Optional. User-provided prefix for Cloud Storage filename. See the [object
// naming requirements](https://cloud.google.com/storage/docs/objects#naming).
FilenamePrefix string `protobuf:"bytes,2,opt,name=filename_prefix,json=filenamePrefix,proto3" json:"filename_prefix,omitempty"`
// Optional. User-provided suffix for Cloud Storage filename. See the [object
// naming requirements](https://cloud.google.com/storage/docs/objects#naming).
// Must not end in "/".
FilenameSuffix string `protobuf:"bytes,3,opt,name=filename_suffix,json=filenameSuffix,proto3" json:"filename_suffix,omitempty"`
// Optional. User-provided format string specifying how to represent datetimes
// in Cloud Storage filenames. See the [datetime format
// guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
FilenameDatetimeFormat string `protobuf:"bytes,10,opt,name=filename_datetime_format,json=filenameDatetimeFormat,proto3" json:"filename_datetime_format,omitempty"`
// Optional. File batching settings.
// If no max_duration setting is specified, a max_duration of 5 minutes will
// be set by default. max_duration is required regardless of whether other
// file batching settings are specified.
//
// The maximum duration that can elapse before a new Cloud Storage file is
// created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed
// the subscription's acknowledgement deadline.
MaxDuration *durationpb.Duration `protobuf:"bytes,6,opt,name=max_duration,json=maxDuration,proto3" json:"max_duration,omitempty"`
// Optional. The maximum bytes that can be written to a Cloud Storage file
// before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may
// be exceeded in cases where messages are larger than the limit.
MaxBytes int64 `protobuf:"varint,7,opt,name=max_bytes,json=maxBytes,proto3" json:"max_bytes,omitempty"`
// Optional. The maximum number of messages that can be written to a Cloud
// Storage file before a new file is created. Min 1000 messages.
MaxMessages int64 `protobuf:"varint,8,opt,name=max_messages,json=maxMessages,proto3" json:"max_messages,omitempty"`
// Optional. The service account to use to write to Cloud Storage. The
// subscription creator or updater that specifies this field must have
// `iam.serviceAccounts.actAs` permission on the service account. If not
// specified, the Pub/Sub
// [service agent](https://cloud.google.com/iam/docs/service-agents),
// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
ServiceAccountEmail string `protobuf:"bytes,11,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// contains filtered or unexported fields
}Configuration for a Cloud Storage subscription.
func (*CloudStorageConfig) Descriptor
func (*CloudStorageConfig) Descriptor() ([]byte, []int)Deprecated: Use CloudStorageConfig.ProtoReflect.Descriptor instead.
func (*CloudStorageConfig) GetAvroConfig
func (x *CloudStorageConfig) GetAvroConfig() *CloudStorageConfig_AvroConfigfunc (*CloudStorageConfig) GetBucket
func (x *CloudStorageConfig) GetBucket() stringfunc (*CloudStorageConfig) GetFilenameDatetimeFormat
func (x *CloudStorageConfig) GetFilenameDatetimeFormat() stringfunc (*CloudStorageConfig) GetFilenamePrefix
func (x *CloudStorageConfig) GetFilenamePrefix() stringfunc (*CloudStorageConfig) GetFilenameSuffix
func (x *CloudStorageConfig) GetFilenameSuffix() stringfunc (*CloudStorageConfig) GetMaxBytes
func (x *CloudStorageConfig) GetMaxBytes() int64func (*CloudStorageConfig) GetMaxDuration
func (x *CloudStorageConfig) GetMaxDuration() *durationpb.Durationfunc (*CloudStorageConfig) GetMaxMessages
func (x *CloudStorageConfig) GetMaxMessages() int64func (*CloudStorageConfig) GetOutputFormat
func (m *CloudStorageConfig) GetOutputFormat() isCloudStorageConfig_OutputFormatfunc (*CloudStorageConfig) GetServiceAccountEmail
func (x *CloudStorageConfig) GetServiceAccountEmail() stringfunc (*CloudStorageConfig) GetTextConfig
func (x *CloudStorageConfig) GetTextConfig() *CloudStorageConfig_TextConfigfunc (*CloudStorageConfig) ProtoMessage
func (*CloudStorageConfig) ProtoMessage()func (*CloudStorageConfig) ProtoReflect
func (x *CloudStorageConfig) ProtoReflect() protoreflect.Messagefunc (*CloudStorageConfig) Reset
func (x *CloudStorageConfig) Reset()func (*CloudStorageConfig) String
func (x *CloudStorageConfig) String() stringCloudStorageConfig_AvroConfig
type CloudStorageConfig_AvroConfig struct {
// Optional. When true, write the subscription name, message_id,
// publish_time, attributes, and ordering_key as additional fields in the
// output. The subscription name, message_id, and publish_time fields are
// put in their own fields while all other message properties other than
// data (for example, an ordering_key, if present) are added as entries in
// the attributes map.
WriteMetadata bool `protobuf:"varint,1,opt,name=write_metadata,json=writeMetadata,proto3" json:"write_metadata,omitempty"`
// Optional. When true, the output Cloud Storage file will be serialized
// using the topic schema, if it exists.
UseTopicSchema bool `protobuf:"varint,2,opt,name=use_topic_schema,json=useTopicSchema,proto3" json:"use_topic_schema,omitempty"`
// contains filtered or unexported fields
}Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.
func (*CloudStorageConfig_AvroConfig) Descriptor
func (*CloudStorageConfig_AvroConfig) Descriptor() ([]byte, []int)Deprecated: Use CloudStorageConfig_AvroConfig.ProtoReflect.Descriptor instead.
func (*CloudStorageConfig_AvroConfig) GetUseTopicSchema
func (x *CloudStorageConfig_AvroConfig) GetUseTopicSchema() boolfunc (*CloudStorageConfig_AvroConfig) GetWriteMetadata
func (x *CloudStorageConfig_AvroConfig) GetWriteMetadata() boolfunc (*CloudStorageConfig_AvroConfig) ProtoMessage
func (*CloudStorageConfig_AvroConfig) ProtoMessage()func (*CloudStorageConfig_AvroConfig) ProtoReflect
func (x *CloudStorageConfig_AvroConfig) ProtoReflect() protoreflect.Messagefunc (*CloudStorageConfig_AvroConfig) Reset
func (x *CloudStorageConfig_AvroConfig) Reset()func (*CloudStorageConfig_AvroConfig) String
func (x *CloudStorageConfig_AvroConfig) String() stringCloudStorageConfig_AvroConfig_
type CloudStorageConfig_AvroConfig_ struct {
// Optional. If set, message data will be written to Cloud Storage in Avro
// format.
AvroConfig *CloudStorageConfig_AvroConfig `protobuf:"bytes,5,opt,name=avro_config,json=avroConfig,proto3,oneof"`
}CloudStorageConfig_TextConfig
type CloudStorageConfig_TextConfig struct {
// contains filtered or unexported fields
}Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline.
func (*CloudStorageConfig_TextConfig) Descriptor
func (*CloudStorageConfig_TextConfig) Descriptor() ([]byte, []int)Deprecated: Use CloudStorageConfig_TextConfig.ProtoReflect.Descriptor instead.
func (*CloudStorageConfig_TextConfig) ProtoMessage
func (*CloudStorageConfig_TextConfig) ProtoMessage()func (*CloudStorageConfig_TextConfig) ProtoReflect
func (x *CloudStorageConfig_TextConfig) ProtoReflect() protoreflect.Messagefunc (*CloudStorageConfig_TextConfig) Reset
func (x *CloudStorageConfig_TextConfig) Reset()func (*CloudStorageConfig_TextConfig) String
func (x *CloudStorageConfig_TextConfig) String() stringCloudStorageConfig_TextConfig_
type CloudStorageConfig_TextConfig_ struct {
// Optional. If set, message data will be written to Cloud Storage in text
// format.
TextConfig *CloudStorageConfig_TextConfig `protobuf:"bytes,4,opt,name=text_config,json=textConfig,proto3,oneof"`
}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 (_).
// 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
func (*CreateDataExchangeRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateDataExchangeRequest.ProtoReflect.Descriptor instead.
func (*CreateDataExchangeRequest) GetDataExchange
func (x *CreateDataExchangeRequest) GetDataExchange() *DataExchangefunc (*CreateDataExchangeRequest) GetDataExchangeId
func (x *CreateDataExchangeRequest) GetDataExchangeId() stringfunc (*CreateDataExchangeRequest) GetParent
func (x *CreateDataExchangeRequest) GetParent() stringfunc (*CreateDataExchangeRequest) ProtoMessage
func (*CreateDataExchangeRequest) ProtoMessage()func (*CreateDataExchangeRequest) ProtoReflect
func (x *CreateDataExchangeRequest) ProtoReflect() protoreflect.Messagefunc (*CreateDataExchangeRequest) Reset
func (x *CreateDataExchangeRequest) Reset()func (*CreateDataExchangeRequest) String
func (x *CreateDataExchangeRequest) String() stringCreateListingRequest
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 (_).
// 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
func (*CreateListingRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateListingRequest.ProtoReflect.Descriptor instead.
func (*CreateListingRequest) GetListing
func (x *CreateListingRequest) GetListing() *Listingfunc (*CreateListingRequest) GetListingId
func (x *CreateListingRequest) GetListingId() stringfunc (*CreateListingRequest) GetParent
func (x *CreateListingRequest) GetParent() stringfunc (*CreateListingRequest) ProtoMessage
func (*CreateListingRequest) ProtoMessage()func (*CreateListingRequest) ProtoReflect
func (x *CreateListingRequest) ProtoReflect() protoreflect.Messagefunc (*CreateListingRequest) Reset
func (x *CreateListingRequest) Reset()func (*CreateListingRequest) String
func (x *CreateListingRequest) String() stringCreateQueryTemplateRequest
type CreateQueryTemplateRequest struct {
// Required. The parent resource path of the QueryTemplate.
// e.g.
// `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myQueryTemplate`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The ID of the QueryTemplate to create.
// Must contain only Unicode letters, numbers (0-9), underscores (_).
// Max length: 100 bytes.
QueryTemplateId string `protobuf:"bytes,2,opt,name=query_template_id,json=queryTemplateId,proto3" json:"query_template_id,omitempty"`
// Required. The QueryTemplate to create.
QueryTemplate *QueryTemplate `protobuf:"bytes,3,opt,name=query_template,json=queryTemplate,proto3" json:"query_template,omitempty"`
// contains filtered or unexported fields
}Message for creating a QueryTemplate.
func (*CreateQueryTemplateRequest) Descriptor
func (*CreateQueryTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateQueryTemplateRequest.ProtoReflect.Descriptor instead.
func (*CreateQueryTemplateRequest) GetParent
func (x *CreateQueryTemplateRequest) GetParent() stringfunc (*CreateQueryTemplateRequest) GetQueryTemplate
func (x *CreateQueryTemplateRequest) GetQueryTemplate() *QueryTemplatefunc (*CreateQueryTemplateRequest) GetQueryTemplateId
func (x *CreateQueryTemplateRequest) GetQueryTemplateId() stringfunc (*CreateQueryTemplateRequest) ProtoMessage
func (*CreateQueryTemplateRequest) ProtoMessage()func (*CreateQueryTemplateRequest) ProtoReflect
func (x *CreateQueryTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*CreateQueryTemplateRequest) Reset
func (x *CreateQueryTemplateRequest) Reset()func (*CreateQueryTemplateRequest) String
func (x *CreateQueryTemplateRequest) String() stringDataExchange
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 `protobuf:"bytes,8,opt,name=sharing_environment_config,json=sharingEnvironmentConfig,proto3" json:"sharing_environment_config,omitempty"`
// Optional. Type of discovery on the discovery page for all the listings
// under this exchange. Updating this field also updates (overwrites) the
// discovery_type field for all the listings under this exchange.
DiscoveryType *DiscoveryType `protobuf:"varint,9,opt,name=discovery_type,json=discoveryType,proto3,enum=google.cloud.bigquery.analyticshub.v1.DiscoveryType,oneof" json:"discovery_type,omitempty"`
// Optional. By default, false.
// If true, the DataExchange has an email sharing mandate enabled.
LogLinkedDatasetQueryUserEmail *bool `protobuf:"varint,10,opt,name=log_linked_dataset_query_user_email,json=logLinkedDatasetQueryUserEmail,proto3,oneof" json:"log_linked_dataset_query_user_email,omitempty"`
// 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
func (*DataExchange) Descriptor() ([]byte, []int)Deprecated: Use DataExchange.ProtoReflect.Descriptor instead.
func (*DataExchange) GetDescription
func (x *DataExchange) GetDescription() stringfunc (*DataExchange) GetDiscoveryType
func (x *DataExchange) GetDiscoveryType() DiscoveryTypefunc (*DataExchange) GetDisplayName
func (x *DataExchange) GetDisplayName() stringfunc (*DataExchange) GetDocumentation
func (x *DataExchange) GetDocumentation() stringfunc (*DataExchange) GetIcon
func (x *DataExchange) GetIcon() []bytefunc (*DataExchange) GetListingCount
func (x *DataExchange) GetListingCount() int32func (*DataExchange) GetLogLinkedDatasetQueryUserEmail
func (x *DataExchange) GetLogLinkedDatasetQueryUserEmail() boolfunc (*DataExchange) GetName
func (x *DataExchange) GetName() stringfunc (*DataExchange) GetPrimaryContact
func (x *DataExchange) GetPrimaryContact() stringfunc (*DataExchange) GetSharingEnvironmentConfig
func (x *DataExchange) GetSharingEnvironmentConfig() *SharingEnvironmentConfigfunc (*DataExchange) ProtoMessage
func (*DataExchange) ProtoMessage()func (*DataExchange) ProtoReflect
func (x *DataExchange) ProtoReflect() protoreflect.Messagefunc (*DataExchange) Reset
func (x *DataExchange) Reset()func (*DataExchange) String
func (x *DataExchange) String() stringDataProvider
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
func (*DataProvider) Descriptor() ([]byte, []int)Deprecated: Use DataProvider.ProtoReflect.Descriptor instead.
func (*DataProvider) GetName
func (x *DataProvider) GetName() stringfunc (*DataProvider) GetPrimaryContact
func (x *DataProvider) GetPrimaryContact() stringfunc (*DataProvider) ProtoMessage
func (*DataProvider) ProtoMessage()func (*DataProvider) ProtoReflect
func (x *DataProvider) ProtoReflect() protoreflect.Messagefunc (*DataProvider) Reset
func (x *DataProvider) Reset()func (*DataProvider) String
func (x *DataProvider) String() stringDeadLetterPolicy
type DeadLetterPolicy struct {
// Optional. The name of the topic to which dead letter messages should be
// published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub
// service account associated with the enclosing subscription's parent project
// (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must
// have permission to Publish() to this topic.
//
// The operation will fail if the topic does not exist.
// Users should ensure that there is a subscription attached to this topic
// since messages published to a topic with no subscriptions are lost.
DeadLetterTopic string `protobuf:"bytes,1,opt,name=dead_letter_topic,json=deadLetterTopic,proto3" json:"dead_letter_topic,omitempty"`
// Optional. The maximum number of delivery attempts for any message. The
// value must be between 5 and 100.
//
// The number of delivery attempts is defined as 1 + (the sum of number of
// NACKs and number of times the acknowledgement deadline has been exceeded
// for the message).
//
// A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that
// client libraries may automatically extend ack_deadlines.
//
// This field will be honored on a best effort basis.
//
// If this parameter is 0, a default value of 5 is used.
MaxDeliveryAttempts int32 `protobuf:"varint,2,opt,name=max_delivery_attempts,json=maxDeliveryAttempts,proto3" json:"max_delivery_attempts,omitempty"`
// contains filtered or unexported fields
}Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times.
If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.
func (*DeadLetterPolicy) Descriptor
func (*DeadLetterPolicy) Descriptor() ([]byte, []int)Deprecated: Use DeadLetterPolicy.ProtoReflect.Descriptor instead.
func (*DeadLetterPolicy) GetDeadLetterTopic
func (x *DeadLetterPolicy) GetDeadLetterTopic() stringfunc (*DeadLetterPolicy) GetMaxDeliveryAttempts
func (x *DeadLetterPolicy) GetMaxDeliveryAttempts() int32func (*DeadLetterPolicy) ProtoMessage
func (*DeadLetterPolicy) ProtoMessage()func (*DeadLetterPolicy) ProtoReflect
func (x *DeadLetterPolicy) ProtoReflect() protoreflect.Messagefunc (*DeadLetterPolicy) Reset
func (x *DeadLetterPolicy) Reset()func (*DeadLetterPolicy) String
func (x *DeadLetterPolicy) String() stringDeleteDataExchangeRequest
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
func (*DeleteDataExchangeRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteDataExchangeRequest.ProtoReflect.Descriptor instead.
func (*DeleteDataExchangeRequest) GetName
func (x *DeleteDataExchangeRequest) GetName() stringfunc (*DeleteDataExchangeRequest) ProtoMessage
func (*DeleteDataExchangeRequest) ProtoMessage()func (*DeleteDataExchangeRequest) ProtoReflect
func (x *DeleteDataExchangeRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteDataExchangeRequest) Reset
func (x *DeleteDataExchangeRequest) Reset()func (*DeleteDataExchangeRequest) String
func (x *DeleteDataExchangeRequest) String() stringDeleteListingRequest
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"`
// Optional. If the listing is commercial then this field must be set to true,
// otherwise a failure is thrown. This acts as a safety guard to avoid
// deleting commercial listings accidentally.
DeleteCommercial bool `protobuf:"varint,2,opt,name=delete_commercial,json=deleteCommercial,proto3" json:"delete_commercial,omitempty"`
// contains filtered or unexported fields
}Message for deleting a listing.
func (*DeleteListingRequest) Descriptor
func (*DeleteListingRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteListingRequest.ProtoReflect.Descriptor instead.
func (*DeleteListingRequest) GetDeleteCommercial
func (x *DeleteListingRequest) GetDeleteCommercial() boolfunc (*DeleteListingRequest) GetName
func (x *DeleteListingRequest) GetName() stringfunc (*DeleteListingRequest) ProtoMessage
func (*DeleteListingRequest) ProtoMessage()func (*DeleteListingRequest) ProtoReflect
func (x *DeleteListingRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteListingRequest) Reset
func (x *DeleteListingRequest) Reset()func (*DeleteListingRequest) String
func (x *DeleteListingRequest) String() stringDeleteQueryTemplateRequest
type DeleteQueryTemplateRequest struct {
// Required. The resource path of the QueryTemplate.
// e.g.
// `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Message for deleting a QueryTemplate.
func (*DeleteQueryTemplateRequest) Descriptor
func (*DeleteQueryTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteQueryTemplateRequest.ProtoReflect.Descriptor instead.
func (*DeleteQueryTemplateRequest) GetName
func (x *DeleteQueryTemplateRequest) GetName() stringfunc (*DeleteQueryTemplateRequest) ProtoMessage
func (*DeleteQueryTemplateRequest) ProtoMessage()func (*DeleteQueryTemplateRequest) ProtoReflect
func (x *DeleteQueryTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteQueryTemplateRequest) Reset
func (x *DeleteQueryTemplateRequest) Reset()func (*DeleteQueryTemplateRequest) String
func (x *DeleteQueryTemplateRequest) String() stringDeleteSubscriptionRequest
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
func (*DeleteSubscriptionRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSubscriptionRequest.ProtoReflect.Descriptor instead.
func (*DeleteSubscriptionRequest) GetName
func (x *DeleteSubscriptionRequest) GetName() stringfunc (*DeleteSubscriptionRequest) ProtoMessage
func (*DeleteSubscriptionRequest) ProtoMessage()func (*DeleteSubscriptionRequest) ProtoReflect
func (x *DeleteSubscriptionRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSubscriptionRequest) Reset
func (x *DeleteSubscriptionRequest) Reset()func (*DeleteSubscriptionRequest) String
func (x *DeleteSubscriptionRequest) String() stringDestinationDataset
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 `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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"`
// Optional. The geographic locations where the dataset should be replicated.
// See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
// for supported locations.
ReplicaLocations []string `protobuf:"bytes,6,rep,name=replica_locations,json=replicaLocations,proto3" json:"replica_locations,omitempty"`
// contains filtered or unexported fields
}Defines the destination bigquery dataset.
func (*DestinationDataset) Descriptor
func (*DestinationDataset) Descriptor() ([]byte, []int)Deprecated: Use DestinationDataset.ProtoReflect.Descriptor instead.
func (*DestinationDataset) GetDatasetReference
func (x *DestinationDataset) GetDatasetReference() *DestinationDatasetReferencefunc (*DestinationDataset) GetDescription
func (x *DestinationDataset) GetDescription() *wrapperspb.StringValuefunc (*DestinationDataset) GetFriendlyName
func (x *DestinationDataset) GetFriendlyName() *wrapperspb.StringValuefunc (*DestinationDataset) GetLabels
func (x *DestinationDataset) GetLabels() map[string]stringfunc (*DestinationDataset) GetLocation
func (x *DestinationDataset) GetLocation() stringfunc (*DestinationDataset) GetReplicaLocations
func (x *DestinationDataset) GetReplicaLocations() []stringfunc (*DestinationDataset) ProtoMessage
func (*DestinationDataset) ProtoMessage()func (*DestinationDataset) ProtoReflect
func (x *DestinationDataset) ProtoReflect() protoreflect.Messagefunc (*DestinationDataset) Reset
func (x *DestinationDataset) Reset()func (*DestinationDataset) String
func (x *DestinationDataset) String() stringDestinationDatasetReference
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
}func (*DestinationDatasetReference) Descriptor
func (*DestinationDatasetReference) Descriptor() ([]byte, []int)Deprecated: Use DestinationDatasetReference.ProtoReflect.Descriptor instead.
func (*DestinationDatasetReference) GetDatasetId
func (x *DestinationDatasetReference) GetDatasetId() stringfunc (*DestinationDatasetReference) GetProjectId
func (x *DestinationDatasetReference) GetProjectId() stringfunc (*DestinationDatasetReference) ProtoMessage
func (*DestinationDatasetReference) ProtoMessage()func (*DestinationDatasetReference) ProtoReflect
func (x *DestinationDatasetReference) ProtoReflect() protoreflect.Messagefunc (*DestinationDatasetReference) Reset
func (x *DestinationDatasetReference) Reset()func (*DestinationDatasetReference) String
func (x *DestinationDatasetReference) String() stringDestinationPubSubSubscription
type DestinationPubSubSubscription struct {
// Required. Destination Pub/Sub subscription resource.
PubsubSubscription *PubSubSubscription `protobuf:"bytes,1,opt,name=pubsub_subscription,json=pubsubSubscription,proto3" json:"pubsub_subscription,omitempty"`
// contains filtered or unexported fields
}Defines the destination Pub/Sub subscription.
func (*DestinationPubSubSubscription) Descriptor
func (*DestinationPubSubSubscription) Descriptor() ([]byte, []int)Deprecated: Use DestinationPubSubSubscription.ProtoReflect.Descriptor instead.
func (*DestinationPubSubSubscription) GetPubsubSubscription
func (x *DestinationPubSubSubscription) GetPubsubSubscription() *PubSubSubscriptionfunc (*DestinationPubSubSubscription) ProtoMessage
func (*DestinationPubSubSubscription) ProtoMessage()func (*DestinationPubSubSubscription) ProtoReflect
func (x *DestinationPubSubSubscription) ProtoReflect() protoreflect.Messagefunc (*DestinationPubSubSubscription) Reset
func (x *DestinationPubSubSubscription) Reset()func (*DestinationPubSubSubscription) String
func (x *DestinationPubSubSubscription) String() stringDiscoveryType
type DiscoveryType int32Specifies the type of discovery on the discovery page. Note that this does not control the visibility of the exchange/listing which is defined by IAM permission.
DiscoveryType_DISCOVERY_TYPE_UNSPECIFIED, DiscoveryType_DISCOVERY_TYPE_PRIVATE, DiscoveryType_DISCOVERY_TYPE_PUBLIC
const (
// Unspecified. Defaults to DISCOVERY_TYPE_PRIVATE.
DiscoveryType_DISCOVERY_TYPE_UNSPECIFIED DiscoveryType = 0
// The Data exchange/listing can be discovered in the 'Private' results
// list.
DiscoveryType_DISCOVERY_TYPE_PRIVATE DiscoveryType = 1
// The Data exchange/listing can be discovered in the 'Public' results
// list.
DiscoveryType_DISCOVERY_TYPE_PUBLIC DiscoveryType = 2
)func (DiscoveryType) Descriptor
func (DiscoveryType) Descriptor() protoreflect.EnumDescriptorfunc (DiscoveryType) Enum
func (x DiscoveryType) Enum() *DiscoveryTypefunc (DiscoveryType) EnumDescriptor
func (DiscoveryType) EnumDescriptor() ([]byte, []int)Deprecated: Use DiscoveryType.Descriptor instead.
func (DiscoveryType) Number
func (x DiscoveryType) Number() protoreflect.EnumNumberfunc (DiscoveryType) String
func (x DiscoveryType) String() stringfunc (DiscoveryType) Type
func (DiscoveryType) Type() protoreflect.EnumTypeExpirationPolicy
type ExpirationPolicy struct {
// Optional. Specifies the "time-to-live" duration for an associated resource.
// The resource expires if it is not active for a period of `ttl`. The
// definition of "activity" depends on the type of the associated resource.
// The minimum and maximum allowed values for `ttl` depend on the type of the
// associated resource, as well. If `ttl` is not set, the associated resource
// never expires.
Ttl *durationpb.Duration `protobuf:"bytes,1,opt,name=ttl,proto3" json:"ttl,omitempty"`
// contains filtered or unexported fields
}A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
func (*ExpirationPolicy) Descriptor
func (*ExpirationPolicy) Descriptor() ([]byte, []int)Deprecated: Use ExpirationPolicy.ProtoReflect.Descriptor instead.
func (*ExpirationPolicy) GetTtl
func (x *ExpirationPolicy) GetTtl() *durationpb.Durationfunc (*ExpirationPolicy) ProtoMessage
func (*ExpirationPolicy) ProtoMessage()func (*ExpirationPolicy) ProtoReflect
func (x *ExpirationPolicy) ProtoReflect() protoreflect.Messagefunc (*ExpirationPolicy) Reset
func (x *ExpirationPolicy) Reset()func (*ExpirationPolicy) String
func (x *ExpirationPolicy) String() stringGetDataExchangeRequest
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
func (*GetDataExchangeRequest) Descriptor() ([]byte, []int)Deprecated: Use GetDataExchangeRequest.ProtoReflect.Descriptor instead.
func (*GetDataExchangeRequest) GetName
func (x *GetDataExchangeRequest) GetName() stringfunc (*GetDataExchangeRequest) ProtoMessage
func (*GetDataExchangeRequest) ProtoMessage()func (*GetDataExchangeRequest) ProtoReflect
func (x *GetDataExchangeRequest) ProtoReflect() protoreflect.Messagefunc (*GetDataExchangeRequest) Reset
func (x *GetDataExchangeRequest) Reset()func (*GetDataExchangeRequest) String
func (x *GetDataExchangeRequest) String() stringGetListingRequest
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
func (*GetListingRequest) Descriptor() ([]byte, []int)Deprecated: Use GetListingRequest.ProtoReflect.Descriptor instead.
func (*GetListingRequest) GetName
func (x *GetListingRequest) GetName() stringfunc (*GetListingRequest) ProtoMessage
func (*GetListingRequest) ProtoMessage()func (*GetListingRequest) ProtoReflect
func (x *GetListingRequest) ProtoReflect() protoreflect.Messagefunc (*GetListingRequest) Reset
func (x *GetListingRequest) Reset()func (*GetListingRequest) String
func (x *GetListingRequest) String() stringGetQueryTemplateRequest
type GetQueryTemplateRequest struct {
// Required. The parent resource path of the QueryTemplate.
// e.g.
// `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Message for creating a QueryTemplate.
func (*GetQueryTemplateRequest) Descriptor
func (*GetQueryTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use GetQueryTemplateRequest.ProtoReflect.Descriptor instead.
func (*GetQueryTemplateRequest) GetName
func (x *GetQueryTemplateRequest) GetName() stringfunc (*GetQueryTemplateRequest) ProtoMessage
func (*GetQueryTemplateRequest) ProtoMessage()func (*GetQueryTemplateRequest) ProtoReflect
func (x *GetQueryTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*GetQueryTemplateRequest) Reset
func (x *GetQueryTemplateRequest) Reset()func (*GetQueryTemplateRequest) String
func (x *GetQueryTemplateRequest) String() stringGetSubscriptionRequest
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
func (*GetSubscriptionRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSubscriptionRequest.ProtoReflect.Descriptor instead.
func (*GetSubscriptionRequest) GetName
func (x *GetSubscriptionRequest) GetName() stringfunc (*GetSubscriptionRequest) ProtoMessage
func (*GetSubscriptionRequest) ProtoMessage()func (*GetSubscriptionRequest) ProtoReflect
func (x *GetSubscriptionRequest) ProtoReflect() protoreflect.Messagefunc (*GetSubscriptionRequest) Reset
func (x *GetSubscriptionRequest) Reset()func (*GetSubscriptionRequest) String
func (x *GetSubscriptionRequest) String() stringJavaScriptUDF
type JavaScriptUDF struct {
// Required. Name of the JavasScript function that should applied to Pub/Sub
// messages.
FunctionName string `protobuf:"bytes,1,opt,name=function_name,json=functionName,proto3" json:"function_name,omitempty"`
// Required. JavaScript code that contains a function `function_name` with the
// below signature:
//
// ```
//
// /**
// * Transforms a Pub/Sub message.
//
// * @return {(ObjectUser-defined JavaScript function that can transform or filter a Pub/Sub message.
func (*JavaScriptUDF) Descriptor
func (*JavaScriptUDF) Descriptor() ([]byte, []int)Deprecated: Use JavaScriptUDF.ProtoReflect.Descriptor instead.
func (*JavaScriptUDF) GetCode
func (x *JavaScriptUDF) GetCode() stringfunc (*JavaScriptUDF) GetFunctionName
func (x *JavaScriptUDF) GetFunctionName() stringfunc (*JavaScriptUDF) ProtoMessage
func (*JavaScriptUDF) ProtoMessage()func (*JavaScriptUDF) ProtoReflect
func (x *JavaScriptUDF) ProtoReflect() protoreflect.Messagefunc (*JavaScriptUDF) Reset
func (x *JavaScriptUDF) Reset()func (*JavaScriptUDF) String
func (x *JavaScriptUDF) String() stringListDataExchangesRequest
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
func (*ListDataExchangesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListDataExchangesRequest.ProtoReflect.Descriptor instead.
func (*ListDataExchangesRequest) GetPageSize
func (x *ListDataExchangesRequest) GetPageSize() int32func (*ListDataExchangesRequest) GetPageToken
func (x *ListDataExchangesRequest) GetPageToken() stringfunc (*ListDataExchangesRequest) GetParent
func (x *ListDataExchangesRequest) GetParent() stringfunc (*ListDataExchangesRequest) ProtoMessage
func (*ListDataExchangesRequest) ProtoMessage()func (*ListDataExchangesRequest) ProtoReflect
func (x *ListDataExchangesRequest) ProtoReflect() protoreflect.Messagefunc (*ListDataExchangesRequest) Reset
func (x *ListDataExchangesRequest) Reset()func (*ListDataExchangesRequest) String
func (x *ListDataExchangesRequest) String() stringListDataExchangesResponse
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
func (*ListDataExchangesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListDataExchangesResponse.ProtoReflect.Descriptor instead.
func (*ListDataExchangesResponse) GetDataExchanges
func (x *ListDataExchangesResponse) GetDataExchanges() []*DataExchangefunc (*ListDataExchangesResponse) GetNextPageToken
func (x *ListDataExchangesResponse) GetNextPageToken() stringfunc (*ListDataExchangesResponse) ProtoMessage
func (*ListDataExchangesResponse) ProtoMessage()func (*ListDataExchangesResponse) ProtoReflect
func (x *ListDataExchangesResponse) ProtoReflect() protoreflect.Messagefunc (*ListDataExchangesResponse) Reset
func (x *ListDataExchangesResponse) Reset()func (*ListDataExchangesResponse) String
func (x *ListDataExchangesResponse) String() stringListListingsRequest
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
func (*ListListingsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListListingsRequest.ProtoReflect.Descriptor instead.
func (*ListListingsRequest) GetPageSize
func (x *ListListingsRequest) GetPageSize() int32func (*ListListingsRequest) GetPageToken
func (x *ListListingsRequest) GetPageToken() stringfunc (*ListListingsRequest) GetParent
func (x *ListListingsRequest) GetParent() stringfunc (*ListListingsRequest) ProtoMessage
func (*ListListingsRequest) ProtoMessage()func (*ListListingsRequest) ProtoReflect
func (x *ListListingsRequest) ProtoReflect() protoreflect.Messagefunc (*ListListingsRequest) Reset
func (x *ListListingsRequest) Reset()func (*ListListingsRequest) String
func (x *ListListingsRequest) String() stringListListingsResponse
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
func (*ListListingsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListListingsResponse.ProtoReflect.Descriptor instead.
func (*ListListingsResponse) GetListings
func (x *ListListingsResponse) GetListings() []*Listingfunc (*ListListingsResponse) GetNextPageToken
func (x *ListListingsResponse) GetNextPageToken() stringfunc (*ListListingsResponse) ProtoMessage
func (*ListListingsResponse) ProtoMessage()func (*ListListingsResponse) ProtoReflect
func (x *ListListingsResponse) ProtoReflect() protoreflect.Messagefunc (*ListListingsResponse) Reset
func (x *ListListingsResponse) Reset()func (*ListListingsResponse) String
func (x *ListListingsResponse) String() stringListOrgDataExchangesRequest
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
func (*ListOrgDataExchangesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListOrgDataExchangesRequest.ProtoReflect.Descriptor instead.
func (*ListOrgDataExchangesRequest) GetOrganization
func (x *ListOrgDataExchangesRequest) GetOrganization() stringfunc (*ListOrgDataExchangesRequest) GetPageSize
func (x *ListOrgDataExchangesRequest) GetPageSize() int32func (*ListOrgDataExchangesRequest) GetPageToken
func (x *ListOrgDataExchangesRequest) GetPageToken() stringfunc (*ListOrgDataExchangesRequest) ProtoMessage
func (*ListOrgDataExchangesRequest) ProtoMessage()func (*ListOrgDataExchangesRequest) ProtoReflect
func (x *ListOrgDataExchangesRequest) ProtoReflect() protoreflect.Messagefunc (*ListOrgDataExchangesRequest) Reset
func (x *ListOrgDataExchangesRequest) Reset()func (*ListOrgDataExchangesRequest) String
func (x *ListOrgDataExchangesRequest) String() stringListOrgDataExchangesResponse
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
func (*ListOrgDataExchangesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListOrgDataExchangesResponse.ProtoReflect.Descriptor instead.
func (*ListOrgDataExchangesResponse) GetDataExchanges
func (x *ListOrgDataExchangesResponse) GetDataExchanges() []*DataExchangefunc (*ListOrgDataExchangesResponse) GetNextPageToken
func (x *ListOrgDataExchangesResponse) GetNextPageToken() stringfunc (*ListOrgDataExchangesResponse) ProtoMessage
func (*ListOrgDataExchangesResponse) ProtoMessage()func (*ListOrgDataExchangesResponse) ProtoReflect
func (x *ListOrgDataExchangesResponse) ProtoReflect() protoreflect.Messagefunc (*ListOrgDataExchangesResponse) Reset
func (x *ListOrgDataExchangesResponse) Reset()func (*ListOrgDataExchangesResponse) String
func (x *ListOrgDataExchangesResponse) String() stringListQueryTemplatesRequest
type ListQueryTemplatesRequest struct {
// Required. The parent resource path of the QueryTemplates.
// e.g. `projects/myproject/locations/us/dataExchanges/123`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. 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"`
// Optional. 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 QueryTemplates.
func (*ListQueryTemplatesRequest) Descriptor
func (*ListQueryTemplatesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListQueryTemplatesRequest.ProtoReflect.Descriptor instead.
func (*ListQueryTemplatesRequest) GetPageSize
func (x *ListQueryTemplatesRequest) GetPageSize() int32func (*ListQueryTemplatesRequest) GetPageToken
func (x *ListQueryTemplatesRequest) GetPageToken() stringfunc (*ListQueryTemplatesRequest) GetParent
func (x *ListQueryTemplatesRequest) GetParent() stringfunc (*ListQueryTemplatesRequest) ProtoMessage
func (*ListQueryTemplatesRequest) ProtoMessage()func (*ListQueryTemplatesRequest) ProtoReflect
func (x *ListQueryTemplatesRequest) ProtoReflect() protoreflect.Messagefunc (*ListQueryTemplatesRequest) Reset
func (x *ListQueryTemplatesRequest) Reset()func (*ListQueryTemplatesRequest) String
func (x *ListQueryTemplatesRequest) String() stringListQueryTemplatesResponse
type ListQueryTemplatesResponse struct {
// The list of QueryTemplates.
QueryTemplates []*QueryTemplate `protobuf:"bytes,1,rep,name=query_templates,json=queryTemplates,proto3" json:"query_templates,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 QueryTemplates.
func (*ListQueryTemplatesResponse) Descriptor
func (*ListQueryTemplatesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListQueryTemplatesResponse.ProtoReflect.Descriptor instead.
func (*ListQueryTemplatesResponse) GetNextPageToken
func (x *ListQueryTemplatesResponse) GetNextPageToken() stringfunc (*ListQueryTemplatesResponse) GetQueryTemplates
func (x *ListQueryTemplatesResponse) GetQueryTemplates() []*QueryTemplatefunc (*ListQueryTemplatesResponse) ProtoMessage
func (*ListQueryTemplatesResponse) ProtoMessage()func (*ListQueryTemplatesResponse) ProtoReflect
func (x *ListQueryTemplatesResponse) ProtoReflect() protoreflect.Messagefunc (*ListQueryTemplatesResponse) Reset
func (x *ListQueryTemplatesResponse) Reset()func (*ListQueryTemplatesResponse) String
func (x *ListQueryTemplatesResponse) String() stringListSharedResourceSubscriptionsRequest
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 `protobuf:"varint,2,opt,name=include_deleted_subscriptions,json=includeDeletedSubscriptions,proto3" json:"include_deleted_subscriptions,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 of a shared resource.
func (*ListSharedResourceSubscriptionsRequest) Descriptor
func (*ListSharedResourceSubscriptionsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSharedResourceSubscriptionsRequest.ProtoReflect.Descriptor instead.
func (*ListSharedResourceSubscriptionsRequest) GetIncludeDeletedSubscriptions
func (x *ListSharedResourceSubscriptionsRequest) GetIncludeDeletedSubscriptions() boolfunc (*ListSharedResourceSubscriptionsRequest) GetPageSize
func (x *ListSharedResourceSubscriptionsRequest) GetPageSize() int32func (*ListSharedResourceSubscriptionsRequest) GetPageToken
func (x *ListSharedResourceSubscriptionsRequest) GetPageToken() stringfunc (*ListSharedResourceSubscriptionsRequest) GetResource
func (x *ListSharedResourceSubscriptionsRequest) GetResource() stringfunc (*ListSharedResourceSubscriptionsRequest) ProtoMessage
func (*ListSharedResourceSubscriptionsRequest) ProtoMessage()func (*ListSharedResourceSubscriptionsRequest) ProtoReflect
func (x *ListSharedResourceSubscriptionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListSharedResourceSubscriptionsRequest) Reset
func (x *ListSharedResourceSubscriptionsRequest) Reset()func (*ListSharedResourceSubscriptionsRequest) String
func (x *ListSharedResourceSubscriptionsRequest) String() stringListSharedResourceSubscriptionsResponse
type ListSharedResourceSubscriptionsResponse struct {
// The list of subscriptions.
SharedResourceSubscriptions []*Subscription `protobuf:"bytes,1,rep,name=shared_resource_subscriptions,json=sharedResourceSubscriptions,proto3" json:"shared_resource_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 shared resource subscriptions.
func (*ListSharedResourceSubscriptionsResponse) Descriptor
func (*ListSharedResourceSubscriptionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSharedResourceSubscriptionsResponse.ProtoReflect.Descriptor instead.
func (*ListSharedResourceSubscriptionsResponse) GetNextPageToken
func (x *ListSharedResourceSubscriptionsResponse) GetNextPageToken() stringfunc (*ListSharedResourceSubscriptionsResponse) GetSharedResourceSubscriptions
func (x *ListSharedResourceSubscriptionsResponse) GetSharedResourceSubscriptions() []*Subscriptionfunc (*ListSharedResourceSubscriptionsResponse) ProtoMessage
func (*ListSharedResourceSubscriptionsResponse) ProtoMessage()func (*ListSharedResourceSubscriptionsResponse) ProtoReflect
func (x *ListSharedResourceSubscriptionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListSharedResourceSubscriptionsResponse) Reset
func (x *ListSharedResourceSubscriptionsResponse) Reset()func (*ListSharedResourceSubscriptionsResponse) String
func (x *ListSharedResourceSubscriptionsResponse) String() stringListSubscriptionsRequest
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"`
// An expression for filtering the results of the request. Eligible
// fields for filtering are:
//
// - `listing`
// - `data_exchange`
//
// Alternatively, a literal wrapped in double quotes may be provided.
// This will be checked for an exact match against both fields above.
//
// In all cases, the full Data Exchange or Listing resource name must
// be provided. Some example of using filters:
//
// - data_exchange="projects/myproject/locations/us/dataExchanges/123"
// - listing="projects/123/locations/us/dataExchanges/456/listings/789"
// - "projects/myproject/locations/us/dataExchanges/123"
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
func (*ListSubscriptionsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSubscriptionsRequest.ProtoReflect.Descriptor instead.
func (*ListSubscriptionsRequest) GetFilter
func (x *ListSubscriptionsRequest) GetFilter() stringfunc (*ListSubscriptionsRequest) GetPageSize
func (x *ListSubscriptionsRequest) GetPageSize() int32func (*ListSubscriptionsRequest) GetPageToken
func (x *ListSubscriptionsRequest) GetPageToken() stringfunc (*ListSubscriptionsRequest) GetParent
func (x *ListSubscriptionsRequest) GetParent() stringfunc (*ListSubscriptionsRequest) ProtoMessage
func (*ListSubscriptionsRequest) ProtoMessage()func (*ListSubscriptionsRequest) ProtoReflect
func (x *ListSubscriptionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListSubscriptionsRequest) Reset
func (x *ListSubscriptionsRequest) Reset()func (*ListSubscriptionsRequest) String
func (x *ListSubscriptionsRequest) String() stringListSubscriptionsResponse
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
func (*ListSubscriptionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSubscriptionsResponse.ProtoReflect.Descriptor instead.
func (*ListSubscriptionsResponse) GetNextPageToken
func (x *ListSubscriptionsResponse) GetNextPageToken() stringfunc (*ListSubscriptionsResponse) GetSubscriptions
func (x *ListSubscriptionsResponse) GetSubscriptions() []*Subscriptionfunc (*ListSubscriptionsResponse) ProtoMessage
func (*ListSubscriptionsResponse) ProtoMessage()func (*ListSubscriptionsResponse) ProtoReflect
func (x *ListSubscriptionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListSubscriptionsResponse) Reset
func (x *ListSubscriptionsResponse) Reset()func (*ListSubscriptionsResponse) String
func (x *ListSubscriptionsResponse) String() stringListing
type Listing struct {
// Listing source.
//
// Types that are assignable to Source:
//
// *Listing_BigqueryDataset
// *Listing_PubsubTopic
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 five categories are allowed.
Categories []Listing_Category `protobuf:"varint,10,rep,packed,name=categories,proto3,enum=google.cloud.bigquery.analyticshub.v1.Listing_Category" json:"categories,omitempty"`
// 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 `protobuf:"bytes,13,opt,name=restricted_export_config,json=restrictedExportConfig,proto3" json:"restricted_export_config,omitempty"`
// Optional. Type of discovery of the listing on the discovery page.
DiscoveryType *DiscoveryType `protobuf:"varint,14,opt,name=discovery_type,json=discoveryType,proto3,enum=google.cloud.bigquery.analyticshub.v1.DiscoveryType,oneof" json:"discovery_type,omitempty"`
// Output only. Listing shared asset type.
ResourceType SharedResourceType `protobuf:"varint,15,opt,name=resource_type,json=resourceType,proto3,enum=google.cloud.bigquery.analyticshub.v1.SharedResourceType" json:"resource_type,omitempty"`
// Output only. Commercial info contains the information about the commercial
// data products associated with the listing.
CommercialInfo *Listing_CommercialInfo `protobuf:"bytes,17,opt,name=commercial_info,json=commercialInfo,proto3,oneof" json:"commercial_info,omitempty"`
// Optional. By default, false.
// If true, the Listing has an email sharing mandate enabled.
LogLinkedDatasetQueryUserEmail *bool `protobuf:"varint,18,opt,name=log_linked_dataset_query_user_email,json=logLinkedDatasetQueryUserEmail,proto3,oneof" json:"log_linked_dataset_query_user_email,omitempty"`
// Optional. If true, the listing is only available to get the resource
// metadata. Listing is non subscribable.
AllowOnlyMetadataSharing *bool `protobuf:"varint,19,opt,name=allow_only_metadata_sharing,json=allowOnlyMetadataSharing,proto3,oneof" json:"allow_only_metadata_sharing,omitempty"`
// 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: Use Listing.ProtoReflect.Descriptor instead.
func (*Listing) GetAllowOnlyMetadataSharing
func (*Listing) GetBigqueryDataset
func (x *Listing) GetBigqueryDataset() *Listing_BigQueryDatasetSourcefunc (*Listing) GetCategories
func (x *Listing) GetCategories() []Listing_Categoryfunc (*Listing) GetCommercialInfo
func (x *Listing) GetCommercialInfo() *Listing_CommercialInfofunc (*Listing) GetDataProvider
func (x *Listing) GetDataProvider() *DataProviderfunc (*Listing) GetDescription
func (*Listing) GetDiscoveryType
func (x *Listing) GetDiscoveryType() DiscoveryTypefunc (*Listing) GetDisplayName
func (*Listing) GetDocumentation
func (*Listing) GetIcon
func (*Listing) GetLogLinkedDatasetQueryUserEmail
func (*Listing) GetName
func (*Listing) GetPrimaryContact
func (*Listing) GetPublisher
func (*Listing) GetPubsubTopic
func (x *Listing) GetPubsubTopic() *Listing_PubSubTopicSourcefunc (*Listing) GetRequestAccess
func (*Listing) GetResourceType
func (x *Listing) GetResourceType() SharedResourceTypefunc (*Listing) GetRestrictedExportConfig
func (x *Listing) GetRestrictedExportConfig() *Listing_RestrictedExportConfigfunc (*Listing) GetSource
func (m *Listing) GetSource() isListing_Sourcefunc (*Listing) GetState
func (x *Listing) GetState() Listing_Statefunc (*Listing) ProtoMessage
func (*Listing) ProtoMessage()func (*Listing) ProtoReflect
func (x *Listing) ProtoReflect() protoreflect.Messagefunc (*Listing) Reset
func (x *Listing) Reset()func (*Listing) String
Listing_BigQueryDatasetSource
type Listing_BigQueryDatasetSource struct {
// Optional. 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. Resource in this dataset that is selectively shared.
// This field is required for data clean room exchanges.
SelectedResources []*Listing_BigQueryDatasetSource_SelectedResource `protobuf:"bytes,2,rep,name=selected_resources,json=selectedResources,proto3" json:"selected_resources,omitempty"`
// Optional. If set, restricted export policy will be propagated and
// enforced on the linked dataset.
RestrictedExportPolicy *Listing_BigQueryDatasetSource_RestrictedExportPolicy `protobuf:"bytes,3,opt,name=restricted_export_policy,json=restrictedExportPolicy,proto3" json:"restricted_export_policy,omitempty"`
// Optional. A list of regions where the publisher has created shared
// dataset replicas.
ReplicaLocations []string `protobuf:"bytes,5,rep,name=replica_locations,json=replicaLocations,proto3" json:"replica_locations,omitempty"`
// Output only. Server-owned effective state of replicas.
// Contains both primary and secondary replicas.
// Each replica includes a system-computed (output-only) state and primary
// designation.
EffectiveReplicas []*Listing_BigQueryDatasetSource_Replica `protobuf:"bytes,6,rep,name=effective_replicas,json=effectiveReplicas,proto3" json:"effective_replicas,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
func (*Listing_BigQueryDatasetSource) Descriptor() ([]byte, []int)Deprecated: Use Listing_BigQueryDatasetSource.ProtoReflect.Descriptor instead.
func (*Listing_BigQueryDatasetSource) GetDataset
func (x *Listing_BigQueryDatasetSource) GetDataset() stringfunc (*Listing_BigQueryDatasetSource) GetEffectiveReplicas
func (x *Listing_BigQueryDatasetSource) GetEffectiveReplicas() []*Listing_BigQueryDatasetSource_Replicafunc (*Listing_BigQueryDatasetSource) GetReplicaLocations
func (x *Listing_BigQueryDatasetSource) GetReplicaLocations() []stringfunc (*Listing_BigQueryDatasetSource) GetRestrictedExportPolicy
func (x *Listing_BigQueryDatasetSource) GetRestrictedExportPolicy() *Listing_BigQueryDatasetSource_RestrictedExportPolicyfunc (*Listing_BigQueryDatasetSource) GetSelectedResources
func (x *Listing_BigQueryDatasetSource) GetSelectedResources() []*Listing_BigQueryDatasetSource_SelectedResourcefunc (*Listing_BigQueryDatasetSource) ProtoMessage
func (*Listing_BigQueryDatasetSource) ProtoMessage()func (*Listing_BigQueryDatasetSource) ProtoReflect
func (x *Listing_BigQueryDatasetSource) ProtoReflect() protoreflect.Messagefunc (*Listing_BigQueryDatasetSource) Reset
func (x *Listing_BigQueryDatasetSource) Reset()func (*Listing_BigQueryDatasetSource) String
func (x *Listing_BigQueryDatasetSource) String() stringListing_BigQueryDatasetSource_Replica
type Listing_BigQueryDatasetSource_Replica struct {
// Output only. The geographic location where the replica resides. See
// [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
// for supported locations. Eg. "us-central1".
Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
// Output only. Assigned by Analytics Hub based on real BigQuery
// replication state.
ReplicaState Listing_BigQueryDatasetSource_Replica_ReplicaState `protobuf:"varint,2,opt,name=replica_state,json=replicaState,proto3,enum=google.cloud.bigquery.analyticshub.v1.Listing_BigQueryDatasetSource_Replica_ReplicaState" json:"replica_state,omitempty"`
// Output only. Indicates that this replica is the primary replica.
PrimaryState *Listing_BigQueryDatasetSource_Replica_PrimaryState `protobuf:"varint,3,opt,name=primary_state,json=primaryState,proto3,enum=google.cloud.bigquery.analyticshub.v1.Listing_BigQueryDatasetSource_Replica_PrimaryState,oneof" json:"primary_state,omitempty"`
// contains filtered or unexported fields
}Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica.
func (*Listing_BigQueryDatasetSource_Replica) Descriptor
func (*Listing_BigQueryDatasetSource_Replica) Descriptor() ([]byte, []int)Deprecated: Use Listing_BigQueryDatasetSource_Replica.ProtoReflect.Descriptor instead.
func (*Listing_BigQueryDatasetSource_Replica) GetLocation
func (x *Listing_BigQueryDatasetSource_Replica) GetLocation() stringfunc (*Listing_BigQueryDatasetSource_Replica) GetPrimaryState
func (x *Listing_BigQueryDatasetSource_Replica) GetPrimaryState() Listing_BigQueryDatasetSource_Replica_PrimaryStatefunc (*Listing_BigQueryDatasetSource_Replica) GetReplicaState
func (x *Listing_BigQueryDatasetSource_Replica) GetReplicaState() Listing_BigQueryDatasetSource_Replica_ReplicaStatefunc (*Listing_BigQueryDatasetSource_Replica) ProtoMessage
func (*Listing_BigQueryDatasetSource_Replica) ProtoMessage()func (*Listing_BigQueryDatasetSource_Replica) ProtoReflect
func (x *Listing_BigQueryDatasetSource_Replica) ProtoReflect() protoreflect.Messagefunc (*Listing_BigQueryDatasetSource_Replica) Reset
func (x *Listing_BigQueryDatasetSource_Replica) Reset()func (*Listing_BigQueryDatasetSource_Replica) String
func (x *Listing_BigQueryDatasetSource_Replica) String() stringListing_BigQueryDatasetSource_Replica_PrimaryState
type Listing_BigQueryDatasetSource_Replica_PrimaryState int32Primary state of the replica. Set only for the primary replica.
Listing_BigQueryDatasetSource_Replica_PRIMARY_STATE_UNSPECIFIED, Listing_BigQueryDatasetSource_Replica_PRIMARY_REPLICA
const (
// Default value. This value is unused.
Listing_BigQueryDatasetSource_Replica_PRIMARY_STATE_UNSPECIFIED Listing_BigQueryDatasetSource_Replica_PrimaryState = 0
// The replica is the primary replica.
Listing_BigQueryDatasetSource_Replica_PRIMARY_REPLICA Listing_BigQueryDatasetSource_Replica_PrimaryState = 1
)func (Listing_BigQueryDatasetSource_Replica_PrimaryState) Descriptor
func (Listing_BigQueryDatasetSource_Replica_PrimaryState) Descriptor() protoreflect.EnumDescriptorfunc (Listing_BigQueryDatasetSource_Replica_PrimaryState) Enum
func (x Listing_BigQueryDatasetSource_Replica_PrimaryState) Enum() *Listing_BigQueryDatasetSource_Replica_PrimaryStatefunc (Listing_BigQueryDatasetSource_Replica_PrimaryState) EnumDescriptor
func (Listing_BigQueryDatasetSource_Replica_PrimaryState) EnumDescriptor() ([]byte, []int)Deprecated: Use Listing_BigQueryDatasetSource_Replica_PrimaryState.Descriptor instead.
func (Listing_BigQueryDatasetSource_Replica_PrimaryState) Number
func (x Listing_BigQueryDatasetSource_Replica_PrimaryState) Number() protoreflect.EnumNumberfunc (Listing_BigQueryDatasetSource_Replica_PrimaryState) String
func (x Listing_BigQueryDatasetSource_Replica_PrimaryState) String() stringfunc (Listing_BigQueryDatasetSource_Replica_PrimaryState) Type
Listing_BigQueryDatasetSource_Replica_ReplicaState
type Listing_BigQueryDatasetSource_Replica_ReplicaState int32Replica state of the shared dataset.
Listing_BigQueryDatasetSource_Replica_REPLICA_STATE_UNSPECIFIED, Listing_BigQueryDatasetSource_Replica_READY_TO_USE, Listing_BigQueryDatasetSource_Replica_UNAVAILABLE
const (
// Default value. This value is unused.
Listing_BigQueryDatasetSource_Replica_REPLICA_STATE_UNSPECIFIED Listing_BigQueryDatasetSource_Replica_ReplicaState = 0
// The replica is backfilled and ready to use.
Listing_BigQueryDatasetSource_Replica_READY_TO_USE Listing_BigQueryDatasetSource_Replica_ReplicaState = 1
// The replica is unavailable, does not exist, or has not been
// backfilled yet.
Listing_BigQueryDatasetSource_Replica_UNAVAILABLE Listing_BigQueryDatasetSource_Replica_ReplicaState = 2
)func (Listing_BigQueryDatasetSource_Replica_ReplicaState) Descriptor
func (Listing_BigQueryDatasetSource_Replica_ReplicaState) Descriptor() protoreflect.EnumDescriptorfunc (Listing_BigQueryDatasetSource_Replica_ReplicaState) Enum
func (x Listing_BigQueryDatasetSource_Replica_ReplicaState) Enum() *Listing_BigQueryDatasetSource_Replica_ReplicaStatefunc (Listing_BigQueryDatasetSource_Replica_ReplicaState) EnumDescriptor
func (Listing_BigQueryDatasetSource_Replica_ReplicaState) EnumDescriptor() ([]byte, []int)Deprecated: Use Listing_BigQueryDatasetSource_Replica_ReplicaState.Descriptor instead.
func (Listing_BigQueryDatasetSource_Replica_ReplicaState) Number
func (x Listing_BigQueryDatasetSource_Replica_ReplicaState) Number() protoreflect.EnumNumberfunc (Listing_BigQueryDatasetSource_Replica_ReplicaState) String
func (x Listing_BigQueryDatasetSource_Replica_ReplicaState) String() stringfunc (Listing_BigQueryDatasetSource_Replica_ReplicaState) Type
Listing_BigQueryDatasetSource_RestrictedExportPolicy
type Listing_BigQueryDatasetSource_RestrictedExportPolicy struct {
// Optional. If true, enable restricted export.
Enabled *wrapperspb.BoolValue `protobuf:"bytes,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
// Optional. If true, restrict direct table access (read
// api/tabledata.list) on linked table.
RestrictDirectTableAccess *wrapperspb.BoolValue `protobuf:"bytes,2,opt,name=restrict_direct_table_access,json=restrictDirectTableAccess,proto3" json:"restrict_direct_table_access,omitempty"`
// Optional. If true, restrict export of query result derived from
// restricted linked dataset table.
RestrictQueryResult *wrapperspb.BoolValue `protobuf:"bytes,3,opt,name=restrict_query_result,json=restrictQueryResult,proto3" json:"restrict_query_result,omitempty"`
// contains filtered or unexported fields
}Restricted export policy used to configure restricted export on linked dataset.
func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) Descriptor
func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) Descriptor() ([]byte, []int)Deprecated: Use Listing_BigQueryDatasetSource_RestrictedExportPolicy.ProtoReflect.Descriptor instead.
func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) GetEnabled
func (x *Listing_BigQueryDatasetSource_RestrictedExportPolicy) GetEnabled() *wrapperspb.BoolValuefunc (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) GetRestrictDirectTableAccess
func (x *Listing_BigQueryDatasetSource_RestrictedExportPolicy) GetRestrictDirectTableAccess() *wrapperspb.BoolValuefunc (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) GetRestrictQueryResult
func (x *Listing_BigQueryDatasetSource_RestrictedExportPolicy) GetRestrictQueryResult() *wrapperspb.BoolValuefunc (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) ProtoMessage
func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) ProtoMessage()func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) ProtoReflect
func (x *Listing_BigQueryDatasetSource_RestrictedExportPolicy) ProtoReflect() protoreflect.Messagefunc (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) Reset
func (x *Listing_BigQueryDatasetSource_RestrictedExportPolicy) Reset()func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) String
func (x *Listing_BigQueryDatasetSource_RestrictedExportPolicy) String() stringListing_BigQueryDatasetSource_SelectedResource
type Listing_BigQueryDatasetSource_SelectedResource struct {
// Types that are assignable to Resource:
//
// *Listing_BigQueryDatasetSource_SelectedResource_Table
// *Listing_BigQueryDatasetSource_SelectedResource_Routine
Resource isListing_BigQueryDatasetSource_SelectedResource_Resource `protobuf_oneof:"resource"`
// contains filtered or unexported fields
}Resource in this dataset that is selectively shared.
func (*Listing_BigQueryDatasetSource_SelectedResource) Descriptor
func (*Listing_BigQueryDatasetSource_SelectedResource) Descriptor() ([]byte, []int)Deprecated: Use Listing_BigQueryDatasetSource_SelectedResource.ProtoReflect.Descriptor instead.
func (*Listing_BigQueryDatasetSource_SelectedResource) GetResource
func (m *Listing_BigQueryDatasetSource_SelectedResource) GetResource() isListing_BigQueryDatasetSource_SelectedResource_Resourcefunc (*Listing_BigQueryDatasetSource_SelectedResource) GetRoutine
func (x *Listing_BigQueryDatasetSource_SelectedResource) GetRoutine() stringfunc (*Listing_BigQueryDatasetSource_SelectedResource) GetTable
func (x *Listing_BigQueryDatasetSource_SelectedResource) GetTable() stringfunc (*Listing_BigQueryDatasetSource_SelectedResource) ProtoMessage
func (*Listing_BigQueryDatasetSource_SelectedResource) ProtoMessage()func (*Listing_BigQueryDatasetSource_SelectedResource) ProtoReflect
func (x *Listing_BigQueryDatasetSource_SelectedResource) ProtoReflect() protoreflect.Messagefunc (*Listing_BigQueryDatasetSource_SelectedResource) Reset
func (x *Listing_BigQueryDatasetSource_SelectedResource) Reset()func (*Listing_BigQueryDatasetSource_SelectedResource) String
func (x *Listing_BigQueryDatasetSource_SelectedResource) String() stringListing_BigQueryDatasetSource_SelectedResource_Routine
type Listing_BigQueryDatasetSource_SelectedResource_Routine struct {
// Optional. Format:
// For routine:
// `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
// Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
Routine string `protobuf:"bytes,2,opt,name=routine,proto3,oneof"`
}Listing_BigQueryDatasetSource_SelectedResource_Table
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"`
}Listing_BigqueryDataset
type Listing_BigqueryDataset struct {
// Shared dataset i.e. BigQuery dataset source.
BigqueryDataset *Listing_BigQueryDatasetSource `protobuf:"bytes,6,opt,name=bigquery_dataset,json=bigqueryDataset,proto3,oneof"`
}Listing_Category
type Listing_Category int32Listing categories.
Listing_CATEGORY_UNSPECIFIED, Listing_CATEGORY_OTHERS, Listing_CATEGORY_ADVERTISING_AND_MARKETING, Listing_CATEGORY_COMMERCE, Listing_CATEGORY_CLIMATE_AND_ENVIRONMENT, Listing_CATEGORY_DEMOGRAPHICS, Listing_CATEGORY_ECONOMICS, Listing_CATEGORY_EDUCATION, Listing_CATEGORY_ENERGY, Listing_CATEGORY_FINANCIAL, Listing_CATEGORY_GAMING, Listing_CATEGORY_GEOSPATIAL, Listing_CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE, Listing_CATEGORY_MEDIA, Listing_CATEGORY_PUBLIC_SECTOR, Listing_CATEGORY_RETAIL, Listing_CATEGORY_SPORTS, Listing_CATEGORY_SCIENCE_AND_RESEARCH, Listing_CATEGORY_TRANSPORTATION_AND_LOGISTICS, Listing_CATEGORY_TRAVEL_AND_TOURISM, Listing_CATEGORY_GOOGLE_EARTH_ENGINE
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
Listing_CATEGORY_GOOGLE_EARTH_ENGINE Listing_Category = 20
)func (Listing_Category) Descriptor
func (Listing_Category) Descriptor() protoreflect.EnumDescriptorfunc (Listing_Category) Enum
func (x Listing_Category) Enum() *Listing_Categoryfunc (Listing_Category) EnumDescriptor
func (Listing_Category) EnumDescriptor() ([]byte, []int)Deprecated: Use Listing_Category.Descriptor instead.
func (Listing_Category) Number
func (x Listing_Category) Number() protoreflect.EnumNumberfunc (Listing_Category) String
func (x Listing_Category) String() stringfunc (Listing_Category) Type
func (Listing_Category) Type() protoreflect.EnumTypeListing_CommercialInfo
type Listing_CommercialInfo struct {
// Output only. Details of the Marketplace Data Product associated with the
// Listing.
CloudMarketplace *Listing_CommercialInfo_GoogleCloudMarketplaceInfo `protobuf:"bytes,1,opt,name=cloud_marketplace,json=cloudMarketplace,proto3,oneof" json:"cloud_marketplace,omitempty"`
// contains filtered or unexported fields
}Commercial info contains the information about the commercial data products associated with the listing.
func (*Listing_CommercialInfo) Descriptor
func (*Listing_CommercialInfo) Descriptor() ([]byte, []int)Deprecated: Use Listing_CommercialInfo.ProtoReflect.Descriptor instead.
func (*Listing_CommercialInfo) GetCloudMarketplace
func (x *Listing_CommercialInfo) GetCloudMarketplace() *Listing_CommercialInfo_GoogleCloudMarketplaceInfofunc (*Listing_CommercialInfo) ProtoMessage
func (*Listing_CommercialInfo) ProtoMessage()func (*Listing_CommercialInfo) ProtoReflect
func (x *Listing_CommercialInfo) ProtoReflect() protoreflect.Messagefunc (*Listing_CommercialInfo) Reset
func (x *Listing_CommercialInfo) Reset()func (*Listing_CommercialInfo) String
func (x *Listing_CommercialInfo) String() stringListing_CommercialInfo_GoogleCloudMarketplaceInfo
type Listing_CommercialInfo_GoogleCloudMarketplaceInfo struct {
// Output only. Resource name of the commercial service associated with
// the Marketplace Data Product. e.g. example.com
Service *string `protobuf:"bytes,1,opt,name=service,proto3,oneof" json:"service,omitempty"`
// Output only. Commercial state of the Marketplace Data Product.
CommercialState *Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState `protobuf:"varint,3,opt,name=commercial_state,json=commercialState,proto3,enum=google.cloud.bigquery.analyticshub.v1.Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState,oneof" json:"commercial_state,omitempty"`
// contains filtered or unexported fields
}Specifies the details of the Marketplace Data Product associated with the Listing.
func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) Descriptor
func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) Descriptor() ([]byte, []int)Deprecated: Use Listing_CommercialInfo_GoogleCloudMarketplaceInfo.ProtoReflect.Descriptor instead.
func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) GetCommercialState
func (x *Listing_CommercialInfo_GoogleCloudMarketplaceInfo) GetCommercialState() Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialStatefunc (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) GetService
func (x *Listing_CommercialInfo_GoogleCloudMarketplaceInfo) GetService() stringfunc (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoMessage
func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoMessage()func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoReflect
func (x *Listing_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoReflect() protoreflect.Messagefunc (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) Reset
func (x *Listing_CommercialInfo_GoogleCloudMarketplaceInfo) Reset()func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) String
func (x *Listing_CommercialInfo_GoogleCloudMarketplaceInfo) String() stringListing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState
type Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState int32Indicates whether this commercial access is currently active.
Listing_CommercialInfo_GoogleCloudMarketplaceInfo_COMMERCIAL_STATE_UNSPECIFIED, Listing_CommercialInfo_GoogleCloudMarketplaceInfo_ONBOARDING, Listing_CommercialInfo_GoogleCloudMarketplaceInfo_ACTIVE
const (
// Commercialization is incomplete and cannot be used.
Listing_CommercialInfo_GoogleCloudMarketplaceInfo_COMMERCIAL_STATE_UNSPECIFIED Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState = 0
// Commercialization has been initialized.
Listing_CommercialInfo_GoogleCloudMarketplaceInfo_ONBOARDING Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState = 1
// Commercialization is complete and available for use.
Listing_CommercialInfo_GoogleCloudMarketplaceInfo_ACTIVE Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState = 2
)func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Descriptor
func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Descriptor() protoreflect.EnumDescriptorfunc (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Enum
func (x Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Enum() *Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialStatefunc (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) EnumDescriptor
func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) EnumDescriptor() ([]byte, []int)Deprecated: Use Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState.Descriptor instead.
func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Number
func (x Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Number() protoreflect.EnumNumberfunc (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) String
func (x Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) String() stringfunc (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Type
func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Type() protoreflect.EnumTypeListing_PubSubTopicSource
type Listing_PubSubTopicSource struct {
// Required. Resource name of the Pub/Sub topic source for this listing.
// e.g. projects/myproject/topics/topicId
Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
// Optional. Region hint on where the data might be published. Data affinity
// regions are modifiable. See https://cloud.google.com/about/locations for
// full listing of possible Cloud regions.
DataAffinityRegions []string `protobuf:"bytes,2,rep,name=data_affinity_regions,json=dataAffinityRegions,proto3" json:"data_affinity_regions,omitempty"`
// contains filtered or unexported fields
}Pub/Sub topic source.
func (*Listing_PubSubTopicSource) Descriptor
func (*Listing_PubSubTopicSource) Descriptor() ([]byte, []int)Deprecated: Use Listing_PubSubTopicSource.ProtoReflect.Descriptor instead.
func (*Listing_PubSubTopicSource) GetDataAffinityRegions
func (x *Listing_PubSubTopicSource) GetDataAffinityRegions() []stringfunc (*Listing_PubSubTopicSource) GetTopic
func (x *Listing_PubSubTopicSource) GetTopic() stringfunc (*Listing_PubSubTopicSource) ProtoMessage
func (*Listing_PubSubTopicSource) ProtoMessage()func (*Listing_PubSubTopicSource) ProtoReflect
func (x *Listing_PubSubTopicSource) ProtoReflect() protoreflect.Messagefunc (*Listing_PubSubTopicSource) Reset
func (x *Listing_PubSubTopicSource) Reset()func (*Listing_PubSubTopicSource) String
func (x *Listing_PubSubTopicSource) String() stringListing_PubsubTopic
type Listing_PubsubTopic struct {
// Pub/Sub topic source.
PubsubTopic *Listing_PubSubTopicSource `protobuf:"bytes,16,opt,name=pubsub_topic,json=pubsubTopic,proto3,oneof"`
}Listing_RestrictedExportConfig
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 `protobuf:"varint,1,opt,name=restrict_direct_table_access,json=restrictDirectTableAccess,proto3" json:"restrict_direct_table_access,omitempty"`
// 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
func (*Listing_RestrictedExportConfig) Descriptor() ([]byte, []int)Deprecated: Use Listing_RestrictedExportConfig.ProtoReflect.Descriptor instead.
func (*Listing_RestrictedExportConfig) GetEnabled
func (x *Listing_RestrictedExportConfig) GetEnabled() boolfunc (*Listing_RestrictedExportConfig) GetRestrictDirectTableAccess
func (x *Listing_RestrictedExportConfig) GetRestrictDirectTableAccess() boolfunc (*Listing_RestrictedExportConfig) GetRestrictQueryResult
func (x *Listing_RestrictedExportConfig) GetRestrictQueryResult() boolfunc (*Listing_RestrictedExportConfig) ProtoMessage
func (*Listing_RestrictedExportConfig) ProtoMessage()func (*Listing_RestrictedExportConfig) ProtoReflect
func (x *Listing_RestrictedExportConfig) ProtoReflect() protoreflect.Messagefunc (*Listing_RestrictedExportConfig) Reset
func (x *Listing_RestrictedExportConfig) Reset()func (*Listing_RestrictedExportConfig) String
func (x *Listing_RestrictedExportConfig) String() stringListing_State
type Listing_State int32State of the listing.
Listing_STATE_UNSPECIFIED, Listing_ACTIVE
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) Descriptor() protoreflect.EnumDescriptorfunc (Listing_State) Enum
func (x Listing_State) Enum() *Listing_Statefunc (Listing_State) EnumDescriptor
func (Listing_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Listing_State.Descriptor instead.
func (Listing_State) Number
func (x Listing_State) Number() protoreflect.EnumNumberfunc (Listing_State) String
func (x Listing_State) String() stringfunc (Listing_State) Type
func (Listing_State) Type() protoreflect.EnumTypeMessageTransform
type MessageTransform struct {
// The type of transform to apply to messages.
//
// Types that are assignable to Transform:
//
// *MessageTransform_JavascriptUdf
Transform isMessageTransform_Transform `protobuf_oneof:"transform"`
// Optional. This field is deprecated, use the `disabled` field to disable
// transforms.
//
// Deprecated: Marked as deprecated in google/cloud/bigquery/analyticshub/v1/pubsub.proto.
Enabled bool `protobuf:"varint,3,opt,name=enabled,proto3" json:"enabled,omitempty"`
// Optional. If true, the transform is disabled and will not be applied to
// messages. Defaults to `false`.
Disabled bool `protobuf:"varint,4,opt,name=disabled,proto3" json:"disabled,omitempty"`
// contains filtered or unexported fields
}All supported message transforms types.
func (*MessageTransform) Descriptor
func (*MessageTransform) Descriptor() ([]byte, []int)Deprecated: Use MessageTransform.ProtoReflect.Descriptor instead.
func (*MessageTransform) GetDisabled
func (x *MessageTransform) GetDisabled() boolfunc (*MessageTransform) GetEnabled
func (x *MessageTransform) GetEnabled() boolDeprecated: Marked as deprecated in google/cloud/bigquery/analyticshub/v1/pubsub.proto.
func (*MessageTransform) GetJavascriptUdf
func (x *MessageTransform) GetJavascriptUdf() *JavaScriptUDFfunc (*MessageTransform) GetTransform
func (m *MessageTransform) GetTransform() isMessageTransform_Transformfunc (*MessageTransform) ProtoMessage
func (*MessageTransform) ProtoMessage()func (*MessageTransform) ProtoReflect
func (x *MessageTransform) ProtoReflect() protoreflect.Messagefunc (*MessageTransform) Reset
func (x *MessageTransform) Reset()func (*MessageTransform) String
func (x *MessageTransform) String() stringMessageTransform_JavascriptUdf
type MessageTransform_JavascriptUdf struct {
// Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's
// are specified on a resource, each must have a unique `function_name`.
JavascriptUdf *JavaScriptUDF `protobuf:"bytes,2,opt,name=javascript_udf,json=javascriptUdf,proto3,oneof"`
}OperationMetadata
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
func (*OperationMetadata) Descriptor() ([]byte, []int)Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion
func (x *OperationMetadata) GetApiVersion() stringfunc (*OperationMetadata) GetCreateTime
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestampfunc (*OperationMetadata) GetEndTime
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestampfunc (*OperationMetadata) GetRequestedCancellation
func (x *OperationMetadata) GetRequestedCancellation() boolfunc (*OperationMetadata) GetStatusMessage
func (x *OperationMetadata) GetStatusMessage() stringfunc (*OperationMetadata) GetTarget
func (x *OperationMetadata) GetTarget() stringfunc (*OperationMetadata) GetVerb
func (x *OperationMetadata) GetVerb() stringfunc (*OperationMetadata) ProtoMessage
func (*OperationMetadata) ProtoMessage()func (*OperationMetadata) ProtoReflect
func (x *OperationMetadata) ProtoReflect() protoreflect.Messagefunc (*OperationMetadata) Reset
func (x *OperationMetadata) Reset()func (*OperationMetadata) String
func (x *OperationMetadata) String() stringPubSubSubscription
type PubSubSubscription struct {
// Required. Name of the subscription.
// Format is `projects/{project}/subscriptions/{sub}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. If push delivery is used with this subscription, this field is
// used to configure it.
PushConfig *PushConfig `protobuf:"bytes,4,opt,name=push_config,json=pushConfig,proto3" json:"push_config,omitempty"`
// Optional. If delivery to BigQuery is used with this subscription, this
// field is used to configure it.
BigqueryConfig *BigQueryConfig `protobuf:"bytes,18,opt,name=bigquery_config,json=bigqueryConfig,proto3" json:"bigquery_config,omitempty"`
// Optional. If delivery to Google Cloud Storage is used with this
// subscription, this field is used to configure it.
CloudStorageConfig *CloudStorageConfig `protobuf:"bytes,22,opt,name=cloud_storage_config,json=cloudStorageConfig,proto3" json:"cloud_storage_config,omitempty"`
// Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
// waits for the subscriber to acknowledge receipt before resending the
// message. In the interval after the message is delivered and before it is
// acknowledged, it is considered to be _outstanding_. During that time
// period, the message will not be redelivered (on a best-effort basis).
//
// For pull subscriptions, this value is used as the initial value for the ack
// deadline. To override this value for a given message, call
// `ModifyAckDeadline` with the corresponding `ack_id` if using
// non-streaming pull or send the `ack_id` in a
// `StreamingModifyAckDeadlineRequest` if using streaming pull.
// The minimum custom deadline you can specify is 10 seconds.
// The maximum custom deadline you can specify is 600 seconds (10 minutes).
// If this parameter is 0, a default value of 10 seconds is used.
//
// For push delivery, this value is also used to set the request timeout for
// the call to the push endpoint.
//
// If the subscriber never acknowledges the message, the Pub/Sub
// system will eventually redeliver the message.
AckDeadlineSeconds int32 `protobuf:"varint,5,opt,name=ack_deadline_seconds,json=ackDeadlineSeconds,proto3" json:"ack_deadline_seconds,omitempty"`
// Optional. Indicates whether to retain acknowledged messages. If true, then
// messages are not expunged from the subscription's backlog, even if they are
// acknowledged, until they fall out of the `message_retention_duration`
// window. This must be true if you would like to [`Seek` to a timestamp]
// (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
// the past to replay previously-acknowledged messages.
RetainAckedMessages bool `protobuf:"varint,7,opt,name=retain_acked_messages,json=retainAckedMessages,proto3" json:"retain_acked_messages,omitempty"`
// Optional. How long to retain unacknowledged messages in the subscription's
// backlog, from the moment a message is published. If `retain_acked_messages`
// is true, then this also configures the retention of acknowledged messages,
// and thus configures how far back in time a `Seek` can be done. Defaults to
// 7 days. Cannot be more than 31 days or less than 10 minutes.
MessageRetentionDuration *durationpb.Duration `protobuf:"bytes,8,opt,name=message_retention_duration,json=messageRetentionDuration,proto3" json:"message_retention_duration,omitempty"`
// Optional. See [Creating and managing
// labels](https://cloud.google.com/pubsub/docs/labels).
Labels map[string]string `protobuf:"bytes,9,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. If true, messages published with the same `ordering_key` in
// `PubsubMessage` will be delivered to the subscribers in the order in which
// they are received by the Pub/Sub system. Otherwise, they may be delivered
// in any order.
EnableMessageOrdering bool `protobuf:"varint,10,opt,name=enable_message_ordering,json=enableMessageOrdering,proto3" json:"enable_message_ordering,omitempty"`
// Optional. A policy that specifies the conditions for this subscription's
// expiration. A subscription is considered active as long as any connected
// subscriber is successfully consuming messages from the subscription or is
// issuing operations on the subscription. If `expiration_policy` is not set,
// a *default policy* with `ttl` of 31 days will be used. The minimum allowed
// value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
// but `expiration_policy.ttl` is not set, the subscription never expires.
ExpirationPolicy *ExpirationPolicy `protobuf:"bytes,11,opt,name=expiration_policy,json=expirationPolicy,proto3" json:"expiration_policy,omitempty"`
// Optional. An expression written in the Pub/Sub [filter
// language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
// then only `PubsubMessage`s whose `attributes` field matches the filter are
// delivered on this subscription. If empty, then no messages are filtered
// out.
Filter string `protobuf:"bytes,12,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. A policy that specifies the conditions for dead lettering
// messages in this subscription. If dead_letter_policy is not set, dead
// lettering is disabled.
//
// The Pub/Sub service account associated with this subscriptions's
// parent project (i.e.,
// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
// permission to Acknowledge() messages on this subscription.
DeadLetterPolicy *DeadLetterPolicy `protobuf:"bytes,13,opt,name=dead_letter_policy,json=deadLetterPolicy,proto3" json:"dead_letter_policy,omitempty"`
// Optional. A policy that specifies how Pub/Sub retries message delivery for
// this subscription.
//
// If not set, the default retry policy is applied. This generally implies
// that messages will be retried as soon as possible for healthy subscribers.
// RetryPolicy will be triggered on NACKs or acknowledgement deadline
// exceeded events for a given message.
RetryPolicy *RetryPolicy `protobuf:"bytes,14,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
// Optional. Indicates whether the subscription is detached from its topic.
// Detached subscriptions don't receive messages from their topic and don't
// retain any backlog. `Pull` and `StreamingPull` requests will return
// FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
// the endpoint will not be made.
Detached bool `protobuf:"varint,15,opt,name=detached,proto3" json:"detached,omitempty"`
// Optional. If true, Pub/Sub provides the following guarantees for the
// delivery of a message with a given value of `message_id` on this
// subscription:
//
// * The message sent to a subscriber is guaranteed not to be resent
// before the message's acknowledgement deadline expires.
// * An acknowledged message will not be resent to a subscriber.
//
// Note that subscribers may still receive multiple copies of a message
// when `enable_exactly_once_delivery` is true if the message was published
// multiple times by a publisher client. These copies are considered distinct
// by Pub/Sub and have distinct `message_id` values.
EnableExactlyOnceDelivery bool `protobuf:"varint,16,opt,name=enable_exactly_once_delivery,json=enableExactlyOnceDelivery,proto3" json:"enable_exactly_once_delivery,omitempty"`
// Optional. Transforms to be applied to messages before they are delivered to
// subscribers. Transforms are applied in the order specified.
MessageTransforms []*MessageTransform `protobuf:"bytes,25,rep,name=message_transforms,json=messageTransforms,proto3" json:"message_transforms,omitempty"`
// contains filtered or unexported fields
}Defines the destination Pub/Sub subscription.
If none of push_config, bigquery_config, cloud_storage_config,
pubsub_export_config, or pubsublite_export_config
is set, then the subscriber will pull and ack messages using API methods. At
most one of these fields may be set.
func (*PubSubSubscription) Descriptor
func (*PubSubSubscription) Descriptor() ([]byte, []int)Deprecated: Use PubSubSubscription.ProtoReflect.Descriptor instead.
func (*PubSubSubscription) GetAckDeadlineSeconds
func (x *PubSubSubscription) GetAckDeadlineSeconds() int32func (*PubSubSubscription) GetBigqueryConfig
func (x *PubSubSubscription) GetBigqueryConfig() *BigQueryConfigfunc (*PubSubSubscription) GetCloudStorageConfig
func (x *PubSubSubscription) GetCloudStorageConfig() *CloudStorageConfigfunc (*PubSubSubscription) GetDeadLetterPolicy
func (x *PubSubSubscription) GetDeadLetterPolicy() *DeadLetterPolicyfunc (*PubSubSubscription) GetDetached
func (x *PubSubSubscription) GetDetached() boolfunc (*PubSubSubscription) GetEnableExactlyOnceDelivery
func (x *PubSubSubscription) GetEnableExactlyOnceDelivery() boolfunc (*PubSubSubscription) GetEnableMessageOrdering
func (x *PubSubSubscription) GetEnableMessageOrdering() boolfunc (*PubSubSubscription) GetExpirationPolicy
func (x *PubSubSubscription) GetExpirationPolicy() *ExpirationPolicyfunc (*PubSubSubscription) GetFilter
func (x *PubSubSubscription) GetFilter() stringfunc (*PubSubSubscription) GetLabels
func (x *PubSubSubscription) GetLabels() map[string]stringfunc (*PubSubSubscription) GetMessageRetentionDuration
func (x *PubSubSubscription) GetMessageRetentionDuration() *durationpb.Durationfunc (*PubSubSubscription) GetMessageTransforms
func (x *PubSubSubscription) GetMessageTransforms() []*MessageTransformfunc (*PubSubSubscription) GetName
func (x *PubSubSubscription) GetName() stringfunc (*PubSubSubscription) GetPushConfig
func (x *PubSubSubscription) GetPushConfig() *PushConfigfunc (*PubSubSubscription) GetRetainAckedMessages
func (x *PubSubSubscription) GetRetainAckedMessages() boolfunc (*PubSubSubscription) GetRetryPolicy
func (x *PubSubSubscription) GetRetryPolicy() *RetryPolicyfunc (*PubSubSubscription) ProtoMessage
func (*PubSubSubscription) ProtoMessage()func (*PubSubSubscription) ProtoReflect
func (x *PubSubSubscription) ProtoReflect() protoreflect.Messagefunc (*PubSubSubscription) Reset
func (x *PubSubSubscription) Reset()func (*PubSubSubscription) String
func (x *PubSubSubscription) String() stringPublisher
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: Use Publisher.ProtoReflect.Descriptor instead.
func (*Publisher) GetName
func (*Publisher) GetPrimaryContact
func (*Publisher) ProtoMessage
func (*Publisher) ProtoMessage()func (*Publisher) ProtoReflect
func (x *Publisher) ProtoReflect() protoreflect.Messagefunc (*Publisher) Reset
func (x *Publisher) Reset()func (*Publisher) String
PushConfig
type PushConfig struct {
// An authentication method used by push endpoints to verify the source of
// push requests. This can be used with push endpoints that are private by
// default to allow requests only from the Pub/Sub system, for example.
// This field is optional and should be set only by users interested in
// authenticated push.
//
// Types that are assignable to AuthenticationMethod:
//
// *PushConfig_OidcToken_
AuthenticationMethod isPushConfig_AuthenticationMethod `protobuf_oneof:"authentication_method"`
// The format of the delivered message to the push endpoint is defined by
// the chosen wrapper. When unset, `PubsubWrapper` is used.
//
// Types that are assignable to Wrapper:
//
// *PushConfig_PubsubWrapper_
// *PushConfig_NoWrapper_
Wrapper isPushConfig_Wrapper `protobuf_oneof:"wrapper"`
// Optional. A URL locating the endpoint to which messages should be pushed.
// For example, a Webhook endpoint might use `https://example.com/push`.
PushEndpoint string `protobuf:"bytes,1,opt,name=push_endpoint,json=pushEndpoint,proto3" json:"push_endpoint,omitempty"`
// Optional. Endpoint configuration attributes that can be used to control
// different aspects of the message delivery.
//
// The only currently supported attribute is `x-goog-version`, which you can
// use to change the format of the pushed message. This attribute
// indicates the version of the data expected by the endpoint. This
// controls the shape of the pushed message (i.e., its fields and metadata).
//
// If not present during the `CreateSubscription` call, it will default to
// the version of the Pub/Sub API used to make such call. If not present in a
// `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
// calls will always return a valid version, even if the subscription was
// created without this attribute.
//
// The only supported values for the `x-goog-version` attribute are:
//
// * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
// * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
//
// For example:
// `attributes { "x-goog-version": "v1" }`
Attributes map[string]string `protobuf:"bytes,2,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}Configuration for a push delivery endpoint.
func (*PushConfig) Descriptor
func (*PushConfig) Descriptor() ([]byte, []int)Deprecated: Use PushConfig.ProtoReflect.Descriptor instead.
func (*PushConfig) GetAttributes
func (x *PushConfig) GetAttributes() map[string]stringfunc (*PushConfig) GetAuthenticationMethod
func (m *PushConfig) GetAuthenticationMethod() isPushConfig_AuthenticationMethodfunc (*PushConfig) GetNoWrapper
func (x *PushConfig) GetNoWrapper() *PushConfig_NoWrapperfunc (*PushConfig) GetOidcToken
func (x *PushConfig) GetOidcToken() *PushConfig_OidcTokenfunc (*PushConfig) GetPubsubWrapper
func (x *PushConfig) GetPubsubWrapper() *PushConfig_PubsubWrapperfunc (*PushConfig) GetPushEndpoint
func (x *PushConfig) GetPushEndpoint() stringfunc (*PushConfig) GetWrapper
func (m *PushConfig) GetWrapper() isPushConfig_Wrapperfunc (*PushConfig) ProtoMessage
func (*PushConfig) ProtoMessage()func (*PushConfig) ProtoReflect
func (x *PushConfig) ProtoReflect() protoreflect.Messagefunc (*PushConfig) Reset
func (x *PushConfig) Reset()func (*PushConfig) String
func (x *PushConfig) String() stringPushConfig_NoWrapper
type PushConfig_NoWrapper struct {
// Optional. When true, writes the Pub/Sub message metadata to
// `x-goog-pubsub-Sets the data field as the HTTP body for delivery.
func (*PushConfig_NoWrapper) Descriptor
func (*PushConfig_NoWrapper) Descriptor() ([]byte, []int)Deprecated: Use PushConfig_NoWrapper.ProtoReflect.Descriptor instead.
func (*PushConfig_NoWrapper) GetWriteMetadata
func (x *PushConfig_NoWrapper) GetWriteMetadata() boolfunc (*PushConfig_NoWrapper) ProtoMessage
func (*PushConfig_NoWrapper) ProtoMessage()func (*PushConfig_NoWrapper) ProtoReflect
func (x *PushConfig_NoWrapper) ProtoReflect() protoreflect.Messagefunc (*PushConfig_NoWrapper) Reset
func (x *PushConfig_NoWrapper) Reset()func (*PushConfig_NoWrapper) String
func (x *PushConfig_NoWrapper) String() stringPushConfig_NoWrapper_
type PushConfig_NoWrapper_ struct {
// Optional. When set, the payload to the push endpoint is not wrapped.
NoWrapper *PushConfig_NoWrapper `protobuf:"bytes,5,opt,name=no_wrapper,json=noWrapper,proto3,oneof"`
}PushConfig_OidcToken
type PushConfig_OidcToken struct {
// Optional. [Service account
// email](https://cloud.google.com/iam/docs/service-accounts)
// used for generating the OIDC token. For more information
// on setting up authentication, see
// [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
ServiceAccountEmail string `protobuf:"bytes,1,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// Optional. Audience to be used when generating OIDC token. The audience
// claim identifies the recipients that the JWT is intended for. The
// audience value is a single case-sensitive string. Having multiple values
// (array) for the audience field is not supported. More info about the OIDC
// JWT token audience here:
// https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified,
// the Push endpoint URL will be used.
Audience string `protobuf:"bytes,2,opt,name=audience,proto3" json:"audience,omitempty"`
// contains filtered or unexported fields
}Contains information needed for generating an OpenID Connect token.
func (*PushConfig_OidcToken) Descriptor
func (*PushConfig_OidcToken) Descriptor() ([]byte, []int)Deprecated: Use PushConfig_OidcToken.ProtoReflect.Descriptor instead.
func (*PushConfig_OidcToken) GetAudience
func (x *PushConfig_OidcToken) GetAudience() stringfunc (*PushConfig_OidcToken) GetServiceAccountEmail
func (x *PushConfig_OidcToken) GetServiceAccountEmail() stringfunc (*PushConfig_OidcToken) ProtoMessage
func (*PushConfig_OidcToken) ProtoMessage()func (*PushConfig_OidcToken) ProtoReflect
func (x *PushConfig_OidcToken) ProtoReflect() protoreflect.Messagefunc (*PushConfig_OidcToken) Reset
func (x *PushConfig_OidcToken) Reset()func (*PushConfig_OidcToken) String
func (x *PushConfig_OidcToken) String() stringPushConfig_OidcToken_
type PushConfig_OidcToken_ struct {
// Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
// token as an `Authorization` header in the HTTP request for every pushed
// message.
OidcToken *PushConfig_OidcToken `protobuf:"bytes,3,opt,name=oidc_token,json=oidcToken,proto3,oneof"`
}PushConfig_PubsubWrapper
type PushConfig_PubsubWrapper struct {
// contains filtered or unexported fields
}The payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
func (*PushConfig_PubsubWrapper) Descriptor
func (*PushConfig_PubsubWrapper) Descriptor() ([]byte, []int)Deprecated: Use PushConfig_PubsubWrapper.ProtoReflect.Descriptor instead.
func (*PushConfig_PubsubWrapper) ProtoMessage
func (*PushConfig_PubsubWrapper) ProtoMessage()func (*PushConfig_PubsubWrapper) ProtoReflect
func (x *PushConfig_PubsubWrapper) ProtoReflect() protoreflect.Messagefunc (*PushConfig_PubsubWrapper) Reset
func (x *PushConfig_PubsubWrapper) Reset()func (*PushConfig_PubsubWrapper) String
func (x *PushConfig_PubsubWrapper) String() stringPushConfig_PubsubWrapper_
type PushConfig_PubsubWrapper_ struct {
// Optional. When set, the payload to the push endpoint is in the form of
// the JSON representation of a PubsubMessage
// (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
PubsubWrapper *PushConfig_PubsubWrapper `protobuf:"bytes,4,opt,name=pubsub_wrapper,json=pubsubWrapper,proto3,oneof"`
}QueryTemplate
type QueryTemplate struct {
// Output only. The resource name of the QueryTemplate.
// e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Human-readable display name of the QueryTemplate. 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 QueryTemplate. 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. Will be deprecated.
// Email or URL of the primary point of contact of the QueryTemplate.
// Max Length: 1000 bytes.
Proposer string `protobuf:"bytes,4,opt,name=proposer,proto3" json:"proposer,omitempty"`
// Optional. Email or URL of the primary point of contact of the
// QueryTemplate. Max Length: 1000 bytes.
PrimaryContact string `protobuf:"bytes,10,opt,name=primary_contact,json=primaryContact,proto3" json:"primary_contact,omitempty"`
// Optional. Documentation describing the QueryTemplate.
Documentation string `protobuf:"bytes,5,opt,name=documentation,proto3" json:"documentation,omitempty"`
// Output only. The QueryTemplate lifecycle state.
State QueryTemplate_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.bigquery.analyticshub.v1.QueryTemplate_State" json:"state,omitempty"`
// Optional. The routine associated with the QueryTemplate.
Routine *Routine `protobuf:"bytes,7,opt,name=routine,proto3" json:"routine,omitempty"`
// Output only. Timestamp when the QueryTemplate was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the QueryTemplate was last modified.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
func (*QueryTemplate) Descriptor
func (*QueryTemplate) Descriptor() ([]byte, []int)Deprecated: Use QueryTemplate.ProtoReflect.Descriptor instead.
func (*QueryTemplate) GetCreateTime
func (x *QueryTemplate) GetCreateTime() *timestamppb.Timestampfunc (*QueryTemplate) GetDescription
func (x *QueryTemplate) GetDescription() stringfunc (*QueryTemplate) GetDisplayName
func (x *QueryTemplate) GetDisplayName() stringfunc (*QueryTemplate) GetDocumentation
func (x *QueryTemplate) GetDocumentation() stringfunc (*QueryTemplate) GetName
func (x *QueryTemplate) GetName() stringfunc (*QueryTemplate) GetPrimaryContact
func (x *QueryTemplate) GetPrimaryContact() stringfunc (*QueryTemplate) GetProposer
func (x *QueryTemplate) GetProposer() stringfunc (*QueryTemplate) GetRoutine
func (x *QueryTemplate) GetRoutine() *Routinefunc (*QueryTemplate) GetState
func (x *QueryTemplate) GetState() QueryTemplate_Statefunc (*QueryTemplate) GetUpdateTime
func (x *QueryTemplate) GetUpdateTime() *timestamppb.Timestampfunc (*QueryTemplate) ProtoMessage
func (*QueryTemplate) ProtoMessage()func (*QueryTemplate) ProtoReflect
func (x *QueryTemplate) ProtoReflect() protoreflect.Messagefunc (*QueryTemplate) Reset
func (x *QueryTemplate) Reset()func (*QueryTemplate) String
func (x *QueryTemplate) String() stringQueryTemplate_State
type QueryTemplate_State int32The QueryTemplate lifecycle state.
QueryTemplate_STATE_UNSPECIFIED, QueryTemplate_DRAFTED, QueryTemplate_PENDING, QueryTemplate_DELETED, QueryTemplate_APPROVED
const (
// Default value. This value is unused.
QueryTemplate_STATE_UNSPECIFIED QueryTemplate_State = 0
// The QueryTemplate is in draft state.
QueryTemplate_DRAFTED QueryTemplate_State = 1
// The QueryTemplate is in pending state.
QueryTemplate_PENDING QueryTemplate_State = 2
// The QueryTemplate is in deleted state.
QueryTemplate_DELETED QueryTemplate_State = 3
// The QueryTemplate is in approved state.
QueryTemplate_APPROVED QueryTemplate_State = 4
)func (QueryTemplate_State) Descriptor
func (QueryTemplate_State) Descriptor() protoreflect.EnumDescriptorfunc (QueryTemplate_State) Enum
func (x QueryTemplate_State) Enum() *QueryTemplate_Statefunc (QueryTemplate_State) EnumDescriptor
func (QueryTemplate_State) EnumDescriptor() ([]byte, []int)Deprecated: Use QueryTemplate_State.Descriptor instead.
func (QueryTemplate_State) Number
func (x QueryTemplate_State) Number() protoreflect.EnumNumberfunc (QueryTemplate_State) String
func (x QueryTemplate_State) String() stringfunc (QueryTemplate_State) Type
func (QueryTemplate_State) Type() protoreflect.EnumTypeRefreshSubscriptionRequest
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
func (*RefreshSubscriptionRequest) Descriptor() ([]byte, []int)Deprecated: Use RefreshSubscriptionRequest.ProtoReflect.Descriptor instead.
func (*RefreshSubscriptionRequest) GetName
func (x *RefreshSubscriptionRequest) GetName() stringfunc (*RefreshSubscriptionRequest) ProtoMessage
func (*RefreshSubscriptionRequest) ProtoMessage()func (*RefreshSubscriptionRequest) ProtoReflect
func (x *RefreshSubscriptionRequest) ProtoReflect() protoreflect.Messagefunc (*RefreshSubscriptionRequest) Reset
func (x *RefreshSubscriptionRequest) Reset()func (*RefreshSubscriptionRequest) String
func (x *RefreshSubscriptionRequest) String() stringRefreshSubscriptionResponse
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
func (*RefreshSubscriptionResponse) Descriptor() ([]byte, []int)Deprecated: Use RefreshSubscriptionResponse.ProtoReflect.Descriptor instead.
func (*RefreshSubscriptionResponse) GetSubscription
func (x *RefreshSubscriptionResponse) GetSubscription() *Subscriptionfunc (*RefreshSubscriptionResponse) ProtoMessage
func (*RefreshSubscriptionResponse) ProtoMessage()func (*RefreshSubscriptionResponse) ProtoReflect
func (x *RefreshSubscriptionResponse) ProtoReflect() protoreflect.Messagefunc (*RefreshSubscriptionResponse) Reset
func (x *RefreshSubscriptionResponse) Reset()func (*RefreshSubscriptionResponse) String
func (x *RefreshSubscriptionResponse) String() stringRetryPolicy
type RetryPolicy struct {
// Optional. The minimum delay between consecutive deliveries of a given
// message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
MinimumBackoff *durationpb.Duration `protobuf:"bytes,1,opt,name=minimum_backoff,json=minimumBackoff,proto3" json:"minimum_backoff,omitempty"`
// Optional. The maximum delay between consecutive deliveries of a given
// message. Value should be between 0 and 600 seconds. Defaults to 600
// seconds.
MaximumBackoff *durationpb.Duration `protobuf:"bytes,2,opt,name=maximum_backoff,json=maximumBackoff,proto3" json:"maximum_backoff,omitempty"`
// contains filtered or unexported fields
}A policy that specifies how Pub/Sub retries message delivery.
Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.
RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.
func (*RetryPolicy) Descriptor
func (*RetryPolicy) Descriptor() ([]byte, []int)Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.
func (*RetryPolicy) GetMaximumBackoff
func (x *RetryPolicy) GetMaximumBackoff() *durationpb.Durationfunc (*RetryPolicy) GetMinimumBackoff
func (x *RetryPolicy) GetMinimumBackoff() *durationpb.Durationfunc (*RetryPolicy) ProtoMessage
func (*RetryPolicy) ProtoMessage()func (*RetryPolicy) ProtoReflect
func (x *RetryPolicy) ProtoReflect() protoreflect.Messagefunc (*RetryPolicy) Reset
func (x *RetryPolicy) Reset()func (*RetryPolicy) String
func (x *RetryPolicy) String() stringRevokeSubscriptionRequest
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"`
// Optional. If the subscription is commercial then this field must be set to
// true, otherwise a failure is thrown. This acts as a safety guard to avoid
// revoking commercial subscriptions accidentally.
RevokeCommercial bool `protobuf:"varint,2,opt,name=revoke_commercial,json=revokeCommercial,proto3" json:"revoke_commercial,omitempty"`
// contains filtered or unexported fields
}Message for revoking a subscription.
func (*RevokeSubscriptionRequest) Descriptor
func (*RevokeSubscriptionRequest) Descriptor() ([]byte, []int)Deprecated: Use RevokeSubscriptionRequest.ProtoReflect.Descriptor instead.
func (*RevokeSubscriptionRequest) GetName
func (x *RevokeSubscriptionRequest) GetName() stringfunc (*RevokeSubscriptionRequest) GetRevokeCommercial
func (x *RevokeSubscriptionRequest) GetRevokeCommercial() boolfunc (*RevokeSubscriptionRequest) ProtoMessage
func (*RevokeSubscriptionRequest) ProtoMessage()func (*RevokeSubscriptionRequest) ProtoReflect
func (x *RevokeSubscriptionRequest) ProtoReflect() protoreflect.Messagefunc (*RevokeSubscriptionRequest) Reset
func (x *RevokeSubscriptionRequest) Reset()func (*RevokeSubscriptionRequest) String
func (x *RevokeSubscriptionRequest) String() stringRevokeSubscriptionResponse
type RevokeSubscriptionResponse struct {
// contains filtered or unexported fields
}Message for response when you revoke a subscription. Empty for now.
func (*RevokeSubscriptionResponse) Descriptor
func (*RevokeSubscriptionResponse) Descriptor() ([]byte, []int)Deprecated: Use RevokeSubscriptionResponse.ProtoReflect.Descriptor instead.
func (*RevokeSubscriptionResponse) ProtoMessage
func (*RevokeSubscriptionResponse) ProtoMessage()func (*RevokeSubscriptionResponse) ProtoReflect
func (x *RevokeSubscriptionResponse) ProtoReflect() protoreflect.Messagefunc (*RevokeSubscriptionResponse) Reset
func (x *RevokeSubscriptionResponse) Reset()func (*RevokeSubscriptionResponse) String
func (x *RevokeSubscriptionResponse) String() stringRoutine
type Routine struct {
// Required. The type of routine.
RoutineType Routine_RoutineType `protobuf:"varint,1,opt,name=routine_type,json=routineType,proto3,enum=google.cloud.bigquery.analyticshub.v1.Routine_RoutineType" json:"routine_type,omitempty"`
// Optional. The definition body of the routine.
DefinitionBody string `protobuf:"bytes,2,opt,name=definition_body,json=definitionBody,proto3" json:"definition_body,omitempty"`
// contains filtered or unexported fields
}Represents a bigquery routine.
func (*Routine) Descriptor
Deprecated: Use Routine.ProtoReflect.Descriptor instead.
func (*Routine) GetDefinitionBody
func (*Routine) GetRoutineType
func (x *Routine) GetRoutineType() Routine_RoutineTypefunc (*Routine) ProtoMessage
func (*Routine) ProtoMessage()func (*Routine) ProtoReflect
func (x *Routine) ProtoReflect() protoreflect.Messagefunc (*Routine) Reset
func (x *Routine) Reset()func (*Routine) String
Routine_RoutineType
type Routine_RoutineType int32Represents the type of a given routine.
Routine_ROUTINE_TYPE_UNSPECIFIED, Routine_TABLE_VALUED_FUNCTION
const (
// Default value.
Routine_ROUTINE_TYPE_UNSPECIFIED Routine_RoutineType = 0
// Non-built-in persistent TVF.
Routine_TABLE_VALUED_FUNCTION Routine_RoutineType = 1
)func (Routine_RoutineType) Descriptor
func (Routine_RoutineType) Descriptor() protoreflect.EnumDescriptorfunc (Routine_RoutineType) Enum
func (x Routine_RoutineType) Enum() *Routine_RoutineTypefunc (Routine_RoutineType) EnumDescriptor
func (Routine_RoutineType) EnumDescriptor() ([]byte, []int)Deprecated: Use Routine_RoutineType.Descriptor instead.
func (Routine_RoutineType) Number
func (x Routine_RoutineType) Number() protoreflect.EnumNumberfunc (Routine_RoutineType) String
func (x Routine_RoutineType) String() stringfunc (Routine_RoutineType) Type
func (Routine_RoutineType) Type() protoreflect.EnumTypeSharedResourceType
type SharedResourceType int32The underlying shared asset type shared in a listing by a publisher.
SharedResourceType_SHARED_RESOURCE_TYPE_UNSPECIFIED, SharedResourceType_BIGQUERY_DATASET, SharedResourceType_PUBSUB_TOPIC
const (
// Not specified.
SharedResourceType_SHARED_RESOURCE_TYPE_UNSPECIFIED SharedResourceType = 0
// BigQuery Dataset Asset.
SharedResourceType_BIGQUERY_DATASET SharedResourceType = 1
// Pub/Sub Topic Asset.
SharedResourceType_PUBSUB_TOPIC SharedResourceType = 2
)func (SharedResourceType) Descriptor
func (SharedResourceType) Descriptor() protoreflect.EnumDescriptorfunc (SharedResourceType) Enum
func (x SharedResourceType) Enum() *SharedResourceTypefunc (SharedResourceType) EnumDescriptor
func (SharedResourceType) EnumDescriptor() ([]byte, []int)Deprecated: Use SharedResourceType.Descriptor instead.
func (SharedResourceType) Number
func (x SharedResourceType) Number() protoreflect.EnumNumberfunc (SharedResourceType) String
func (x SharedResourceType) String() stringfunc (SharedResourceType) Type
func (SharedResourceType) Type() protoreflect.EnumTypeSharingEnvironmentConfig
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
func (*SharingEnvironmentConfig) Descriptor() ([]byte, []int)Deprecated: Use SharingEnvironmentConfig.ProtoReflect.Descriptor instead.
func (*SharingEnvironmentConfig) GetDcrExchangeConfig
func (x *SharingEnvironmentConfig) GetDcrExchangeConfig() *SharingEnvironmentConfig_DcrExchangeConfigfunc (*SharingEnvironmentConfig) GetDefaultExchangeConfig
func (x *SharingEnvironmentConfig) GetDefaultExchangeConfig() *SharingEnvironmentConfig_DefaultExchangeConfigfunc (*SharingEnvironmentConfig) GetEnvironment
func (m *SharingEnvironmentConfig) GetEnvironment() isSharingEnvironmentConfig_Environmentfunc (*SharingEnvironmentConfig) ProtoMessage
func (*SharingEnvironmentConfig) ProtoMessage()func (*SharingEnvironmentConfig) ProtoReflect
func (x *SharingEnvironmentConfig) ProtoReflect() protoreflect.Messagefunc (*SharingEnvironmentConfig) Reset
func (x *SharingEnvironmentConfig) Reset()func (*SharingEnvironmentConfig) String
func (x *SharingEnvironmentConfig) String() stringSharingEnvironmentConfig_DcrExchangeConfig
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 `protobuf:"varint,1,opt,name=single_selected_resource_sharing_restriction,json=singleSelectedResourceSharingRestriction,proto3,oneof" json:"single_selected_resource_sharing_restriction,omitempty"`
// 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 `protobuf:"varint,2,opt,name=single_linked_dataset_per_cleanroom,json=singleLinkedDatasetPerCleanroom,proto3,oneof" json:"single_linked_dataset_per_cleanroom,omitempty"`
// contains filtered or unexported fields
}Data Clean Room (DCR), used for privacy-safe and secured data sharing.
func (*SharingEnvironmentConfig_DcrExchangeConfig) Descriptor
func (*SharingEnvironmentConfig_DcrExchangeConfig) Descriptor() ([]byte, []int)Deprecated: Use SharingEnvironmentConfig_DcrExchangeConfig.ProtoReflect.Descriptor instead.
func (*SharingEnvironmentConfig_DcrExchangeConfig) GetSingleLinkedDatasetPerCleanroom
func (x *SharingEnvironmentConfig_DcrExchangeConfig) GetSingleLinkedDatasetPerCleanroom() boolfunc (*SharingEnvironmentConfig_DcrExchangeConfig) GetSingleSelectedResourceSharingRestriction
func (x *SharingEnvironmentConfig_DcrExchangeConfig) GetSingleSelectedResourceSharingRestriction() boolfunc (*SharingEnvironmentConfig_DcrExchangeConfig) ProtoMessage
func (*SharingEnvironmentConfig_DcrExchangeConfig) ProtoMessage()func (*SharingEnvironmentConfig_DcrExchangeConfig) ProtoReflect
func (x *SharingEnvironmentConfig_DcrExchangeConfig) ProtoReflect() protoreflect.Messagefunc (*SharingEnvironmentConfig_DcrExchangeConfig) Reset
func (x *SharingEnvironmentConfig_DcrExchangeConfig) Reset()func (*SharingEnvironmentConfig_DcrExchangeConfig) String
func (x *SharingEnvironmentConfig_DcrExchangeConfig) String() stringSharingEnvironmentConfig_DcrExchangeConfig_
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"`
}SharingEnvironmentConfig_DefaultExchangeConfig
type SharingEnvironmentConfig_DefaultExchangeConfig struct {
// contains filtered or unexported fields
}Default Analytics Hub data exchange, used for secured data sharing.
func (*SharingEnvironmentConfig_DefaultExchangeConfig) Descriptor
func (*SharingEnvironmentConfig_DefaultExchangeConfig) Descriptor() ([]byte, []int)Deprecated: Use SharingEnvironmentConfig_DefaultExchangeConfig.ProtoReflect.Descriptor instead.
func (*SharingEnvironmentConfig_DefaultExchangeConfig) ProtoMessage
func (*SharingEnvironmentConfig_DefaultExchangeConfig) ProtoMessage()func (*SharingEnvironmentConfig_DefaultExchangeConfig) ProtoReflect
func (x *SharingEnvironmentConfig_DefaultExchangeConfig) ProtoReflect() protoreflect.Messagefunc (*SharingEnvironmentConfig_DefaultExchangeConfig) Reset
func (x *SharingEnvironmentConfig_DefaultExchangeConfig) Reset()func (*SharingEnvironmentConfig_DefaultExchangeConfig) String
func (x *SharingEnvironmentConfig_DefaultExchangeConfig) String() stringSharingEnvironmentConfig_DefaultExchangeConfig_
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"`
}SubmitQueryTemplateRequest
type SubmitQueryTemplateRequest struct {
// Required. The resource path of the QueryTemplate.
// e.g.
// `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Message for submitting a QueryTemplate.
func (*SubmitQueryTemplateRequest) Descriptor
func (*SubmitQueryTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use SubmitQueryTemplateRequest.ProtoReflect.Descriptor instead.
func (*SubmitQueryTemplateRequest) GetName
func (x *SubmitQueryTemplateRequest) GetName() stringfunc (*SubmitQueryTemplateRequest) ProtoMessage
func (*SubmitQueryTemplateRequest) ProtoMessage()func (*SubmitQueryTemplateRequest) ProtoReflect
func (x *SubmitQueryTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*SubmitQueryTemplateRequest) Reset
func (x *SubmitQueryTemplateRequest) Reset()func (*SubmitQueryTemplateRequest) String
func (x *SubmitQueryTemplateRequest) String() stringSubscribeDataExchangeRequest
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"`
// Optional. BigQuery destination dataset to create for the subscriber.
DestinationDataset *DestinationDataset `protobuf:"bytes,5,opt,name=destination_dataset,json=destinationDataset,proto3" json:"destination_dataset,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
func (*SubscribeDataExchangeRequest) Descriptor() ([]byte, []int)Deprecated: Use SubscribeDataExchangeRequest.ProtoReflect.Descriptor instead.
func (*SubscribeDataExchangeRequest) GetDestination
func (x *SubscribeDataExchangeRequest) GetDestination() stringfunc (*SubscribeDataExchangeRequest) GetDestinationDataset
func (x *SubscribeDataExchangeRequest) GetDestinationDataset() *DestinationDatasetfunc (*SubscribeDataExchangeRequest) GetName
func (x *SubscribeDataExchangeRequest) GetName() stringfunc (*SubscribeDataExchangeRequest) GetSubscriberContact
func (x *SubscribeDataExchangeRequest) GetSubscriberContact() stringfunc (*SubscribeDataExchangeRequest) GetSubscription
func (x *SubscribeDataExchangeRequest) GetSubscription() stringfunc (*SubscribeDataExchangeRequest) ProtoMessage
func (*SubscribeDataExchangeRequest) ProtoMessage()func (*SubscribeDataExchangeRequest) ProtoReflect
func (x *SubscribeDataExchangeRequest) ProtoReflect() protoreflect.Messagefunc (*SubscribeDataExchangeRequest) Reset
func (x *SubscribeDataExchangeRequest) Reset()func (*SubscribeDataExchangeRequest) String
func (x *SubscribeDataExchangeRequest) String() stringSubscribeDataExchangeResponse
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
func (*SubscribeDataExchangeResponse) Descriptor() ([]byte, []int)Deprecated: Use SubscribeDataExchangeResponse.ProtoReflect.Descriptor instead.
func (*SubscribeDataExchangeResponse) GetSubscription
func (x *SubscribeDataExchangeResponse) GetSubscription() *Subscriptionfunc (*SubscribeDataExchangeResponse) ProtoMessage
func (*SubscribeDataExchangeResponse) ProtoMessage()func (*SubscribeDataExchangeResponse) ProtoReflect
func (x *SubscribeDataExchangeResponse) ProtoReflect() protoreflect.Messagefunc (*SubscribeDataExchangeResponse) Reset
func (x *SubscribeDataExchangeResponse) Reset()func (*SubscribeDataExchangeResponse) String
func (x *SubscribeDataExchangeResponse) String() stringSubscribeListingRequest
type SubscribeListingRequest struct {
// Resulting destination of the listing that you subscribed to.
//
// Types that are assignable to Destination:
//
// *SubscribeListingRequest_DestinationDataset
// *SubscribeListingRequest_DestinationPubsubSubscription
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
func (*SubscribeListingRequest) Descriptor() ([]byte, []int)Deprecated: Use SubscribeListingRequest.ProtoReflect.Descriptor instead.
func (*SubscribeListingRequest) GetDestination
func (m *SubscribeListingRequest) GetDestination() isSubscribeListingRequest_Destinationfunc (*SubscribeListingRequest) GetDestinationDataset
func (x *SubscribeListingRequest) GetDestinationDataset() *DestinationDatasetfunc (*SubscribeListingRequest) GetDestinationPubsubSubscription
func (x *SubscribeListingRequest) GetDestinationPubsubSubscription() *DestinationPubSubSubscriptionfunc (*SubscribeListingRequest) GetName
func (x *SubscribeListingRequest) GetName() stringfunc (*SubscribeListingRequest) ProtoMessage
func (*SubscribeListingRequest) ProtoMessage()func (*SubscribeListingRequest) ProtoReflect
func (x *SubscribeListingRequest) ProtoReflect() protoreflect.Messagefunc (*SubscribeListingRequest) Reset
func (x *SubscribeListingRequest) Reset()func (*SubscribeListingRequest) String
func (x *SubscribeListingRequest) String() stringSubscribeListingRequest_DestinationDataset
type SubscribeListingRequest_DestinationDataset struct {
// Input only. BigQuery destination dataset to create for the subscriber.
DestinationDataset *DestinationDataset `protobuf:"bytes,3,opt,name=destination_dataset,json=destinationDataset,proto3,oneof"`
}SubscribeListingRequest_DestinationPubsubSubscription
type SubscribeListingRequest_DestinationPubsubSubscription struct {
// Input only. Destination Pub/Sub subscription to create for the
// subscriber.
DestinationPubsubSubscription *DestinationPubSubSubscription `protobuf:"bytes,5,opt,name=destination_pubsub_subscription,json=destinationPubsubSubscription,proto3,oneof"`
}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
func (*SubscribeListingResponse) Descriptor() ([]byte, []int)Deprecated: Use SubscribeListingResponse.ProtoReflect.Descriptor instead.
func (*SubscribeListingResponse) GetSubscription
func (x *SubscribeListingResponse) GetSubscription() *Subscriptionfunc (*SubscribeListingResponse) ProtoMessage
func (*SubscribeListingResponse) ProtoMessage()func (*SubscribeListingResponse) ProtoReflect
func (x *SubscribeListingResponse) ProtoReflect() protoreflect.Messagefunc (*SubscribeListingResponse) Reset
func (x *SubscribeListingResponse) Reset()func (*SubscribeListingResponse) String
func (x *SubscribeListingResponse) String() stringSubscription
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 `protobuf:"bytes,10,opt,name=organization_display_name,json=organizationDisplayName,proto3" json:"organization_display_name,omitempty"`
// Output only. Current state of the subscription.
State Subscription_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.bigquery.analyticshub.v1.Subscription_State" json:"state,omitempty"`
// 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 `protobuf:"bytes,8,rep,name=linked_dataset_map,json=linkedDatasetMap,proto3" json:"linked_dataset_map,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Output only. Email of the subscriber.
SubscriberContact string `protobuf:"bytes,9,opt,name=subscriber_contact,json=subscriberContact,proto3" json:"subscriber_contact,omitempty"`
// Output only. Linked resources created in the subscription. Only contains
// values if state = STATE_ACTIVE.
LinkedResources []*Subscription_LinkedResource `protobuf:"bytes,11,rep,name=linked_resources,json=linkedResources,proto3" json:"linked_resources,omitempty"`
// Output only. Listing shared asset type.
ResourceType SharedResourceType `protobuf:"varint,12,opt,name=resource_type,json=resourceType,proto3,enum=google.cloud.bigquery.analyticshub.v1.SharedResourceType" json:"resource_type,omitempty"`
// Output only. This is set if this is a commercial subscription i.e. if this
// subscription was created from subscribing to a commercial listing.
CommercialInfo *Subscription_CommercialInfo `protobuf:"bytes,13,opt,name=commercial_info,json=commercialInfo,proto3" json:"commercial_info,omitempty"`
// Output only. By default, false.
// If true, the Subscriber agreed to the email sharing mandate
// that is enabled for DataExchange/Listing.
LogLinkedDatasetQueryUserEmail *bool `protobuf:"varint,14,opt,name=log_linked_dataset_query_user_email,json=logLinkedDatasetQueryUserEmail,proto3,oneof" json:"log_linked_dataset_query_user_email,omitempty"`
// Optional. BigQuery destination dataset to create for the subscriber.
DestinationDataset *DestinationDataset `protobuf:"bytes,15,opt,name=destination_dataset,json=destinationDataset,proto3" json:"destination_dataset,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
func (*Subscription) Descriptor() ([]byte, []int)Deprecated: Use Subscription.ProtoReflect.Descriptor instead.
func (*Subscription) GetCommercialInfo
func (x *Subscription) GetCommercialInfo() *Subscription_CommercialInfofunc (*Subscription) GetCreationTime
func (x *Subscription) GetCreationTime() *timestamppb.Timestampfunc (*Subscription) GetDataExchange
func (x *Subscription) GetDataExchange() stringfunc (*Subscription) GetDestinationDataset
func (x *Subscription) GetDestinationDataset() *DestinationDatasetfunc (*Subscription) GetLastModifyTime
func (x *Subscription) GetLastModifyTime() *timestamppb.Timestampfunc (*Subscription) GetLinkedDatasetMap
func (x *Subscription) GetLinkedDatasetMap() map[string]*Subscription_LinkedResourcefunc (*Subscription) GetLinkedResources
func (x *Subscription) GetLinkedResources() []*Subscription_LinkedResourcefunc (*Subscription) GetListing
func (x *Subscription) GetListing() stringfunc (*Subscription) GetLogLinkedDatasetQueryUserEmail
func (x *Subscription) GetLogLinkedDatasetQueryUserEmail() boolfunc (*Subscription) GetName
func (x *Subscription) GetName() stringfunc (*Subscription) GetOrganizationDisplayName
func (x *Subscription) GetOrganizationDisplayName() stringfunc (*Subscription) GetOrganizationId
func (x *Subscription) GetOrganizationId() stringfunc (*Subscription) GetResourceName
func (m *Subscription) GetResourceName() isSubscription_ResourceNamefunc (*Subscription) GetResourceType
func (x *Subscription) GetResourceType() SharedResourceTypefunc (*Subscription) GetState
func (x *Subscription) GetState() Subscription_Statefunc (*Subscription) GetSubscriberContact
func (x *Subscription) GetSubscriberContact() stringfunc (*Subscription) ProtoMessage
func (*Subscription) ProtoMessage()func (*Subscription) ProtoReflect
func (x *Subscription) ProtoReflect() protoreflect.Messagefunc (*Subscription) Reset
func (x *Subscription) Reset()func (*Subscription) String
func (x *Subscription) String() stringSubscription_CommercialInfo
type Subscription_CommercialInfo struct {
// Output only. This is set when the subscription is commercialised via
// Cloud Marketplace.
CloudMarketplace *Subscription_CommercialInfo_GoogleCloudMarketplaceInfo `protobuf:"bytes,1,opt,name=cloud_marketplace,json=cloudMarketplace,proto3" json:"cloud_marketplace,omitempty"`
// contains filtered or unexported fields
}Commercial info metadata for this subscription.
func (*Subscription_CommercialInfo) Descriptor
func (*Subscription_CommercialInfo) Descriptor() ([]byte, []int)Deprecated: Use Subscription_CommercialInfo.ProtoReflect.Descriptor instead.
func (*Subscription_CommercialInfo) GetCloudMarketplace
func (x *Subscription_CommercialInfo) GetCloudMarketplace() *Subscription_CommercialInfo_GoogleCloudMarketplaceInfofunc (*Subscription_CommercialInfo) ProtoMessage
func (*Subscription_CommercialInfo) ProtoMessage()func (*Subscription_CommercialInfo) ProtoReflect
func (x *Subscription_CommercialInfo) ProtoReflect() protoreflect.Messagefunc (*Subscription_CommercialInfo) Reset
func (x *Subscription_CommercialInfo) Reset()func (*Subscription_CommercialInfo) String
func (x *Subscription_CommercialInfo) String() stringSubscription_CommercialInfo_GoogleCloudMarketplaceInfo
type Subscription_CommercialInfo_GoogleCloudMarketplaceInfo struct {
// Resource name of the Marketplace Order.
Order string `protobuf:"bytes,1,opt,name=order,proto3" json:"order,omitempty"`
// contains filtered or unexported fields
}Cloud Marketplace commercial metadata for this subscription.
func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) Descriptor
func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) Descriptor() ([]byte, []int)Deprecated: Use Subscription_CommercialInfo_GoogleCloudMarketplaceInfo.ProtoReflect.Descriptor instead.
func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) GetOrder
func (x *Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) GetOrder() stringfunc (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoMessage
func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoMessage()func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoReflect
func (x *Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoReflect() protoreflect.Messagefunc (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) Reset
func (x *Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) Reset()func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) String
func (x *Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) String() stringSubscription_DataExchange
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"`
}Subscription_LinkedResource
type Subscription_LinkedResource struct {
// Types that are assignable to Reference:
//
// *Subscription_LinkedResource_LinkedDataset
// *Subscription_LinkedResource_LinkedPubsubSubscription
Reference isSubscription_LinkedResource_Reference `protobuf_oneof:"reference"`
// Output only. Listing for which linked resource is created.
Listing string `protobuf:"bytes,2,opt,name=listing,proto3" json:"listing,omitempty"`
// contains filtered or unexported fields
}Reference to a linked resource tracked by this Subscription.
func (*Subscription_LinkedResource) Descriptor
func (*Subscription_LinkedResource) Descriptor() ([]byte, []int)Deprecated: Use Subscription_LinkedResource.ProtoReflect.Descriptor instead.
func (*Subscription_LinkedResource) GetLinkedDataset
func (x *Subscription_LinkedResource) GetLinkedDataset() stringfunc (*Subscription_LinkedResource) GetLinkedPubsubSubscription
func (x *Subscription_LinkedResource) GetLinkedPubsubSubscription() stringfunc (*Subscription_LinkedResource) GetListing
func (x *Subscription_LinkedResource) GetListing() stringfunc (*Subscription_LinkedResource) GetReference
func (m *Subscription_LinkedResource) GetReference() isSubscription_LinkedResource_Referencefunc (*Subscription_LinkedResource) ProtoMessage
func (*Subscription_LinkedResource) ProtoMessage()func (*Subscription_LinkedResource) ProtoReflect
func (x *Subscription_LinkedResource) ProtoReflect() protoreflect.Messagefunc (*Subscription_LinkedResource) Reset
func (x *Subscription_LinkedResource) Reset()func (*Subscription_LinkedResource) String
func (x *Subscription_LinkedResource) String() stringSubscription_LinkedResource_LinkedDataset
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"`
}Subscription_LinkedResource_LinkedPubsubSubscription
type Subscription_LinkedResource_LinkedPubsubSubscription struct {
// Output only. Name of the Pub/Sub subscription, e.g.
// projects/subscriberproject/subscriptions/subscriptions/sub_id
LinkedPubsubSubscription string `protobuf:"bytes,3,opt,name=linked_pubsub_subscription,json=linkedPubsubSubscription,proto3,oneof"`
}Subscription_Listing
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"`
}Subscription_State
type Subscription_State int32State of the subscription.
Subscription_STATE_UNSPECIFIED, Subscription_STATE_ACTIVE, Subscription_STATE_STALE, Subscription_STATE_INACTIVE
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
func (Subscription_State) Descriptor() protoreflect.EnumDescriptorfunc (Subscription_State) Enum
func (x Subscription_State) Enum() *Subscription_Statefunc (Subscription_State) EnumDescriptor
func (Subscription_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Subscription_State.Descriptor instead.
func (Subscription_State) Number
func (x Subscription_State) Number() protoreflect.EnumNumberfunc (Subscription_State) String
func (x Subscription_State) String() stringfunc (Subscription_State) Type
func (Subscription_State) Type() protoreflect.EnumTypeUnimplementedAnalyticsHubServiceServer
type UnimplementedAnalyticsHubServiceServer struct {
}UnimplementedAnalyticsHubServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedAnalyticsHubServiceServer) ApproveQueryTemplate
func (UnimplementedAnalyticsHubServiceServer) ApproveQueryTemplate(context.Context, *ApproveQueryTemplateRequest) (*QueryTemplate, error)func (UnimplementedAnalyticsHubServiceServer) CreateDataExchange
func (UnimplementedAnalyticsHubServiceServer) CreateDataExchange(context.Context, *CreateDataExchangeRequest) (*DataExchange, error)func (UnimplementedAnalyticsHubServiceServer) CreateListing
func (UnimplementedAnalyticsHubServiceServer) CreateListing(context.Context, *CreateListingRequest) (*Listing, error)func (UnimplementedAnalyticsHubServiceServer) CreateQueryTemplate
func (UnimplementedAnalyticsHubServiceServer) CreateQueryTemplate(context.Context, *CreateQueryTemplateRequest) (*QueryTemplate, error)func (UnimplementedAnalyticsHubServiceServer) DeleteDataExchange
func (UnimplementedAnalyticsHubServiceServer) DeleteDataExchange(context.Context, *DeleteDataExchangeRequest) (*emptypb.Empty, error)func (UnimplementedAnalyticsHubServiceServer) DeleteListing
func (UnimplementedAnalyticsHubServiceServer) DeleteListing(context.Context, *DeleteListingRequest) (*emptypb.Empty, error)func (UnimplementedAnalyticsHubServiceServer) DeleteQueryTemplate
func (UnimplementedAnalyticsHubServiceServer) DeleteQueryTemplate(context.Context, *DeleteQueryTemplateRequest) (*emptypb.Empty, error)func (UnimplementedAnalyticsHubServiceServer) DeleteSubscription
func (UnimplementedAnalyticsHubServiceServer) DeleteSubscription(context.Context, *DeleteSubscriptionRequest) (*longrunningpb.Operation, error)func (UnimplementedAnalyticsHubServiceServer) GetDataExchange
func (UnimplementedAnalyticsHubServiceServer) GetDataExchange(context.Context, *GetDataExchangeRequest) (*DataExchange, error)func (UnimplementedAnalyticsHubServiceServer) GetIamPolicy
func (UnimplementedAnalyticsHubServiceServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)func (UnimplementedAnalyticsHubServiceServer) GetListing
func (UnimplementedAnalyticsHubServiceServer) GetListing(context.Context, *GetListingRequest) (*Listing, error)func (UnimplementedAnalyticsHubServiceServer) GetQueryTemplate
func (UnimplementedAnalyticsHubServiceServer) GetQueryTemplate(context.Context, *GetQueryTemplateRequest) (*QueryTemplate, error)func (UnimplementedAnalyticsHubServiceServer) GetSubscription
func (UnimplementedAnalyticsHubServiceServer) GetSubscription(context.Context, *GetSubscriptionRequest) (*Subscription, error)func (UnimplementedAnalyticsHubServiceServer) ListDataExchanges
func (UnimplementedAnalyticsHubServiceServer) ListDataExchanges(context.Context, *ListDataExchangesRequest) (*ListDataExchangesResponse, error)func (UnimplementedAnalyticsHubServiceServer) ListListings
func (UnimplementedAnalyticsHubServiceServer) ListListings(context.Context, *ListListingsRequest) (*ListListingsResponse, error)func (UnimplementedAnalyticsHubServiceServer) ListOrgDataExchanges
func (UnimplementedAnalyticsHubServiceServer) ListOrgDataExchanges(context.Context, *ListOrgDataExchangesRequest) (*ListOrgDataExchangesResponse, error)func (UnimplementedAnalyticsHubServiceServer) ListQueryTemplates
func (UnimplementedAnalyticsHubServiceServer) ListQueryTemplates(context.Context, *ListQueryTemplatesRequest) (*ListQueryTemplatesResponse, error)func (UnimplementedAnalyticsHubServiceServer) ListSharedResourceSubscriptions
func (UnimplementedAnalyticsHubServiceServer) ListSharedResourceSubscriptions(context.Context, *ListSharedResourceSubscriptionsRequest) (*ListSharedResourceSubscriptionsResponse, error)func (UnimplementedAnalyticsHubServiceServer) ListSubscriptions
func (UnimplementedAnalyticsHubServiceServer) ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*ListSubscriptionsResponse, error)func (UnimplementedAnalyticsHubServiceServer) RefreshSubscription
func (UnimplementedAnalyticsHubServiceServer) RefreshSubscription(context.Context, *RefreshSubscriptionRequest) (*longrunningpb.Operation, error)func (UnimplementedAnalyticsHubServiceServer) RevokeSubscription
func (UnimplementedAnalyticsHubServiceServer) RevokeSubscription(context.Context, *RevokeSubscriptionRequest) (*RevokeSubscriptionResponse, error)func (UnimplementedAnalyticsHubServiceServer) SetIamPolicy
func (UnimplementedAnalyticsHubServiceServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)func (UnimplementedAnalyticsHubServiceServer) SubmitQueryTemplate
func (UnimplementedAnalyticsHubServiceServer) SubmitQueryTemplate(context.Context, *SubmitQueryTemplateRequest) (*QueryTemplate, error)func (UnimplementedAnalyticsHubServiceServer) SubscribeDataExchange
func (UnimplementedAnalyticsHubServiceServer) SubscribeDataExchange(context.Context, *SubscribeDataExchangeRequest) (*longrunningpb.Operation, error)func (UnimplementedAnalyticsHubServiceServer) SubscribeListing
func (UnimplementedAnalyticsHubServiceServer) SubscribeListing(context.Context, *SubscribeListingRequest) (*SubscribeListingResponse, error)func (UnimplementedAnalyticsHubServiceServer) TestIamPermissions
func (UnimplementedAnalyticsHubServiceServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)func (UnimplementedAnalyticsHubServiceServer) UpdateDataExchange
func (UnimplementedAnalyticsHubServiceServer) UpdateDataExchange(context.Context, *UpdateDataExchangeRequest) (*DataExchange, error)func (UnimplementedAnalyticsHubServiceServer) UpdateListing
func (UnimplementedAnalyticsHubServiceServer) UpdateListing(context.Context, *UpdateListingRequest) (*Listing, error)func (UnimplementedAnalyticsHubServiceServer) UpdateQueryTemplate
func (UnimplementedAnalyticsHubServiceServer) UpdateQueryTemplate(context.Context, *UpdateQueryTemplateRequest) (*QueryTemplate, error)UnsafeAnalyticsHubServiceServer
type UnsafeAnalyticsHubServiceServer interface {
// contains filtered or unexported methods
}UnsafeAnalyticsHubServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AnalyticsHubServiceServer will result in compilation errors.
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
func (*UpdateDataExchangeRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateDataExchangeRequest.ProtoReflect.Descriptor instead.
func (*UpdateDataExchangeRequest) GetDataExchange
func (x *UpdateDataExchangeRequest) GetDataExchange() *DataExchangefunc (*UpdateDataExchangeRequest) GetUpdateMask
func (x *UpdateDataExchangeRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateDataExchangeRequest) ProtoMessage
func (*UpdateDataExchangeRequest) ProtoMessage()func (*UpdateDataExchangeRequest) ProtoReflect
func (x *UpdateDataExchangeRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateDataExchangeRequest) Reset
func (x *UpdateDataExchangeRequest) Reset()func (*UpdateDataExchangeRequest) String
func (x *UpdateDataExchangeRequest) String() stringUpdateListingRequest
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
func (*UpdateListingRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateListingRequest.ProtoReflect.Descriptor instead.
func (*UpdateListingRequest) GetListing
func (x *UpdateListingRequest) GetListing() *Listingfunc (*UpdateListingRequest) GetUpdateMask
func (x *UpdateListingRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateListingRequest) ProtoMessage
func (*UpdateListingRequest) ProtoMessage()func (*UpdateListingRequest) ProtoReflect
func (x *UpdateListingRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateListingRequest) Reset
func (x *UpdateListingRequest) Reset()func (*UpdateListingRequest) String
func (x *UpdateListingRequest) String() stringUpdateQueryTemplateRequest
type UpdateQueryTemplateRequest struct {
// Optional. Field mask specifies the fields to update in the query template
// 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 QueryTemplate to update.
QueryTemplate *QueryTemplate `protobuf:"bytes,2,opt,name=query_template,json=queryTemplate,proto3" json:"query_template,omitempty"`
// contains filtered or unexported fields
}Message for updating a QueryTemplate.
func (*UpdateQueryTemplateRequest) Descriptor
func (*UpdateQueryTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateQueryTemplateRequest.ProtoReflect.Descriptor instead.
func (*UpdateQueryTemplateRequest) GetQueryTemplate
func (x *UpdateQueryTemplateRequest) GetQueryTemplate() *QueryTemplatefunc (*UpdateQueryTemplateRequest) GetUpdateMask
func (x *UpdateQueryTemplateRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateQueryTemplateRequest) ProtoMessage
func (*UpdateQueryTemplateRequest) ProtoMessage()func (*UpdateQueryTemplateRequest) ProtoReflect
func (x *UpdateQueryTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateQueryTemplateRequest) Reset
func (x *UpdateQueryTemplateRequest) Reset()func (*UpdateQueryTemplateRequest) String
func (x *UpdateQueryTemplateRequest) String() string