analyticshubpb

package
v1.71.0 Latest Latest
Warning

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

Go to latest
Published: Sep 30, 2025 License: Apache-2.0 Imports: 16 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source
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.

View Source
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.

View Source
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.

View Source
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.

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

Enum value maps for Listing_State.

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

View Source
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.

View Source
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.

View Source
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.

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

Enum value maps for Subscription_State.

View Source
var File_google_cloud_bigquery_analyticshub_v1_analyticshub_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_bigquery_analyticshub_v1_pubsub_proto protoreflect.FileDescriptor

Functions

func RegisterAnalyticsHubServiceServer

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

Types

type AnalyticsHubServiceClient

type AnalyticsHubServiceClient interface {
	// Lists all data exchanges in a given project and location.
	ListDataExchanges(ctx context.Context, in *ListDataExchangesRequest, opts ...grpc.CallOption) (*ListDataExchangesResponse, error)
	// Lists all data exchanges from projects in a given organization and
	// location.
	ListOrgDataExchanges(ctx context.Context, in *ListOrgDataExchangesRequest, opts ...grpc.CallOption) (*ListOrgDataExchangesResponse, error)
	// Gets the details of a data exchange.
	GetDataExchange(ctx context.Context, in *GetDataExchangeRequest, opts ...grpc.CallOption) (*DataExchange, error)
	// Creates a new data exchange.
	CreateDataExchange(ctx context.Context, in *CreateDataExchangeRequest, opts ...grpc.CallOption) (*DataExchange, error)
	// Updates an existing data exchange.
	UpdateDataExchange(ctx context.Context, in *UpdateDataExchangeRequest, opts ...grpc.CallOption) (*DataExchange, error)
	// Deletes an existing data exchange.
	DeleteDataExchange(ctx context.Context, in *DeleteDataExchangeRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all listings in a given project and location.
	ListListings(ctx context.Context, in *ListListingsRequest, opts ...grpc.CallOption) (*ListListingsResponse, error)
	// Gets the details of a listing.
	GetListing(ctx context.Context, in *GetListingRequest, opts ...grpc.CallOption) (*Listing, error)
	// Creates a new listing.
	CreateListing(ctx context.Context, in *CreateListingRequest, opts ...grpc.CallOption) (*Listing, error)
	// Updates an existing listing.
	UpdateListing(ctx context.Context, in *UpdateListingRequest, opts ...grpc.CallOption) (*Listing, error)
	// Deletes a listing.
	DeleteListing(ctx context.Context, in *DeleteListingRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Subscribes to a listing.
	//
	// Currently, with Analytics Hub, you can create listings that
	// reference only BigQuery datasets.
	// Upon subscription to a listing for a BigQuery dataset, Analytics Hub
	// creates a linked dataset in the subscriber's project.
	SubscribeListing(ctx context.Context, in *SubscribeListingRequest, opts ...grpc.CallOption) (*SubscribeListingResponse, error)
	// Creates a Subscription to a Data 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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type AnalyticsHubServiceServer

type AnalyticsHubServiceServer interface {
	// Lists all data exchanges in a given project and location.
	ListDataExchanges(context.Context, *ListDataExchangesRequest) (*ListDataExchangesResponse, error)
	// Lists all data exchanges from projects in a given organization and
	// location.
	ListOrgDataExchanges(context.Context, *ListOrgDataExchangesRequest) (*ListOrgDataExchangesResponse, error)
	// Gets the details of a data exchange.
	GetDataExchange(context.Context, *GetDataExchangeRequest) (*DataExchange, error)
	// Creates a new data exchange.
	CreateDataExchange(context.Context, *CreateDataExchangeRequest) (*DataExchange, error)
	// Updates an existing data exchange.
	UpdateDataExchange(context.Context, *UpdateDataExchangeRequest) (*DataExchange, error)
	// Deletes an existing data exchange.
	DeleteDataExchange(context.Context, *DeleteDataExchangeRequest) (*emptypb.Empty, error)
	// Lists all listings in a given project and location.
	ListListings(context.Context, *ListListingsRequest) (*ListListingsResponse, error)
	// Gets the details of a listing.
	GetListing(context.Context, *GetListingRequest) (*Listing, error)
	// Creates a new listing.
	CreateListing(context.Context, *CreateListingRequest) (*Listing, error)
	// Updates an existing listing.
	UpdateListing(context.Context, *UpdateListingRequest) (*Listing, error)
	// Deletes a listing.
	DeleteListing(context.Context, *DeleteListingRequest) (*emptypb.Empty, error)
	// Subscribes to a listing.
	//
	// Currently, with Analytics Hub, you can create listings that
	// reference only BigQuery datasets.
	// Upon subscription to a listing for a BigQuery dataset, Analytics Hub
	// creates a linked dataset in the subscriber's project.
	SubscribeListing(context.Context, *SubscribeListingRequest) (*SubscribeListingResponse, error)
	// Creates a Subscription to a Data 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.

type ApproveQueryTemplateRequest added in v1.71.0

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 deprecated added in v1.71.0

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

Deprecated: Use ApproveQueryTemplateRequest.ProtoReflect.Descriptor instead.

func (*ApproveQueryTemplateRequest) GetName added in v1.71.0

func (x *ApproveQueryTemplateRequest) GetName() string

func (*ApproveQueryTemplateRequest) ProtoMessage added in v1.71.0

func (*ApproveQueryTemplateRequest) ProtoMessage()

func (*ApproveQueryTemplateRequest) ProtoReflect added in v1.71.0

func (*ApproveQueryTemplateRequest) Reset added in v1.71.0

func (x *ApproveQueryTemplateRequest) Reset()

func (*ApproveQueryTemplateRequest) String added in v1.71.0

func (x *ApproveQueryTemplateRequest) String() string

type BigQueryConfig added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use BigQueryConfig.ProtoReflect.Descriptor instead.

func (*BigQueryConfig) GetDropUnknownFields added in v1.68.0

func (x *BigQueryConfig) GetDropUnknownFields() bool

func (*BigQueryConfig) GetServiceAccountEmail added in v1.68.0

func (x *BigQueryConfig) GetServiceAccountEmail() string

func (*BigQueryConfig) GetTable added in v1.68.0

func (x *BigQueryConfig) GetTable() string

func (*BigQueryConfig) GetUseTableSchema added in v1.68.0

func (x *BigQueryConfig) GetUseTableSchema() bool

func (*BigQueryConfig) GetUseTopicSchema added in v1.68.0

func (x *BigQueryConfig) GetUseTopicSchema() bool

func (*BigQueryConfig) GetWriteMetadata added in v1.68.0

func (x *BigQueryConfig) GetWriteMetadata() bool

func (*BigQueryConfig) ProtoMessage added in v1.68.0

func (*BigQueryConfig) ProtoMessage()

func (*BigQueryConfig) ProtoReflect added in v1.68.0

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

func (*BigQueryConfig) Reset added in v1.68.0

func (x *BigQueryConfig) Reset()

func (*BigQueryConfig) String added in v1.68.0

func (x *BigQueryConfig) String() string

type CloudStorageConfig added in v1.68.0

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 `` /* 130-byte string literal not displayed */
	// 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 deprecated added in v1.68.0

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

Deprecated: Use CloudStorageConfig.ProtoReflect.Descriptor instead.

func (*CloudStorageConfig) GetAvroConfig added in v1.68.0

func (*CloudStorageConfig) GetBucket added in v1.68.0

func (x *CloudStorageConfig) GetBucket() string

func (*CloudStorageConfig) GetFilenameDatetimeFormat added in v1.68.0

func (x *CloudStorageConfig) GetFilenameDatetimeFormat() string

func (*CloudStorageConfig) GetFilenamePrefix added in v1.68.0

func (x *CloudStorageConfig) GetFilenamePrefix() string

func (*CloudStorageConfig) GetFilenameSuffix added in v1.68.0

func (x *CloudStorageConfig) GetFilenameSuffix() string

func (*CloudStorageConfig) GetMaxBytes added in v1.68.0

func (x *CloudStorageConfig) GetMaxBytes() int64

func (*CloudStorageConfig) GetMaxDuration added in v1.68.0

func (x *CloudStorageConfig) GetMaxDuration() *durationpb.Duration

func (*CloudStorageConfig) GetMaxMessages added in v1.68.0

func (x *CloudStorageConfig) GetMaxMessages() int64

func (*CloudStorageConfig) GetOutputFormat added in v1.68.0

func (m *CloudStorageConfig) GetOutputFormat() isCloudStorageConfig_OutputFormat

func (*CloudStorageConfig) GetServiceAccountEmail added in v1.68.0

func (x *CloudStorageConfig) GetServiceAccountEmail() string

func (*CloudStorageConfig) GetTextConfig added in v1.68.0

func (*CloudStorageConfig) ProtoMessage added in v1.68.0

func (*CloudStorageConfig) ProtoMessage()

func (*CloudStorageConfig) ProtoReflect added in v1.68.0

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

func (*CloudStorageConfig) Reset added in v1.68.0

func (x *CloudStorageConfig) Reset()

func (*CloudStorageConfig) String added in v1.68.0

func (x *CloudStorageConfig) String() string

type CloudStorageConfig_AvroConfig added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use CloudStorageConfig_AvroConfig.ProtoReflect.Descriptor instead.

func (*CloudStorageConfig_AvroConfig) GetUseTopicSchema added in v1.68.0

func (x *CloudStorageConfig_AvroConfig) GetUseTopicSchema() bool

func (*CloudStorageConfig_AvroConfig) GetWriteMetadata added in v1.68.0

func (x *CloudStorageConfig_AvroConfig) GetWriteMetadata() bool

func (*CloudStorageConfig_AvroConfig) ProtoMessage added in v1.68.0

func (*CloudStorageConfig_AvroConfig) ProtoMessage()

func (*CloudStorageConfig_AvroConfig) ProtoReflect added in v1.68.0

func (*CloudStorageConfig_AvroConfig) Reset added in v1.68.0

func (x *CloudStorageConfig_AvroConfig) Reset()

func (*CloudStorageConfig_AvroConfig) String added in v1.68.0

type CloudStorageConfig_AvroConfig_ added in v1.68.0

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"`
}

type CloudStorageConfig_TextConfig added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use CloudStorageConfig_TextConfig.ProtoReflect.Descriptor instead.

func (*CloudStorageConfig_TextConfig) ProtoMessage added in v1.68.0

func (*CloudStorageConfig_TextConfig) ProtoMessage()

func (*CloudStorageConfig_TextConfig) ProtoReflect added in v1.68.0

func (*CloudStorageConfig_TextConfig) Reset added in v1.68.0

func (x *CloudStorageConfig_TextConfig) Reset()

func (*CloudStorageConfig_TextConfig) String added in v1.68.0

type CloudStorageConfig_TextConfig_ added in v1.68.0

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"`
}

type CreateDataExchangeRequest

type CreateDataExchangeRequest struct {

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

Message for creating a data exchange.

func (*CreateDataExchangeRequest) Descriptor deprecated

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

Deprecated: Use CreateDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*CreateDataExchangeRequest) GetDataExchange

func (x *CreateDataExchangeRequest) GetDataExchange() *DataExchange

func (*CreateDataExchangeRequest) GetDataExchangeId

func (x *CreateDataExchangeRequest) GetDataExchangeId() string

func (*CreateDataExchangeRequest) GetParent

func (x *CreateDataExchangeRequest) GetParent() string

func (*CreateDataExchangeRequest) ProtoMessage

func (*CreateDataExchangeRequest) ProtoMessage()

func (*CreateDataExchangeRequest) ProtoReflect

func (*CreateDataExchangeRequest) Reset

func (x *CreateDataExchangeRequest) Reset()

func (*CreateDataExchangeRequest) String

func (x *CreateDataExchangeRequest) String() string

type CreateListingRequest

type CreateListingRequest struct {

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

Message for creating a listing.

func (*CreateListingRequest) Descriptor deprecated

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

Deprecated: Use CreateListingRequest.ProtoReflect.Descriptor instead.

func (*CreateListingRequest) GetListing

func (x *CreateListingRequest) GetListing() *Listing

func (*CreateListingRequest) GetListingId

func (x *CreateListingRequest) GetListingId() string

func (*CreateListingRequest) GetParent

func (x *CreateListingRequest) GetParent() string

func (*CreateListingRequest) ProtoMessage

func (*CreateListingRequest) ProtoMessage()

func (*CreateListingRequest) ProtoReflect

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

func (*CreateListingRequest) Reset

func (x *CreateListingRequest) Reset()

func (*CreateListingRequest) String

func (x *CreateListingRequest) String() string

type CreateQueryTemplateRequest added in v1.71.0

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 deprecated added in v1.71.0

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

Deprecated: Use CreateQueryTemplateRequest.ProtoReflect.Descriptor instead.

func (*CreateQueryTemplateRequest) GetParent added in v1.71.0

func (x *CreateQueryTemplateRequest) GetParent() string

func (*CreateQueryTemplateRequest) GetQueryTemplate added in v1.71.0

func (x *CreateQueryTemplateRequest) GetQueryTemplate() *QueryTemplate

func (*CreateQueryTemplateRequest) GetQueryTemplateId added in v1.71.0

func (x *CreateQueryTemplateRequest) GetQueryTemplateId() string

func (*CreateQueryTemplateRequest) ProtoMessage added in v1.71.0

func (*CreateQueryTemplateRequest) ProtoMessage()

func (*CreateQueryTemplateRequest) ProtoReflect added in v1.71.0

func (*CreateQueryTemplateRequest) Reset added in v1.71.0

func (x *CreateQueryTemplateRequest) Reset()

func (*CreateQueryTemplateRequest) String added in v1.71.0

func (x *CreateQueryTemplateRequest) String() string

type DataExchange

type DataExchange struct {

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

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

func (*DataExchange) Descriptor deprecated

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

Deprecated: Use DataExchange.ProtoReflect.Descriptor instead.

func (*DataExchange) GetDescription

func (x *DataExchange) GetDescription() string

func (*DataExchange) GetDiscoveryType added in v1.62.0

func (x *DataExchange) GetDiscoveryType() DiscoveryType

func (*DataExchange) GetDisplayName

func (x *DataExchange) GetDisplayName() string

func (*DataExchange) GetDocumentation

func (x *DataExchange) GetDocumentation() string

func (*DataExchange) GetIcon

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

func (*DataExchange) GetListingCount

func (x *DataExchange) GetListingCount() int32

func (*DataExchange) GetLogLinkedDatasetQueryUserEmail added in v1.68.0

func (x *DataExchange) GetLogLinkedDatasetQueryUserEmail() bool

func (*DataExchange) GetName

func (x *DataExchange) GetName() string

func (*DataExchange) GetPrimaryContact

func (x *DataExchange) GetPrimaryContact() string

func (*DataExchange) GetSharingEnvironmentConfig added in v1.56.0

func (x *DataExchange) GetSharingEnvironmentConfig() *SharingEnvironmentConfig

func (*DataExchange) ProtoMessage

func (*DataExchange) ProtoMessage()

func (*DataExchange) ProtoReflect

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

func (*DataExchange) Reset

func (x *DataExchange) Reset()

func (*DataExchange) String

func (x *DataExchange) String() string

type DataProvider

type DataProvider struct {

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

Contains details of the data provider.

func (*DataProvider) Descriptor deprecated

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

Deprecated: Use DataProvider.ProtoReflect.Descriptor instead.

func (*DataProvider) GetName

func (x *DataProvider) GetName() string

func (*DataProvider) GetPrimaryContact

func (x *DataProvider) GetPrimaryContact() string

func (*DataProvider) ProtoMessage

func (*DataProvider) ProtoMessage()

func (*DataProvider) ProtoReflect

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

func (*DataProvider) Reset

func (x *DataProvider) Reset()

func (*DataProvider) String

func (x *DataProvider) String() string

type DeadLetterPolicy added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use DeadLetterPolicy.ProtoReflect.Descriptor instead.

func (*DeadLetterPolicy) GetDeadLetterTopic added in v1.68.0

func (x *DeadLetterPolicy) GetDeadLetterTopic() string

func (*DeadLetterPolicy) GetMaxDeliveryAttempts added in v1.68.0

func (x *DeadLetterPolicy) GetMaxDeliveryAttempts() int32

func (*DeadLetterPolicy) ProtoMessage added in v1.68.0

func (*DeadLetterPolicy) ProtoMessage()

func (*DeadLetterPolicy) ProtoReflect added in v1.68.0

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

func (*DeadLetterPolicy) Reset added in v1.68.0

func (x *DeadLetterPolicy) Reset()

func (*DeadLetterPolicy) String added in v1.68.0

func (x *DeadLetterPolicy) String() string

type DeleteDataExchangeRequest

type DeleteDataExchangeRequest struct {

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

Message for deleting a data exchange.

func (*DeleteDataExchangeRequest) Descriptor deprecated

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

Deprecated: Use DeleteDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataExchangeRequest) GetName

func (x *DeleteDataExchangeRequest) GetName() string

func (*DeleteDataExchangeRequest) ProtoMessage

func (*DeleteDataExchangeRequest) ProtoMessage()

func (*DeleteDataExchangeRequest) ProtoReflect

func (*DeleteDataExchangeRequest) Reset

func (x *DeleteDataExchangeRequest) Reset()

func (*DeleteDataExchangeRequest) String

func (x *DeleteDataExchangeRequest) String() string

type DeleteListingRequest

type DeleteListingRequest struct {

	// Required. Resource name of the listing to delete.
	// e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// 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 deprecated

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

Deprecated: Use DeleteListingRequest.ProtoReflect.Descriptor instead.

func (*DeleteListingRequest) GetDeleteCommercial added in v1.69.0

func (x *DeleteListingRequest) GetDeleteCommercial() bool

func (*DeleteListingRequest) GetName

func (x *DeleteListingRequest) GetName() string

func (*DeleteListingRequest) ProtoMessage

func (*DeleteListingRequest) ProtoMessage()

func (*DeleteListingRequest) ProtoReflect

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

func (*DeleteListingRequest) Reset

func (x *DeleteListingRequest) Reset()

func (*DeleteListingRequest) String

func (x *DeleteListingRequest) String() string

type DeleteQueryTemplateRequest added in v1.71.0

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 deprecated added in v1.71.0

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

Deprecated: Use DeleteQueryTemplateRequest.ProtoReflect.Descriptor instead.

func (*DeleteQueryTemplateRequest) GetName added in v1.71.0

func (x *DeleteQueryTemplateRequest) GetName() string

func (*DeleteQueryTemplateRequest) ProtoMessage added in v1.71.0

func (*DeleteQueryTemplateRequest) ProtoMessage()

func (*DeleteQueryTemplateRequest) ProtoReflect added in v1.71.0

func (*DeleteQueryTemplateRequest) Reset added in v1.71.0

func (x *DeleteQueryTemplateRequest) Reset()

func (*DeleteQueryTemplateRequest) String added in v1.71.0

func (x *DeleteQueryTemplateRequest) String() string

type DeleteSubscriptionRequest added in v1.56.0

type DeleteSubscriptionRequest struct {

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

Message for deleting a subscription.

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

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

Deprecated: Use DeleteSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*DeleteSubscriptionRequest) GetName added in v1.56.0

func (x *DeleteSubscriptionRequest) GetName() string

func (*DeleteSubscriptionRequest) ProtoMessage added in v1.56.0

func (*DeleteSubscriptionRequest) ProtoMessage()

func (*DeleteSubscriptionRequest) ProtoReflect added in v1.56.0

func (*DeleteSubscriptionRequest) Reset added in v1.56.0

func (x *DeleteSubscriptionRequest) Reset()

func (*DeleteSubscriptionRequest) String added in v1.56.0

func (x *DeleteSubscriptionRequest) String() string

type DestinationDataset

type DestinationDataset struct {

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

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

Deprecated: Use DestinationDataset.ProtoReflect.Descriptor instead.

func (*DestinationDataset) GetDatasetReference

func (x *DestinationDataset) GetDatasetReference() *DestinationDatasetReference

func (*DestinationDataset) GetDescription

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

func (*DestinationDataset) GetFriendlyName

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

func (*DestinationDataset) GetLabels

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

func (*DestinationDataset) GetLocation

func (x *DestinationDataset) GetLocation() string

func (*DestinationDataset) GetReplicaLocations added in v1.71.0

func (x *DestinationDataset) GetReplicaLocations() []string

func (*DestinationDataset) ProtoMessage

func (*DestinationDataset) ProtoMessage()

func (*DestinationDataset) ProtoReflect

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

func (*DestinationDataset) Reset

func (x *DestinationDataset) Reset()

func (*DestinationDataset) String

func (x *DestinationDataset) String() string

type DestinationDatasetReference

type DestinationDatasetReference struct {

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

func (*DestinationDatasetReference) Descriptor deprecated

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

Deprecated: Use DestinationDatasetReference.ProtoReflect.Descriptor instead.

func (*DestinationDatasetReference) GetDatasetId

func (x *DestinationDatasetReference) GetDatasetId() string

func (*DestinationDatasetReference) GetProjectId

func (x *DestinationDatasetReference) GetProjectId() string

func (*DestinationDatasetReference) ProtoMessage

func (*DestinationDatasetReference) ProtoMessage()

func (*DestinationDatasetReference) ProtoReflect

func (*DestinationDatasetReference) Reset

func (x *DestinationDatasetReference) Reset()

func (*DestinationDatasetReference) String

func (x *DestinationDatasetReference) String() string

type DestinationPubSubSubscription added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use DestinationPubSubSubscription.ProtoReflect.Descriptor instead.

func (*DestinationPubSubSubscription) GetPubsubSubscription added in v1.68.0

func (x *DestinationPubSubSubscription) GetPubsubSubscription() *PubSubSubscription

func (*DestinationPubSubSubscription) ProtoMessage added in v1.68.0

func (*DestinationPubSubSubscription) ProtoMessage()

func (*DestinationPubSubSubscription) ProtoReflect added in v1.68.0

func (*DestinationPubSubSubscription) Reset added in v1.68.0

func (x *DestinationPubSubSubscription) Reset()

func (*DestinationPubSubSubscription) String added in v1.68.0

type DiscoveryType added in v1.62.0

type DiscoveryType int32

Specifies 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.

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 added in v1.62.0

func (DiscoveryType) Enum added in v1.62.0

func (x DiscoveryType) Enum() *DiscoveryType

func (DiscoveryType) EnumDescriptor deprecated added in v1.62.0

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

Deprecated: Use DiscoveryType.Descriptor instead.

func (DiscoveryType) Number added in v1.62.0

func (DiscoveryType) String added in v1.62.0

func (x DiscoveryType) String() string

func (DiscoveryType) Type added in v1.62.0

type ExpirationPolicy added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use ExpirationPolicy.ProtoReflect.Descriptor instead.

func (*ExpirationPolicy) GetTtl added in v1.68.0

func (x *ExpirationPolicy) GetTtl() *durationpb.Duration

func (*ExpirationPolicy) ProtoMessage added in v1.68.0

func (*ExpirationPolicy) ProtoMessage()

func (*ExpirationPolicy) ProtoReflect added in v1.68.0

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

func (*ExpirationPolicy) Reset added in v1.68.0

func (x *ExpirationPolicy) Reset()

func (*ExpirationPolicy) String added in v1.68.0

func (x *ExpirationPolicy) String() string

type GetDataExchangeRequest

type GetDataExchangeRequest struct {

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

Message for getting a data exchange.

func (*GetDataExchangeRequest) Descriptor deprecated

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

Deprecated: Use GetDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*GetDataExchangeRequest) GetName

func (x *GetDataExchangeRequest) GetName() string

func (*GetDataExchangeRequest) ProtoMessage

func (*GetDataExchangeRequest) ProtoMessage()

func (*GetDataExchangeRequest) ProtoReflect

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

func (*GetDataExchangeRequest) Reset

func (x *GetDataExchangeRequest) Reset()

func (*GetDataExchangeRequest) String

func (x *GetDataExchangeRequest) String() string

type GetListingRequest

type GetListingRequest struct {

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

Message for getting a listing.

func (*GetListingRequest) Descriptor deprecated

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

Deprecated: Use GetListingRequest.ProtoReflect.Descriptor instead.

func (*GetListingRequest) GetName

func (x *GetListingRequest) GetName() string

func (*GetListingRequest) ProtoMessage

func (*GetListingRequest) ProtoMessage()

func (*GetListingRequest) ProtoReflect

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

func (*GetListingRequest) Reset

func (x *GetListingRequest) Reset()

func (*GetListingRequest) String

func (x *GetListingRequest) String() string

type GetQueryTemplateRequest added in v1.71.0

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 deprecated added in v1.71.0

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

Deprecated: Use GetQueryTemplateRequest.ProtoReflect.Descriptor instead.

func (*GetQueryTemplateRequest) GetName added in v1.71.0

func (x *GetQueryTemplateRequest) GetName() string

func (*GetQueryTemplateRequest) ProtoMessage added in v1.71.0

func (*GetQueryTemplateRequest) ProtoMessage()

func (*GetQueryTemplateRequest) ProtoReflect added in v1.71.0

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

func (*GetQueryTemplateRequest) Reset added in v1.71.0

func (x *GetQueryTemplateRequest) Reset()

func (*GetQueryTemplateRequest) String added in v1.71.0

func (x *GetQueryTemplateRequest) String() string

type GetSubscriptionRequest added in v1.56.0

type GetSubscriptionRequest struct {

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

Message for getting a subscription.

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

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

Deprecated: Use GetSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*GetSubscriptionRequest) GetName added in v1.56.0

func (x *GetSubscriptionRequest) GetName() string

func (*GetSubscriptionRequest) ProtoMessage added in v1.56.0

func (*GetSubscriptionRequest) ProtoMessage()

func (*GetSubscriptionRequest) ProtoReflect added in v1.56.0

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

func (*GetSubscriptionRequest) Reset added in v1.56.0

func (x *GetSubscriptionRequest) Reset()

func (*GetSubscriptionRequest) String added in v1.56.0

func (x *GetSubscriptionRequest) String() string

type JavaScriptUDF added in v1.68.0

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 {(Object<string, (string | Object<string, string>)>|null)} - To
	//	* filter a message, return `null`. To transform a message return a map
	//	* with the following keys:
	//	*   - (required) 'data' : {string}
	//	*   - (optional) 'attributes' : {Object<string, string>}
	//	* Returning empty `attributes` will remove all attributes from the
	//	* message.
	//	*
	//	* @param  {(Object<string, (string | Object<string, string>)>} Pub/Sub
	//	* message. Keys:
	//	*   - (required) 'data' : {string}
	//	*   - (required) 'attributes' : {Object<string, string>}
	//	*
	//	* @param  {Object<string, any>} metadata - Pub/Sub message metadata.
	//	* Keys:
	//	*   - (required) 'message_id'  : {string}
	//	*   - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format
	//	*   - (optional) 'ordering_key': {string}
	//	*/
	//
	//	function <function_name>(message, metadata) {
	//	}
	//
	// “`
	Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
	// contains filtered or unexported fields
}

User-defined JavaScript function that can transform or filter a Pub/Sub message.

func (*JavaScriptUDF) Descriptor deprecated added in v1.68.0

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

Deprecated: Use JavaScriptUDF.ProtoReflect.Descriptor instead.

func (*JavaScriptUDF) GetCode added in v1.68.0

func (x *JavaScriptUDF) GetCode() string

func (*JavaScriptUDF) GetFunctionName added in v1.68.0

func (x *JavaScriptUDF) GetFunctionName() string

func (*JavaScriptUDF) ProtoMessage added in v1.68.0

func (*JavaScriptUDF) ProtoMessage()

func (*JavaScriptUDF) ProtoReflect added in v1.68.0

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

func (*JavaScriptUDF) Reset added in v1.68.0

func (x *JavaScriptUDF) Reset()

func (*JavaScriptUDF) String added in v1.68.0

func (x *JavaScriptUDF) String() string

type ListDataExchangesRequest

type ListDataExchangesRequest struct {

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

Message for requesting the list of data exchanges.

func (*ListDataExchangesRequest) Descriptor deprecated

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

Deprecated: Use ListDataExchangesRequest.ProtoReflect.Descriptor instead.

func (*ListDataExchangesRequest) GetPageSize

func (x *ListDataExchangesRequest) GetPageSize() int32

func (*ListDataExchangesRequest) GetPageToken

func (x *ListDataExchangesRequest) GetPageToken() string

func (*ListDataExchangesRequest) GetParent

func (x *ListDataExchangesRequest) GetParent() string

func (*ListDataExchangesRequest) ProtoMessage

func (*ListDataExchangesRequest) ProtoMessage()

func (*ListDataExchangesRequest) ProtoReflect

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

func (*ListDataExchangesRequest) Reset

func (x *ListDataExchangesRequest) Reset()

func (*ListDataExchangesRequest) String

func (x *ListDataExchangesRequest) String() string

type ListDataExchangesResponse

type ListDataExchangesResponse struct {

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

Message for response to the list of data exchanges.

func (*ListDataExchangesResponse) Descriptor deprecated

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

Deprecated: Use ListDataExchangesResponse.ProtoReflect.Descriptor instead.

func (*ListDataExchangesResponse) GetDataExchanges

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

func (*ListDataExchangesResponse) GetNextPageToken

func (x *ListDataExchangesResponse) GetNextPageToken() string

func (*ListDataExchangesResponse) ProtoMessage

func (*ListDataExchangesResponse) ProtoMessage()

func (*ListDataExchangesResponse) ProtoReflect

func (*ListDataExchangesResponse) Reset

func (x *ListDataExchangesResponse) Reset()

func (*ListDataExchangesResponse) String

func (x *ListDataExchangesResponse) String() string

type ListListingsRequest

type ListListingsRequest struct {

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

Message for requesting the list of listings.

func (*ListListingsRequest) Descriptor deprecated

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

Deprecated: Use ListListingsRequest.ProtoReflect.Descriptor instead.

func (*ListListingsRequest) GetPageSize

func (x *ListListingsRequest) GetPageSize() int32

func (*ListListingsRequest) GetPageToken

func (x *ListListingsRequest) GetPageToken() string

func (*ListListingsRequest) GetParent

func (x *ListListingsRequest) GetParent() string

func (*ListListingsRequest) ProtoMessage

func (*ListListingsRequest) ProtoMessage()

func (*ListListingsRequest) ProtoReflect

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

func (*ListListingsRequest) Reset

func (x *ListListingsRequest) Reset()

func (*ListListingsRequest) String

func (x *ListListingsRequest) String() string

type ListListingsResponse

type ListListingsResponse struct {

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

Message for response to the list of Listings.

func (*ListListingsResponse) Descriptor deprecated

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

Deprecated: Use ListListingsResponse.ProtoReflect.Descriptor instead.

func (*ListListingsResponse) GetListings

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

func (*ListListingsResponse) GetNextPageToken

func (x *ListListingsResponse) GetNextPageToken() string

func (*ListListingsResponse) ProtoMessage

func (*ListListingsResponse) ProtoMessage()

func (*ListListingsResponse) ProtoReflect

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

func (*ListListingsResponse) Reset

func (x *ListListingsResponse) Reset()

func (*ListListingsResponse) String

func (x *ListListingsResponse) String() string

type ListOrgDataExchangesRequest

type ListOrgDataExchangesRequest struct {

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

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

func (*ListOrgDataExchangesRequest) Descriptor deprecated

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

Deprecated: Use ListOrgDataExchangesRequest.ProtoReflect.Descriptor instead.

func (*ListOrgDataExchangesRequest) GetOrganization

func (x *ListOrgDataExchangesRequest) GetOrganization() string

func (*ListOrgDataExchangesRequest) GetPageSize

func (x *ListOrgDataExchangesRequest) GetPageSize() int32

func (*ListOrgDataExchangesRequest) GetPageToken

func (x *ListOrgDataExchangesRequest) GetPageToken() string

func (*ListOrgDataExchangesRequest) ProtoMessage

func (*ListOrgDataExchangesRequest) ProtoMessage()

func (*ListOrgDataExchangesRequest) ProtoReflect

func (*ListOrgDataExchangesRequest) Reset

func (x *ListOrgDataExchangesRequest) Reset()

func (*ListOrgDataExchangesRequest) String

func (x *ListOrgDataExchangesRequest) String() string

type ListOrgDataExchangesResponse

type ListOrgDataExchangesResponse struct {

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

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

func (*ListOrgDataExchangesResponse) Descriptor deprecated

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

Deprecated: Use ListOrgDataExchangesResponse.ProtoReflect.Descriptor instead.

func (*ListOrgDataExchangesResponse) GetDataExchanges

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

func (*ListOrgDataExchangesResponse) GetNextPageToken

func (x *ListOrgDataExchangesResponse) GetNextPageToken() string

func (*ListOrgDataExchangesResponse) ProtoMessage

func (*ListOrgDataExchangesResponse) ProtoMessage()

func (*ListOrgDataExchangesResponse) ProtoReflect

func (*ListOrgDataExchangesResponse) Reset

func (x *ListOrgDataExchangesResponse) Reset()

func (*ListOrgDataExchangesResponse) String

type ListQueryTemplatesRequest added in v1.71.0

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 deprecated added in v1.71.0

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

Deprecated: Use ListQueryTemplatesRequest.ProtoReflect.Descriptor instead.

func (*ListQueryTemplatesRequest) GetPageSize added in v1.71.0

func (x *ListQueryTemplatesRequest) GetPageSize() int32

func (*ListQueryTemplatesRequest) GetPageToken added in v1.71.0

func (x *ListQueryTemplatesRequest) GetPageToken() string

func (*ListQueryTemplatesRequest) GetParent added in v1.71.0

func (x *ListQueryTemplatesRequest) GetParent() string

func (*ListQueryTemplatesRequest) ProtoMessage added in v1.71.0

func (*ListQueryTemplatesRequest) ProtoMessage()

func (*ListQueryTemplatesRequest) ProtoReflect added in v1.71.0

func (*ListQueryTemplatesRequest) Reset added in v1.71.0

func (x *ListQueryTemplatesRequest) Reset()

func (*ListQueryTemplatesRequest) String added in v1.71.0

func (x *ListQueryTemplatesRequest) String() string

type ListQueryTemplatesResponse added in v1.71.0

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 deprecated added in v1.71.0

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

Deprecated: Use ListQueryTemplatesResponse.ProtoReflect.Descriptor instead.

func (*ListQueryTemplatesResponse) GetNextPageToken added in v1.71.0

func (x *ListQueryTemplatesResponse) GetNextPageToken() string

func (*ListQueryTemplatesResponse) GetQueryTemplates added in v1.71.0

func (x *ListQueryTemplatesResponse) GetQueryTemplates() []*QueryTemplate

func (*ListQueryTemplatesResponse) ProtoMessage added in v1.71.0

func (*ListQueryTemplatesResponse) ProtoMessage()

func (*ListQueryTemplatesResponse) ProtoReflect added in v1.71.0

func (*ListQueryTemplatesResponse) Reset added in v1.71.0

func (x *ListQueryTemplatesResponse) Reset()

func (*ListQueryTemplatesResponse) String added in v1.71.0

func (x *ListQueryTemplatesResponse) String() string

type ListSharedResourceSubscriptionsRequest added in v1.56.0

type ListSharedResourceSubscriptionsRequest struct {

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

Message for listing subscriptions of a shared resource.

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

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

Deprecated: Use ListSharedResourceSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListSharedResourceSubscriptionsRequest) GetIncludeDeletedSubscriptions added in v1.56.0

func (x *ListSharedResourceSubscriptionsRequest) GetIncludeDeletedSubscriptions() bool

func (*ListSharedResourceSubscriptionsRequest) GetPageSize added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) GetPageToken added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) GetResource added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) ProtoMessage added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) ProtoReflect added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) Reset added in v1.56.0

func (*ListSharedResourceSubscriptionsRequest) String added in v1.56.0

type ListSharedResourceSubscriptionsResponse added in v1.56.0

type ListSharedResourceSubscriptionsResponse struct {

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

Message for response to the listing of shared resource subscriptions.

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

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

Deprecated: Use ListSharedResourceSubscriptionsResponse.ProtoReflect.Descriptor instead.

func (*ListSharedResourceSubscriptionsResponse) GetNextPageToken added in v1.56.0

func (x *ListSharedResourceSubscriptionsResponse) GetNextPageToken() string

func (*ListSharedResourceSubscriptionsResponse) GetSharedResourceSubscriptions added in v1.56.0

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

func (*ListSharedResourceSubscriptionsResponse) ProtoMessage added in v1.56.0

func (*ListSharedResourceSubscriptionsResponse) ProtoReflect added in v1.56.0

func (*ListSharedResourceSubscriptionsResponse) Reset added in v1.56.0

func (*ListSharedResourceSubscriptionsResponse) String added in v1.56.0

type ListSubscriptionsRequest added in v1.56.0

type ListSubscriptionsRequest struct {

	// Required. The parent resource path of the subscription.
	// e.g. projects/myproject/locations/us
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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 deprecated added in v1.56.0

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

Deprecated: Use ListSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListSubscriptionsRequest) GetFilter added in v1.56.0

func (x *ListSubscriptionsRequest) GetFilter() string

func (*ListSubscriptionsRequest) GetPageSize added in v1.56.0

func (x *ListSubscriptionsRequest) GetPageSize() int32

func (*ListSubscriptionsRequest) GetPageToken added in v1.56.0

func (x *ListSubscriptionsRequest) GetPageToken() string

func (*ListSubscriptionsRequest) GetParent added in v1.56.0

func (x *ListSubscriptionsRequest) GetParent() string

func (*ListSubscriptionsRequest) ProtoMessage added in v1.56.0

func (*ListSubscriptionsRequest) ProtoMessage()

func (*ListSubscriptionsRequest) ProtoReflect added in v1.56.0

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

func (*ListSubscriptionsRequest) Reset added in v1.56.0

func (x *ListSubscriptionsRequest) Reset()

func (*ListSubscriptionsRequest) String added in v1.56.0

func (x *ListSubscriptionsRequest) String() string

type ListSubscriptionsResponse added in v1.56.0

type ListSubscriptionsResponse struct {

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

Message for response to the listing of subscriptions.

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

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

Deprecated: Use ListSubscriptionsResponse.ProtoReflect.Descriptor instead.

func (*ListSubscriptionsResponse) GetNextPageToken added in v1.56.0

func (x *ListSubscriptionsResponse) GetNextPageToken() string

func (*ListSubscriptionsResponse) GetSubscriptions added in v1.56.0

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

func (*ListSubscriptionsResponse) ProtoMessage added in v1.56.0

func (*ListSubscriptionsResponse) ProtoMessage()

func (*ListSubscriptionsResponse) ProtoReflect added in v1.56.0

func (*ListSubscriptionsResponse) Reset added in v1.56.0

func (x *ListSubscriptionsResponse) Reset()

func (*ListSubscriptionsResponse) String added in v1.56.0

func (x *ListSubscriptionsResponse) String() string

type Listing

type Listing struct {

	// Listing source.
	//
	// Types that are assignable to Source:
	//
	//	*Listing_BigqueryDataset
	//	*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 `` /* 142-byte string literal not displayed */
	// Optional. Details of the publisher who owns the listing and who can share
	// the source data.
	Publisher *Publisher `protobuf:"bytes,11,opt,name=publisher,proto3" json:"publisher,omitempty"`
	// Optional. Email or URL of the request access of the listing.
	// Subscribers can use this reference to request access.
	// Max Length: 1000 bytes.
	RequestAccess string `protobuf:"bytes,12,opt,name=request_access,json=requestAccess,proto3" json:"request_access,omitempty"`
	// Optional. If set, restricted export configuration will be propagated and
	// enforced on the linked dataset.
	RestrictedExportConfig *Listing_RestrictedExportConfig `` /* 130-byte string literal not displayed */
	// Optional. Type of discovery of the listing on the discovery page.
	DiscoveryType *DiscoveryType `` /* 165-byte string literal not displayed */
	// Output only. Listing shared asset type.
	ResourceType SharedResourceType `` /* 161-byte string literal not displayed */
	// 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 `` /* 167-byte string literal not displayed */
	// Optional. If true, the listing is only available to get the resource
	// metadata. Listing is non subscribable.
	AllowOnlyMetadataSharing *bool `` /* 145-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*Listing) Descriptor deprecated

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

Deprecated: Use Listing.ProtoReflect.Descriptor instead.

func (*Listing) GetAllowOnlyMetadataSharing added in v1.69.0

func (x *Listing) GetAllowOnlyMetadataSharing() bool

func (*Listing) GetBigqueryDataset

func (x *Listing) GetBigqueryDataset() *Listing_BigQueryDatasetSource

func (*Listing) GetCategories

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

func (*Listing) GetCommercialInfo added in v1.69.0

func (x *Listing) GetCommercialInfo() *Listing_CommercialInfo

func (*Listing) GetDataProvider

func (x *Listing) GetDataProvider() *DataProvider

func (*Listing) GetDescription

func (x *Listing) GetDescription() string

func (*Listing) GetDiscoveryType added in v1.62.0

func (x *Listing) GetDiscoveryType() DiscoveryType

func (*Listing) GetDisplayName

func (x *Listing) GetDisplayName() string

func (*Listing) GetDocumentation

func (x *Listing) GetDocumentation() string

func (*Listing) GetIcon

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

func (*Listing) GetLogLinkedDatasetQueryUserEmail added in v1.68.0

func (x *Listing) GetLogLinkedDatasetQueryUserEmail() bool

func (*Listing) GetName

func (x *Listing) GetName() string

func (*Listing) GetPrimaryContact

func (x *Listing) GetPrimaryContact() string

func (*Listing) GetPublisher

func (x *Listing) GetPublisher() *Publisher

func (*Listing) GetPubsubTopic added in v1.68.0

func (x *Listing) GetPubsubTopic() *Listing_PubSubTopicSource

func (*Listing) GetRequestAccess

func (x *Listing) GetRequestAccess() string

func (*Listing) GetResourceType added in v1.68.0

func (x *Listing) GetResourceType() SharedResourceType

func (*Listing) GetRestrictedExportConfig added in v1.56.0

func (x *Listing) GetRestrictedExportConfig() *Listing_RestrictedExportConfig

func (*Listing) GetSource

func (m *Listing) GetSource() isListing_Source

func (*Listing) GetState

func (x *Listing) GetState() Listing_State

func (*Listing) ProtoMessage

func (*Listing) ProtoMessage()

func (*Listing) ProtoReflect

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

func (*Listing) Reset

func (x *Listing) Reset()

func (*Listing) String

func (x *Listing) String() string

type Listing_BigQueryDatasetSource

type Listing_BigQueryDatasetSource struct {

	// 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 `` /* 129-byte string literal not displayed */
	// 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 deprecated

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

Deprecated: Use Listing_BigQueryDatasetSource.ProtoReflect.Descriptor instead.

func (*Listing_BigQueryDatasetSource) GetDataset

func (x *Listing_BigQueryDatasetSource) GetDataset() string

func (*Listing_BigQueryDatasetSource) GetEffectiveReplicas added in v1.71.0

func (*Listing_BigQueryDatasetSource) GetReplicaLocations added in v1.71.0

func (x *Listing_BigQueryDatasetSource) GetReplicaLocations() []string

func (*Listing_BigQueryDatasetSource) GetRestrictedExportPolicy added in v1.62.0

func (*Listing_BigQueryDatasetSource) GetSelectedResources added in v1.60.0

func (*Listing_BigQueryDatasetSource) ProtoMessage

func (*Listing_BigQueryDatasetSource) ProtoMessage()

func (*Listing_BigQueryDatasetSource) ProtoReflect

func (*Listing_BigQueryDatasetSource) Reset

func (x *Listing_BigQueryDatasetSource) Reset()

func (*Listing_BigQueryDatasetSource) String

type Listing_BigQueryDatasetSource_Replica added in v1.71.0

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 `` /* 192-byte string literal not displayed */
	// Output only. Indicates that this replica is the primary replica.
	PrimaryState *Listing_BigQueryDatasetSource_Replica_PrimaryState `` /* 198-byte string literal not displayed */
	// 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 deprecated added in v1.71.0

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

Deprecated: Use Listing_BigQueryDatasetSource_Replica.ProtoReflect.Descriptor instead.

func (*Listing_BigQueryDatasetSource_Replica) GetLocation added in v1.71.0

func (*Listing_BigQueryDatasetSource_Replica) GetPrimaryState added in v1.71.0

func (*Listing_BigQueryDatasetSource_Replica) GetReplicaState added in v1.71.0

func (*Listing_BigQueryDatasetSource_Replica) ProtoMessage added in v1.71.0

func (*Listing_BigQueryDatasetSource_Replica) ProtoMessage()

func (*Listing_BigQueryDatasetSource_Replica) ProtoReflect added in v1.71.0

func (*Listing_BigQueryDatasetSource_Replica) Reset added in v1.71.0

func (*Listing_BigQueryDatasetSource_Replica) String added in v1.71.0

type Listing_BigQueryDatasetSource_Replica_PrimaryState added in v1.71.0

type Listing_BigQueryDatasetSource_Replica_PrimaryState int32

Primary state of the replica. Set only for the 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 added in v1.71.0

func (Listing_BigQueryDatasetSource_Replica_PrimaryState) Enum added in v1.71.0

func (Listing_BigQueryDatasetSource_Replica_PrimaryState) EnumDescriptor deprecated added in v1.71.0

Deprecated: Use Listing_BigQueryDatasetSource_Replica_PrimaryState.Descriptor instead.

func (Listing_BigQueryDatasetSource_Replica_PrimaryState) Number added in v1.71.0

func (Listing_BigQueryDatasetSource_Replica_PrimaryState) String added in v1.71.0

func (Listing_BigQueryDatasetSource_Replica_PrimaryState) Type added in v1.71.0

type Listing_BigQueryDatasetSource_Replica_ReplicaState added in v1.71.0

type Listing_BigQueryDatasetSource_Replica_ReplicaState int32

Replica state of the shared dataset.

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 added in v1.71.0

func (Listing_BigQueryDatasetSource_Replica_ReplicaState) Enum added in v1.71.0

func (Listing_BigQueryDatasetSource_Replica_ReplicaState) EnumDescriptor deprecated added in v1.71.0

Deprecated: Use Listing_BigQueryDatasetSource_Replica_ReplicaState.Descriptor instead.

func (Listing_BigQueryDatasetSource_Replica_ReplicaState) Number added in v1.71.0

func (Listing_BigQueryDatasetSource_Replica_ReplicaState) String added in v1.71.0

func (Listing_BigQueryDatasetSource_Replica_ReplicaState) Type added in v1.71.0

type Listing_BigQueryDatasetSource_RestrictedExportPolicy added in v1.62.0

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 `` /* 140-byte string literal not displayed */
	// 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 deprecated added in v1.62.0

Deprecated: Use Listing_BigQueryDatasetSource_RestrictedExportPolicy.ProtoReflect.Descriptor instead.

func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) GetEnabled added in v1.62.0

func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) GetRestrictDirectTableAccess added in v1.62.0

func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) GetRestrictQueryResult added in v1.62.0

func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) ProtoMessage added in v1.62.0

func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) ProtoReflect added in v1.62.0

func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) Reset added in v1.62.0

func (*Listing_BigQueryDatasetSource_RestrictedExportPolicy) String added in v1.62.0

type Listing_BigQueryDatasetSource_SelectedResource added in v1.60.0

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 deprecated added in v1.60.0

Deprecated: Use Listing_BigQueryDatasetSource_SelectedResource.ProtoReflect.Descriptor instead.

func (*Listing_BigQueryDatasetSource_SelectedResource) GetResource added in v1.60.0

func (m *Listing_BigQueryDatasetSource_SelectedResource) GetResource() isListing_BigQueryDatasetSource_SelectedResource_Resource

func (*Listing_BigQueryDatasetSource_SelectedResource) GetRoutine added in v1.69.0

func (*Listing_BigQueryDatasetSource_SelectedResource) GetTable added in v1.60.0

func (*Listing_BigQueryDatasetSource_SelectedResource) ProtoMessage added in v1.60.0

func (*Listing_BigQueryDatasetSource_SelectedResource) ProtoReflect added in v1.60.0

func (*Listing_BigQueryDatasetSource_SelectedResource) Reset added in v1.60.0

func (*Listing_BigQueryDatasetSource_SelectedResource) String added in v1.60.0

type Listing_BigQueryDatasetSource_SelectedResource_Routine added in v1.69.0

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"`
}

type Listing_BigQueryDatasetSource_SelectedResource_Table added in v1.60.0

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

type Listing_BigqueryDataset

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

type Listing_Category

type Listing_Category int32

Listing categories.

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

func (Listing_Category) Descriptor

func (Listing_Category) Enum

func (Listing_Category) EnumDescriptor deprecated

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

Deprecated: Use Listing_Category.Descriptor instead.

func (Listing_Category) Number

func (Listing_Category) String

func (x Listing_Category) String() string

func (Listing_Category) Type

type Listing_CommercialInfo added in v1.69.0

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 deprecated added in v1.69.0

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

Deprecated: Use Listing_CommercialInfo.ProtoReflect.Descriptor instead.

func (*Listing_CommercialInfo) GetCloudMarketplace added in v1.69.0

func (*Listing_CommercialInfo) ProtoMessage added in v1.69.0

func (*Listing_CommercialInfo) ProtoMessage()

func (*Listing_CommercialInfo) ProtoReflect added in v1.69.0

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

func (*Listing_CommercialInfo) Reset added in v1.69.0

func (x *Listing_CommercialInfo) Reset()

func (*Listing_CommercialInfo) String added in v1.69.0

func (x *Listing_CommercialInfo) String() string

type Listing_CommercialInfo_GoogleCloudMarketplaceInfo added in v1.69.0

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 `` /* 222-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specifies the details of the Marketplace Data Product associated with the Listing.

func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) Descriptor deprecated added in v1.69.0

Deprecated: Use Listing_CommercialInfo_GoogleCloudMarketplaceInfo.ProtoReflect.Descriptor instead.

func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) GetCommercialState added in v1.69.0

func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) GetService added in v1.69.0

func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoMessage added in v1.69.0

func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoReflect added in v1.69.0

func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) Reset added in v1.69.0

func (*Listing_CommercialInfo_GoogleCloudMarketplaceInfo) String added in v1.69.0

type Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState added in v1.69.0

type Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState int32

Indicates whether this commercial access is currently 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 added in v1.69.0

func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Enum added in v1.69.0

func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) EnumDescriptor deprecated added in v1.69.0

Deprecated: Use Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState.Descriptor instead.

func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Number added in v1.69.0

func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) String added in v1.69.0

func (Listing_CommercialInfo_GoogleCloudMarketplaceInfo_CommercialState) Type added in v1.69.0

type Listing_PubSubTopicSource added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use Listing_PubSubTopicSource.ProtoReflect.Descriptor instead.

func (*Listing_PubSubTopicSource) GetDataAffinityRegions added in v1.68.0

func (x *Listing_PubSubTopicSource) GetDataAffinityRegions() []string

func (*Listing_PubSubTopicSource) GetTopic added in v1.68.0

func (x *Listing_PubSubTopicSource) GetTopic() string

func (*Listing_PubSubTopicSource) ProtoMessage added in v1.68.0

func (*Listing_PubSubTopicSource) ProtoMessage()

func (*Listing_PubSubTopicSource) ProtoReflect added in v1.68.0

func (*Listing_PubSubTopicSource) Reset added in v1.68.0

func (x *Listing_PubSubTopicSource) Reset()

func (*Listing_PubSubTopicSource) String added in v1.68.0

func (x *Listing_PubSubTopicSource) String() string

type Listing_PubsubTopic added in v1.68.0

type Listing_PubsubTopic struct {
	// Pub/Sub topic source.
	PubsubTopic *Listing_PubSubTopicSource `protobuf:"bytes,16,opt,name=pubsub_topic,json=pubsubTopic,proto3,oneof"`
}

type Listing_RestrictedExportConfig added in v1.56.0

type Listing_RestrictedExportConfig struct {

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

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

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

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

Deprecated: Use Listing_RestrictedExportConfig.ProtoReflect.Descriptor instead.

func (*Listing_RestrictedExportConfig) GetEnabled added in v1.56.0

func (x *Listing_RestrictedExportConfig) GetEnabled() bool

func (*Listing_RestrictedExportConfig) GetRestrictDirectTableAccess added in v1.56.0

func (x *Listing_RestrictedExportConfig) GetRestrictDirectTableAccess() bool

func (*Listing_RestrictedExportConfig) GetRestrictQueryResult added in v1.56.0

func (x *Listing_RestrictedExportConfig) GetRestrictQueryResult() bool

func (*Listing_RestrictedExportConfig) ProtoMessage added in v1.56.0

func (*Listing_RestrictedExportConfig) ProtoMessage()

func (*Listing_RestrictedExportConfig) ProtoReflect added in v1.56.0

func (*Listing_RestrictedExportConfig) Reset added in v1.56.0

func (x *Listing_RestrictedExportConfig) Reset()

func (*Listing_RestrictedExportConfig) String added in v1.56.0

type Listing_State

type Listing_State int32

State of the listing.

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

func (Listing_State) Descriptor

func (Listing_State) Enum

func (x Listing_State) Enum() *Listing_State

func (Listing_State) EnumDescriptor deprecated

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

Deprecated: Use Listing_State.Descriptor instead.

func (Listing_State) Number

func (Listing_State) String

func (x Listing_State) String() string

func (Listing_State) Type

type MessageTransform added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use MessageTransform.ProtoReflect.Descriptor instead.

func (*MessageTransform) GetDisabled added in v1.68.0

func (x *MessageTransform) GetDisabled() bool

func (*MessageTransform) GetEnabled deprecated added in v1.68.0

func (x *MessageTransform) GetEnabled() bool

Deprecated: Marked as deprecated in google/cloud/bigquery/analyticshub/v1/pubsub.proto.

func (*MessageTransform) GetJavascriptUdf added in v1.68.0

func (x *MessageTransform) GetJavascriptUdf() *JavaScriptUDF

func (*MessageTransform) GetTransform added in v1.68.0

func (m *MessageTransform) GetTransform() isMessageTransform_Transform

func (*MessageTransform) ProtoMessage added in v1.68.0

func (*MessageTransform) ProtoMessage()

func (*MessageTransform) ProtoReflect added in v1.68.0

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

func (*MessageTransform) Reset added in v1.68.0

func (x *MessageTransform) Reset()

func (*MessageTransform) String added in v1.68.0

func (x *MessageTransform) String() string

type MessageTransform_JavascriptUdf added in v1.68.0

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"`
}

type OperationMetadata added in v1.56.0

type OperationMetadata struct {

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

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

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

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion added in v1.56.0

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetCreateTime added in v1.56.0

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

func (*OperationMetadata) GetEndTime added in v1.56.0

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

func (*OperationMetadata) GetRequestedCancellation added in v1.56.0

func (x *OperationMetadata) GetRequestedCancellation() bool

func (*OperationMetadata) GetStatusMessage added in v1.56.0

func (x *OperationMetadata) GetStatusMessage() string

func (*OperationMetadata) GetTarget added in v1.56.0

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb added in v1.56.0

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage added in v1.56.0

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect added in v1.56.0

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

func (*OperationMetadata) Reset added in v1.56.0

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String added in v1.56.0

func (x *OperationMetadata) String() string

type PubSubSubscription added in v1.68.0

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 `` /* 135-byte string literal not displayed */
	// Optional. See [Creating and managing
	// labels](https://cloud.google.com/pubsub/docs/labels).
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// 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 `` /* 128-byte string literal not displayed */
	// 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 `` /* 142-byte string literal not displayed */
	// 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 deprecated added in v1.68.0

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

Deprecated: Use PubSubSubscription.ProtoReflect.Descriptor instead.

func (*PubSubSubscription) GetAckDeadlineSeconds added in v1.68.0

func (x *PubSubSubscription) GetAckDeadlineSeconds() int32

func (*PubSubSubscription) GetBigqueryConfig added in v1.68.0

func (x *PubSubSubscription) GetBigqueryConfig() *BigQueryConfig

func (*PubSubSubscription) GetCloudStorageConfig added in v1.68.0

func (x *PubSubSubscription) GetCloudStorageConfig() *CloudStorageConfig

func (*PubSubSubscription) GetDeadLetterPolicy added in v1.68.0

func (x *PubSubSubscription) GetDeadLetterPolicy() *DeadLetterPolicy

func (*PubSubSubscription) GetDetached added in v1.68.0

func (x *PubSubSubscription) GetDetached() bool

func (*PubSubSubscription) GetEnableExactlyOnceDelivery added in v1.68.0

func (x *PubSubSubscription) GetEnableExactlyOnceDelivery() bool

func (*PubSubSubscription) GetEnableMessageOrdering added in v1.68.0

func (x *PubSubSubscription) GetEnableMessageOrdering() bool

func (*PubSubSubscription) GetExpirationPolicy added in v1.68.0

func (x *PubSubSubscription) GetExpirationPolicy() *ExpirationPolicy

func (*PubSubSubscription) GetFilter added in v1.68.0

func (x *PubSubSubscription) GetFilter() string

func (*PubSubSubscription) GetLabels added in v1.68.0

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

func (*PubSubSubscription) GetMessageRetentionDuration added in v1.68.0

func (x *PubSubSubscription) GetMessageRetentionDuration() *durationpb.Duration

func (*PubSubSubscription) GetMessageTransforms added in v1.68.0

func (x *PubSubSubscription) GetMessageTransforms() []*MessageTransform

func (*PubSubSubscription) GetName added in v1.68.0

func (x *PubSubSubscription) GetName() string

func (*PubSubSubscription) GetPushConfig added in v1.68.0

func (x *PubSubSubscription) GetPushConfig() *PushConfig

func (*PubSubSubscription) GetRetainAckedMessages added in v1.68.0

func (x *PubSubSubscription) GetRetainAckedMessages() bool

func (*PubSubSubscription) GetRetryPolicy added in v1.68.0

func (x *PubSubSubscription) GetRetryPolicy() *RetryPolicy

func (*PubSubSubscription) ProtoMessage added in v1.68.0

func (*PubSubSubscription) ProtoMessage()

func (*PubSubSubscription) ProtoReflect added in v1.68.0

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

func (*PubSubSubscription) Reset added in v1.68.0

func (x *PubSubSubscription) Reset()

func (*PubSubSubscription) String added in v1.68.0

func (x *PubSubSubscription) String() string

type Publisher

type Publisher struct {

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

Contains details of the listing publisher.

func (*Publisher) Descriptor deprecated

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

Deprecated: Use Publisher.ProtoReflect.Descriptor instead.

func (*Publisher) GetName

func (x *Publisher) GetName() string

func (*Publisher) GetPrimaryContact

func (x *Publisher) GetPrimaryContact() string

func (*Publisher) ProtoMessage

func (*Publisher) ProtoMessage()

func (*Publisher) ProtoReflect

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

func (*Publisher) Reset

func (x *Publisher) Reset()

func (*Publisher) String

func (x *Publisher) String() string

type PushConfig added in v1.68.0

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 `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for a push delivery endpoint.

func (*PushConfig) Descriptor deprecated added in v1.68.0

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

Deprecated: Use PushConfig.ProtoReflect.Descriptor instead.

func (*PushConfig) GetAttributes added in v1.68.0

func (x *PushConfig) GetAttributes() map[string]string

func (*PushConfig) GetAuthenticationMethod added in v1.68.0

func (m *PushConfig) GetAuthenticationMethod() isPushConfig_AuthenticationMethod

func (*PushConfig) GetNoWrapper added in v1.68.0

func (x *PushConfig) GetNoWrapper() *PushConfig_NoWrapper

func (*PushConfig) GetOidcToken added in v1.68.0

func (x *PushConfig) GetOidcToken() *PushConfig_OidcToken

func (*PushConfig) GetPubsubWrapper added in v1.68.0

func (x *PushConfig) GetPubsubWrapper() *PushConfig_PubsubWrapper

func (*PushConfig) GetPushEndpoint added in v1.68.0

func (x *PushConfig) GetPushEndpoint() string

func (*PushConfig) GetWrapper added in v1.68.0

func (m *PushConfig) GetWrapper() isPushConfig_Wrapper

func (*PushConfig) ProtoMessage added in v1.68.0

func (*PushConfig) ProtoMessage()

func (*PushConfig) ProtoReflect added in v1.68.0

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

func (*PushConfig) Reset added in v1.68.0

func (x *PushConfig) Reset()

func (*PushConfig) String added in v1.68.0

func (x *PushConfig) String() string

type PushConfig_NoWrapper added in v1.68.0

type PushConfig_NoWrapper struct {

	// Optional. When true, writes the Pub/Sub message metadata to
	// `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the
	// Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
	WriteMetadata bool `protobuf:"varint,1,opt,name=write_metadata,json=writeMetadata,proto3" json:"write_metadata,omitempty"`
	// contains filtered or unexported fields
}

Sets the `data` field as the HTTP body for delivery.

func (*PushConfig_NoWrapper) Descriptor deprecated added in v1.68.0

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

Deprecated: Use PushConfig_NoWrapper.ProtoReflect.Descriptor instead.

func (*PushConfig_NoWrapper) GetWriteMetadata added in v1.68.0

func (x *PushConfig_NoWrapper) GetWriteMetadata() bool

func (*PushConfig_NoWrapper) ProtoMessage added in v1.68.0

func (*PushConfig_NoWrapper) ProtoMessage()

func (*PushConfig_NoWrapper) ProtoReflect added in v1.68.0

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

func (*PushConfig_NoWrapper) Reset added in v1.68.0

func (x *PushConfig_NoWrapper) Reset()

func (*PushConfig_NoWrapper) String added in v1.68.0

func (x *PushConfig_NoWrapper) String() string

type PushConfig_NoWrapper_ added in v1.68.0

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"`
}

type PushConfig_OidcToken added in v1.68.0

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](https://developers.google.com/identity/protocols/OpenIDConnect).

func (*PushConfig_OidcToken) Descriptor deprecated added in v1.68.0

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

Deprecated: Use PushConfig_OidcToken.ProtoReflect.Descriptor instead.

func (*PushConfig_OidcToken) GetAudience added in v1.68.0

func (x *PushConfig_OidcToken) GetAudience() string

func (*PushConfig_OidcToken) GetServiceAccountEmail added in v1.68.0

func (x *PushConfig_OidcToken) GetServiceAccountEmail() string

func (*PushConfig_OidcToken) ProtoMessage added in v1.68.0

func (*PushConfig_OidcToken) ProtoMessage()

func (*PushConfig_OidcToken) ProtoReflect added in v1.68.0

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

func (*PushConfig_OidcToken) Reset added in v1.68.0

func (x *PushConfig_OidcToken) Reset()

func (*PushConfig_OidcToken) String added in v1.68.0

func (x *PushConfig_OidcToken) String() string

type PushConfig_OidcToken_ added in v1.68.0

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"`
}

type PushConfig_PubsubWrapper added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use PushConfig_PubsubWrapper.ProtoReflect.Descriptor instead.

func (*PushConfig_PubsubWrapper) ProtoMessage added in v1.68.0

func (*PushConfig_PubsubWrapper) ProtoMessage()

func (*PushConfig_PubsubWrapper) ProtoReflect added in v1.68.0

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

func (*PushConfig_PubsubWrapper) Reset added in v1.68.0

func (x *PushConfig_PubsubWrapper) Reset()

func (*PushConfig_PubsubWrapper) String added in v1.68.0

func (x *PushConfig_PubsubWrapper) String() string

type PushConfig_PubsubWrapper_ added in v1.68.0

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"`
}

type QueryTemplate added in v1.71.0

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 `` /* 127-byte string literal not displayed */
	// 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 deprecated added in v1.71.0

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

Deprecated: Use QueryTemplate.ProtoReflect.Descriptor instead.

func (*QueryTemplate) GetCreateTime added in v1.71.0

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

func (*QueryTemplate) GetDescription added in v1.71.0

func (x *QueryTemplate) GetDescription() string

func (*QueryTemplate) GetDisplayName added in v1.71.0

func (x *QueryTemplate) GetDisplayName() string

func (*QueryTemplate) GetDocumentation added in v1.71.0

func (x *QueryTemplate) GetDocumentation() string

func (*QueryTemplate) GetName added in v1.71.0

func (x *QueryTemplate) GetName() string

func (*QueryTemplate) GetPrimaryContact added in v1.71.0

func (x *QueryTemplate) GetPrimaryContact() string

func (*QueryTemplate) GetProposer added in v1.71.0

func (x *QueryTemplate) GetProposer() string

func (*QueryTemplate) GetRoutine added in v1.71.0

func (x *QueryTemplate) GetRoutine() *Routine

func (*QueryTemplate) GetState added in v1.71.0

func (x *QueryTemplate) GetState() QueryTemplate_State

func (*QueryTemplate) GetUpdateTime added in v1.71.0

func (x *QueryTemplate) GetUpdateTime() *timestamppb.Timestamp

func (*QueryTemplate) ProtoMessage added in v1.71.0

func (*QueryTemplate) ProtoMessage()

func (*QueryTemplate) ProtoReflect added in v1.71.0

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

func (*QueryTemplate) Reset added in v1.71.0

func (x *QueryTemplate) Reset()

func (*QueryTemplate) String added in v1.71.0

func (x *QueryTemplate) String() string

type QueryTemplate_State added in v1.71.0

type QueryTemplate_State int32

The QueryTemplate lifecycle state.

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 added in v1.71.0

func (QueryTemplate_State) Enum added in v1.71.0

func (QueryTemplate_State) EnumDescriptor deprecated added in v1.71.0

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

Deprecated: Use QueryTemplate_State.Descriptor instead.

func (QueryTemplate_State) Number added in v1.71.0

func (QueryTemplate_State) String added in v1.71.0

func (x QueryTemplate_State) String() string

func (QueryTemplate_State) Type added in v1.71.0

type RefreshSubscriptionRequest added in v1.56.0

type RefreshSubscriptionRequest struct {

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

Message for refreshing a subscription.

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

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

Deprecated: Use RefreshSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*RefreshSubscriptionRequest) GetName added in v1.56.0

func (x *RefreshSubscriptionRequest) GetName() string

func (*RefreshSubscriptionRequest) ProtoMessage added in v1.56.0

func (*RefreshSubscriptionRequest) ProtoMessage()

func (*RefreshSubscriptionRequest) ProtoReflect added in v1.56.0

func (*RefreshSubscriptionRequest) Reset added in v1.56.0

func (x *RefreshSubscriptionRequest) Reset()

func (*RefreshSubscriptionRequest) String added in v1.56.0

func (x *RefreshSubscriptionRequest) String() string

type RefreshSubscriptionResponse added in v1.56.0

type RefreshSubscriptionResponse struct {

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

Message for response when you refresh a subscription.

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

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

Deprecated: Use RefreshSubscriptionResponse.ProtoReflect.Descriptor instead.

func (*RefreshSubscriptionResponse) GetSubscription added in v1.56.0

func (x *RefreshSubscriptionResponse) GetSubscription() *Subscription

func (*RefreshSubscriptionResponse) ProtoMessage added in v1.56.0

func (*RefreshSubscriptionResponse) ProtoMessage()

func (*RefreshSubscriptionResponse) ProtoReflect added in v1.56.0

func (*RefreshSubscriptionResponse) Reset added in v1.56.0

func (x *RefreshSubscriptionResponse) Reset()

func (*RefreshSubscriptionResponse) String added in v1.56.0

func (x *RefreshSubscriptionResponse) String() string

type RetryPolicy added in v1.68.0

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 deprecated added in v1.68.0

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

Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.

func (*RetryPolicy) GetMaximumBackoff added in v1.68.0

func (x *RetryPolicy) GetMaximumBackoff() *durationpb.Duration

func (*RetryPolicy) GetMinimumBackoff added in v1.68.0

func (x *RetryPolicy) GetMinimumBackoff() *durationpb.Duration

func (*RetryPolicy) ProtoMessage added in v1.68.0

func (*RetryPolicy) ProtoMessage()

func (*RetryPolicy) ProtoReflect added in v1.68.0

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

func (*RetryPolicy) Reset added in v1.68.0

func (x *RetryPolicy) Reset()

func (*RetryPolicy) String added in v1.68.0

func (x *RetryPolicy) String() string

type RevokeSubscriptionRequest added in v1.56.0

type RevokeSubscriptionRequest struct {

	// Required. Resource name of the subscription to revoke.
	// e.g. projects/123/locations/us/subscriptions/456
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// 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 deprecated added in v1.56.0

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

Deprecated: Use RevokeSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*RevokeSubscriptionRequest) GetName added in v1.56.0

func (x *RevokeSubscriptionRequest) GetName() string

func (*RevokeSubscriptionRequest) GetRevokeCommercial added in v1.69.0

func (x *RevokeSubscriptionRequest) GetRevokeCommercial() bool

func (*RevokeSubscriptionRequest) ProtoMessage added in v1.56.0

func (*RevokeSubscriptionRequest) ProtoMessage()

func (*RevokeSubscriptionRequest) ProtoReflect added in v1.56.0

func (*RevokeSubscriptionRequest) Reset added in v1.56.0

func (x *RevokeSubscriptionRequest) Reset()

func (*RevokeSubscriptionRequest) String added in v1.56.0

func (x *RevokeSubscriptionRequest) String() string

type RevokeSubscriptionResponse added in v1.56.0

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

Message for response when you revoke a subscription. Empty for now.

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

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

Deprecated: Use RevokeSubscriptionResponse.ProtoReflect.Descriptor instead.

func (*RevokeSubscriptionResponse) ProtoMessage added in v1.56.0

func (*RevokeSubscriptionResponse) ProtoMessage()

func (*RevokeSubscriptionResponse) ProtoReflect added in v1.56.0

func (*RevokeSubscriptionResponse) Reset added in v1.56.0

func (x *RevokeSubscriptionResponse) Reset()

func (*RevokeSubscriptionResponse) String added in v1.56.0

func (x *RevokeSubscriptionResponse) String() string

type Routine added in v1.71.0

type Routine struct {

	// Required. The type of routine.
	RoutineType Routine_RoutineType `` /* 158-byte string literal not displayed */
	// 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 added in v1.71.0

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

Deprecated: Use Routine.ProtoReflect.Descriptor instead.

func (*Routine) GetDefinitionBody added in v1.71.0

func (x *Routine) GetDefinitionBody() string

func (*Routine) GetRoutineType added in v1.71.0

func (x *Routine) GetRoutineType() Routine_RoutineType

func (*Routine) ProtoMessage added in v1.71.0

func (*Routine) ProtoMessage()

func (*Routine) ProtoReflect added in v1.71.0

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

func (*Routine) Reset added in v1.71.0

func (x *Routine) Reset()

func (*Routine) String added in v1.71.0

func (x *Routine) String() string

type Routine_RoutineType added in v1.71.0

type Routine_RoutineType int32

Represents the type of a given routine.

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 added in v1.71.0

func (Routine_RoutineType) Enum added in v1.71.0

func (Routine_RoutineType) EnumDescriptor deprecated added in v1.71.0

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

Deprecated: Use Routine_RoutineType.Descriptor instead.

func (Routine_RoutineType) Number added in v1.71.0

func (Routine_RoutineType) String added in v1.71.0

func (x Routine_RoutineType) String() string

func (Routine_RoutineType) Type added in v1.71.0

type SharedResourceType added in v1.68.0

type SharedResourceType int32

The underlying shared asset type shared in a listing by a publisher.

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 added in v1.68.0

func (SharedResourceType) Enum added in v1.68.0

func (SharedResourceType) EnumDescriptor deprecated added in v1.68.0

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

Deprecated: Use SharedResourceType.Descriptor instead.

func (SharedResourceType) Number added in v1.68.0

func (SharedResourceType) String added in v1.68.0

func (x SharedResourceType) String() string

func (SharedResourceType) Type added in v1.68.0

type SharingEnvironmentConfig added in v1.56.0

type SharingEnvironmentConfig struct {

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

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

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

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

Deprecated: Use SharingEnvironmentConfig.ProtoReflect.Descriptor instead.

func (*SharingEnvironmentConfig) GetDcrExchangeConfig added in v1.56.0

func (*SharingEnvironmentConfig) GetDefaultExchangeConfig added in v1.56.0

func (*SharingEnvironmentConfig) GetEnvironment added in v1.56.0

func (m *SharingEnvironmentConfig) GetEnvironment() isSharingEnvironmentConfig_Environment

func (*SharingEnvironmentConfig) ProtoMessage added in v1.56.0

func (*SharingEnvironmentConfig) ProtoMessage()

func (*SharingEnvironmentConfig) ProtoReflect added in v1.56.0

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

func (*SharingEnvironmentConfig) Reset added in v1.56.0

func (x *SharingEnvironmentConfig) Reset()

func (*SharingEnvironmentConfig) String added in v1.56.0

func (x *SharingEnvironmentConfig) String() string

type SharingEnvironmentConfig_DcrExchangeConfig added in v1.56.0

type SharingEnvironmentConfig_DcrExchangeConfig struct {

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

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

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

Deprecated: Use SharingEnvironmentConfig_DcrExchangeConfig.ProtoReflect.Descriptor instead.

func (*SharingEnvironmentConfig_DcrExchangeConfig) GetSingleLinkedDatasetPerCleanroom added in v1.60.0

func (x *SharingEnvironmentConfig_DcrExchangeConfig) GetSingleLinkedDatasetPerCleanroom() bool

func (*SharingEnvironmentConfig_DcrExchangeConfig) GetSingleSelectedResourceSharingRestriction added in v1.60.0

func (x *SharingEnvironmentConfig_DcrExchangeConfig) GetSingleSelectedResourceSharingRestriction() bool

func (*SharingEnvironmentConfig_DcrExchangeConfig) ProtoMessage added in v1.56.0

func (*SharingEnvironmentConfig_DcrExchangeConfig) ProtoReflect added in v1.56.0

func (*SharingEnvironmentConfig_DcrExchangeConfig) Reset added in v1.56.0

func (*SharingEnvironmentConfig_DcrExchangeConfig) String added in v1.56.0

type SharingEnvironmentConfig_DcrExchangeConfig_ added in v1.56.0

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

type SharingEnvironmentConfig_DefaultExchangeConfig added in v1.56.0

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

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

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

Deprecated: Use SharingEnvironmentConfig_DefaultExchangeConfig.ProtoReflect.Descriptor instead.

func (*SharingEnvironmentConfig_DefaultExchangeConfig) ProtoMessage added in v1.56.0

func (*SharingEnvironmentConfig_DefaultExchangeConfig) ProtoReflect added in v1.56.0

func (*SharingEnvironmentConfig_DefaultExchangeConfig) Reset added in v1.56.0

func (*SharingEnvironmentConfig_DefaultExchangeConfig) String added in v1.56.0

type SharingEnvironmentConfig_DefaultExchangeConfig_ added in v1.56.0

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

type SubmitQueryTemplateRequest added in v1.71.0

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 deprecated added in v1.71.0

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

Deprecated: Use SubmitQueryTemplateRequest.ProtoReflect.Descriptor instead.

func (*SubmitQueryTemplateRequest) GetName added in v1.71.0

func (x *SubmitQueryTemplateRequest) GetName() string

func (*SubmitQueryTemplateRequest) ProtoMessage added in v1.71.0

func (*SubmitQueryTemplateRequest) ProtoMessage()

func (*SubmitQueryTemplateRequest) ProtoReflect added in v1.71.0

func (*SubmitQueryTemplateRequest) Reset added in v1.71.0

func (x *SubmitQueryTemplateRequest) Reset()

func (*SubmitQueryTemplateRequest) String added in v1.71.0

func (x *SubmitQueryTemplateRequest) String() string

type SubscribeDataExchangeRequest added in v1.56.0

type SubscribeDataExchangeRequest struct {

	// Required. Resource name of the Data Exchange.
	// e.g. `projects/publisherproject/locations/us/dataExchanges/123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The parent resource path of the Subscription.
	// e.g. `projects/subscriberproject/locations/us`
	Destination string `protobuf:"bytes,2,opt,name=destination,proto3" json:"destination,omitempty"`
	// 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 deprecated added in v1.56.0

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

Deprecated: Use SubscribeDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*SubscribeDataExchangeRequest) GetDestination added in v1.56.0

func (x *SubscribeDataExchangeRequest) GetDestination() string

func (*SubscribeDataExchangeRequest) GetDestinationDataset added in v1.68.0

func (x *SubscribeDataExchangeRequest) GetDestinationDataset() *DestinationDataset

func (*SubscribeDataExchangeRequest) GetName added in v1.56.0

func (x *SubscribeDataExchangeRequest) GetName() string

func (*SubscribeDataExchangeRequest) GetSubscriberContact added in v1.56.0

func (x *SubscribeDataExchangeRequest) GetSubscriberContact() string

func (*SubscribeDataExchangeRequest) GetSubscription added in v1.56.0

func (x *SubscribeDataExchangeRequest) GetSubscription() string

func (*SubscribeDataExchangeRequest) ProtoMessage added in v1.56.0

func (*SubscribeDataExchangeRequest) ProtoMessage()

func (*SubscribeDataExchangeRequest) ProtoReflect added in v1.56.0

func (*SubscribeDataExchangeRequest) Reset added in v1.56.0

func (x *SubscribeDataExchangeRequest) Reset()

func (*SubscribeDataExchangeRequest) String added in v1.56.0

type SubscribeDataExchangeResponse added in v1.56.0

type SubscribeDataExchangeResponse struct {

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

Message for response when you subscribe to a Data Exchange.

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

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

Deprecated: Use SubscribeDataExchangeResponse.ProtoReflect.Descriptor instead.

func (*SubscribeDataExchangeResponse) GetSubscription added in v1.56.0

func (x *SubscribeDataExchangeResponse) GetSubscription() *Subscription

func (*SubscribeDataExchangeResponse) ProtoMessage added in v1.56.0

func (*SubscribeDataExchangeResponse) ProtoMessage()

func (*SubscribeDataExchangeResponse) ProtoReflect added in v1.56.0

func (*SubscribeDataExchangeResponse) Reset added in v1.56.0

func (x *SubscribeDataExchangeResponse) Reset()

func (*SubscribeDataExchangeResponse) String added in v1.56.0

type SubscribeListingRequest

type SubscribeListingRequest struct {

	// Resulting destination of the listing that you subscribed to.
	//
	// Types that are assignable to Destination:
	//
	//	*SubscribeListingRequest_DestinationDataset
	//	*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 deprecated

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

Deprecated: Use SubscribeListingRequest.ProtoReflect.Descriptor instead.

func (*SubscribeListingRequest) GetDestination

func (m *SubscribeListingRequest) GetDestination() isSubscribeListingRequest_Destination

func (*SubscribeListingRequest) GetDestinationDataset

func (x *SubscribeListingRequest) GetDestinationDataset() *DestinationDataset

func (*SubscribeListingRequest) GetDestinationPubsubSubscription added in v1.68.0

func (x *SubscribeListingRequest) GetDestinationPubsubSubscription() *DestinationPubSubSubscription

func (*SubscribeListingRequest) GetName

func (x *SubscribeListingRequest) GetName() string

func (*SubscribeListingRequest) ProtoMessage

func (*SubscribeListingRequest) ProtoMessage()

func (*SubscribeListingRequest) ProtoReflect

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

func (*SubscribeListingRequest) Reset

func (x *SubscribeListingRequest) Reset()

func (*SubscribeListingRequest) String

func (x *SubscribeListingRequest) String() string

type SubscribeListingRequest_DestinationDataset

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

type SubscribeListingRequest_DestinationPubsubSubscription added in v1.68.0

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"`
}

type SubscribeListingResponse

type SubscribeListingResponse struct {

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

Message for response when you subscribe to a listing.

func (*SubscribeListingResponse) Descriptor deprecated

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

Deprecated: Use SubscribeListingResponse.ProtoReflect.Descriptor instead.

func (*SubscribeListingResponse) GetSubscription added in v1.56.0

func (x *SubscribeListingResponse) GetSubscription() *Subscription

func (*SubscribeListingResponse) ProtoMessage

func (*SubscribeListingResponse) ProtoMessage()

func (*SubscribeListingResponse) ProtoReflect

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

func (*SubscribeListingResponse) Reset

func (x *SubscribeListingResponse) Reset()

func (*SubscribeListingResponse) String

func (x *SubscribeListingResponse) String() string

type Subscription added in v1.56.0

type Subscription struct {

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

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

Deprecated: Use Subscription.ProtoReflect.Descriptor instead.

func (*Subscription) GetCommercialInfo added in v1.69.0

func (x *Subscription) GetCommercialInfo() *Subscription_CommercialInfo

func (*Subscription) GetCreationTime added in v1.56.0

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

func (*Subscription) GetDataExchange added in v1.56.0

func (x *Subscription) GetDataExchange() string

func (*Subscription) GetDestinationDataset added in v1.69.0

func (x *Subscription) GetDestinationDataset() *DestinationDataset

func (*Subscription) GetLastModifyTime added in v1.56.0

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

func (*Subscription) GetLinkedDatasetMap added in v1.56.0

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

func (*Subscription) GetLinkedResources added in v1.68.0

func (x *Subscription) GetLinkedResources() []*Subscription_LinkedResource

func (*Subscription) GetListing added in v1.56.0

func (x *Subscription) GetListing() string

func (*Subscription) GetLogLinkedDatasetQueryUserEmail added in v1.68.0

func (x *Subscription) GetLogLinkedDatasetQueryUserEmail() bool

func (*Subscription) GetName added in v1.56.0

func (x *Subscription) GetName() string

func (*Subscription) GetOrganizationDisplayName added in v1.56.0

func (x *Subscription) GetOrganizationDisplayName() string

func (*Subscription) GetOrganizationId added in v1.56.0

func (x *Subscription) GetOrganizationId() string

func (*Subscription) GetResourceName added in v1.56.0

func (m *Subscription) GetResourceName() isSubscription_ResourceName

func (*Subscription) GetResourceType added in v1.68.0

func (x *Subscription) GetResourceType() SharedResourceType

func (*Subscription) GetState added in v1.56.0

func (x *Subscription) GetState() Subscription_State

func (*Subscription) GetSubscriberContact added in v1.56.0

func (x *Subscription) GetSubscriberContact() string

func (*Subscription) ProtoMessage added in v1.56.0

func (*Subscription) ProtoMessage()

func (*Subscription) ProtoReflect added in v1.56.0

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

func (*Subscription) Reset added in v1.56.0

func (x *Subscription) Reset()

func (*Subscription) String added in v1.56.0

func (x *Subscription) String() string

type Subscription_CommercialInfo added in v1.69.0

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 deprecated added in v1.69.0

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

Deprecated: Use Subscription_CommercialInfo.ProtoReflect.Descriptor instead.

func (*Subscription_CommercialInfo) GetCloudMarketplace added in v1.69.0

func (*Subscription_CommercialInfo) ProtoMessage added in v1.69.0

func (*Subscription_CommercialInfo) ProtoMessage()

func (*Subscription_CommercialInfo) ProtoReflect added in v1.69.0

func (*Subscription_CommercialInfo) Reset added in v1.69.0

func (x *Subscription_CommercialInfo) Reset()

func (*Subscription_CommercialInfo) String added in v1.69.0

func (x *Subscription_CommercialInfo) String() string

type Subscription_CommercialInfo_GoogleCloudMarketplaceInfo added in v1.69.0

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 deprecated added in v1.69.0

Deprecated: Use Subscription_CommercialInfo_GoogleCloudMarketplaceInfo.ProtoReflect.Descriptor instead.

func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) GetOrder added in v1.69.0

func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoMessage added in v1.69.0

func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) ProtoReflect added in v1.69.0

func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) Reset added in v1.69.0

func (*Subscription_CommercialInfo_GoogleCloudMarketplaceInfo) String added in v1.69.0

type Subscription_DataExchange added in v1.56.0

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

type Subscription_LinkedResource added in v1.56.0

type Subscription_LinkedResource struct {

	// Types that are assignable to Reference:
	//
	//	*Subscription_LinkedResource_LinkedDataset
	//	*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 deprecated added in v1.56.0

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

Deprecated: Use Subscription_LinkedResource.ProtoReflect.Descriptor instead.

func (*Subscription_LinkedResource) GetLinkedDataset added in v1.56.0

func (x *Subscription_LinkedResource) GetLinkedDataset() string

func (*Subscription_LinkedResource) GetLinkedPubsubSubscription added in v1.68.0

func (x *Subscription_LinkedResource) GetLinkedPubsubSubscription() string

func (*Subscription_LinkedResource) GetListing added in v1.68.0

func (x *Subscription_LinkedResource) GetListing() string

func (*Subscription_LinkedResource) GetReference added in v1.56.0

func (m *Subscription_LinkedResource) GetReference() isSubscription_LinkedResource_Reference

func (*Subscription_LinkedResource) ProtoMessage added in v1.56.0

func (*Subscription_LinkedResource) ProtoMessage()

func (*Subscription_LinkedResource) ProtoReflect added in v1.56.0

func (*Subscription_LinkedResource) Reset added in v1.56.0

func (x *Subscription_LinkedResource) Reset()

func (*Subscription_LinkedResource) String added in v1.56.0

func (x *Subscription_LinkedResource) String() string

type Subscription_LinkedResource_LinkedDataset added in v1.56.0

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

type Subscription_LinkedResource_LinkedPubsubSubscription added in v1.68.0

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"`
}

type Subscription_Listing added in v1.56.0

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

type Subscription_State added in v1.56.0

type Subscription_State int32

State of the subscription.

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

func (Subscription_State) Descriptor added in v1.56.0

func (Subscription_State) Enum added in v1.56.0

func (Subscription_State) EnumDescriptor deprecated added in v1.56.0

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

Deprecated: Use Subscription_State.Descriptor instead.

func (Subscription_State) Number added in v1.56.0

func (Subscription_State) String added in v1.56.0

func (x Subscription_State) String() string

func (Subscription_State) Type added in v1.56.0

type UnimplementedAnalyticsHubServiceServer

type UnimplementedAnalyticsHubServiceServer struct {
}

UnimplementedAnalyticsHubServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedAnalyticsHubServiceServer) ApproveQueryTemplate added in v1.71.0

func (*UnimplementedAnalyticsHubServiceServer) CreateDataExchange

func (*UnimplementedAnalyticsHubServiceServer) CreateListing

func (*UnimplementedAnalyticsHubServiceServer) CreateQueryTemplate added in v1.71.0

func (*UnimplementedAnalyticsHubServiceServer) DeleteDataExchange

func (*UnimplementedAnalyticsHubServiceServer) DeleteListing

func (*UnimplementedAnalyticsHubServiceServer) DeleteQueryTemplate added in v1.71.0

func (*UnimplementedAnalyticsHubServiceServer) DeleteSubscription added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) GetDataExchange

func (*UnimplementedAnalyticsHubServiceServer) GetIamPolicy

func (*UnimplementedAnalyticsHubServiceServer) GetListing

func (*UnimplementedAnalyticsHubServiceServer) GetQueryTemplate added in v1.71.0

func (*UnimplementedAnalyticsHubServiceServer) GetSubscription added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) ListDataExchanges

func (*UnimplementedAnalyticsHubServiceServer) ListListings

func (*UnimplementedAnalyticsHubServiceServer) ListOrgDataExchanges

func (*UnimplementedAnalyticsHubServiceServer) ListQueryTemplates added in v1.71.0

func (*UnimplementedAnalyticsHubServiceServer) ListSharedResourceSubscriptions added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) ListSubscriptions added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) RefreshSubscription added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) RevokeSubscription added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) SetIamPolicy

func (*UnimplementedAnalyticsHubServiceServer) SubmitQueryTemplate added in v1.71.0

func (*UnimplementedAnalyticsHubServiceServer) SubscribeDataExchange added in v1.56.0

func (*UnimplementedAnalyticsHubServiceServer) SubscribeListing

func (*UnimplementedAnalyticsHubServiceServer) TestIamPermissions

func (*UnimplementedAnalyticsHubServiceServer) UpdateDataExchange

func (*UnimplementedAnalyticsHubServiceServer) UpdateListing

func (*UnimplementedAnalyticsHubServiceServer) UpdateQueryTemplate added in v1.71.0

type UpdateDataExchangeRequest

type UpdateDataExchangeRequest struct {

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

Message for updating a data exchange.

func (*UpdateDataExchangeRequest) Descriptor deprecated

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

Deprecated: Use UpdateDataExchangeRequest.ProtoReflect.Descriptor instead.

func (*UpdateDataExchangeRequest) GetDataExchange

func (x *UpdateDataExchangeRequest) GetDataExchange() *DataExchange

func (*UpdateDataExchangeRequest) GetUpdateMask

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

func (*UpdateDataExchangeRequest) ProtoMessage

func (*UpdateDataExchangeRequest) ProtoMessage()

func (*UpdateDataExchangeRequest) ProtoReflect

func (*UpdateDataExchangeRequest) Reset

func (x *UpdateDataExchangeRequest) Reset()

func (*UpdateDataExchangeRequest) String

func (x *UpdateDataExchangeRequest) String() string

type UpdateListingRequest

type UpdateListingRequest struct {

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

Message for updating a Listing.

func (*UpdateListingRequest) Descriptor deprecated

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

Deprecated: Use UpdateListingRequest.ProtoReflect.Descriptor instead.

func (*UpdateListingRequest) GetListing

func (x *UpdateListingRequest) GetListing() *Listing

func (*UpdateListingRequest) GetUpdateMask

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

func (*UpdateListingRequest) ProtoMessage

func (*UpdateListingRequest) ProtoMessage()

func (*UpdateListingRequest) ProtoReflect

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

func (*UpdateListingRequest) Reset

func (x *UpdateListingRequest) Reset()

func (*UpdateListingRequest) String

func (x *UpdateListingRequest) String() string

type UpdateQueryTemplateRequest added in v1.71.0

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 deprecated added in v1.71.0

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

Deprecated: Use UpdateQueryTemplateRequest.ProtoReflect.Descriptor instead.

func (*UpdateQueryTemplateRequest) GetQueryTemplate added in v1.71.0

func (x *UpdateQueryTemplateRequest) GetQueryTemplate() *QueryTemplate

func (*UpdateQueryTemplateRequest) GetUpdateMask added in v1.71.0

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

func (*UpdateQueryTemplateRequest) ProtoMessage added in v1.71.0

func (*UpdateQueryTemplateRequest) ProtoMessage()

func (*UpdateQueryTemplateRequest) ProtoReflect added in v1.71.0

func (*UpdateQueryTemplateRequest) Reset added in v1.71.0

func (x *UpdateQueryTemplateRequest) Reset()

func (*UpdateQueryTemplateRequest) String added in v1.71.0

func (x *UpdateQueryTemplateRequest) String() string

Jump to

Keyboard shortcuts

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