Constants
Publisher_CreateTopic_FullMethodName, Publisher_UpdateTopic_FullMethodName, Publisher_Publish_FullMethodName, Publisher_GetTopic_FullMethodName, Publisher_ListTopics_FullMethodName, Publisher_ListTopicSubscriptions_FullMethodName, Publisher_ListTopicSnapshots_FullMethodName, Publisher_DeleteTopic_FullMethodName, Publisher_DetachSubscription_FullMethodName
const (
Publisher_CreateTopic_FullMethodName = "/google.pubsub.v1.Publisher/CreateTopic"
Publisher_UpdateTopic_FullMethodName = "/google.pubsub.v1.Publisher/UpdateTopic"
Publisher_Publish_FullMethodName = "/google.pubsub.v1.Publisher/Publish"
Publisher_GetTopic_FullMethodName = "/google.pubsub.v1.Publisher/GetTopic"
Publisher_ListTopics_FullMethodName = "/google.pubsub.v1.Publisher/ListTopics"
Publisher_ListTopicSubscriptions_FullMethodName = "/google.pubsub.v1.Publisher/ListTopicSubscriptions"
Publisher_ListTopicSnapshots_FullMethodName = "/google.pubsub.v1.Publisher/ListTopicSnapshots"
Publisher_DeleteTopic_FullMethodName = "/google.pubsub.v1.Publisher/DeleteTopic"
Publisher_DetachSubscription_FullMethodName = "/google.pubsub.v1.Publisher/DetachSubscription"
)Subscriber_CreateSubscription_FullMethodName, Subscriber_GetSubscription_FullMethodName, Subscriber_UpdateSubscription_FullMethodName, Subscriber_ListSubscriptions_FullMethodName, Subscriber_DeleteSubscription_FullMethodName, Subscriber_ModifyAckDeadline_FullMethodName, Subscriber_Acknowledge_FullMethodName, Subscriber_Pull_FullMethodName, Subscriber_StreamingPull_FullMethodName, Subscriber_ModifyPushConfig_FullMethodName, Subscriber_GetSnapshot_FullMethodName, Subscriber_ListSnapshots_FullMethodName, Subscriber_CreateSnapshot_FullMethodName, Subscriber_UpdateSnapshot_FullMethodName, Subscriber_DeleteSnapshot_FullMethodName, Subscriber_Seek_FullMethodName
const (
Subscriber_CreateSubscription_FullMethodName = "/google.pubsub.v1.Subscriber/CreateSubscription"
Subscriber_GetSubscription_FullMethodName = "/google.pubsub.v1.Subscriber/GetSubscription"
Subscriber_UpdateSubscription_FullMethodName = "/google.pubsub.v1.Subscriber/UpdateSubscription"
Subscriber_ListSubscriptions_FullMethodName = "/google.pubsub.v1.Subscriber/ListSubscriptions"
Subscriber_DeleteSubscription_FullMethodName = "/google.pubsub.v1.Subscriber/DeleteSubscription"
Subscriber_ModifyAckDeadline_FullMethodName = "/google.pubsub.v1.Subscriber/ModifyAckDeadline"
Subscriber_Acknowledge_FullMethodName = "/google.pubsub.v1.Subscriber/Acknowledge"
Subscriber_Pull_FullMethodName = "/google.pubsub.v1.Subscriber/Pull"
Subscriber_StreamingPull_FullMethodName = "/google.pubsub.v1.Subscriber/StreamingPull"
Subscriber_ModifyPushConfig_FullMethodName = "/google.pubsub.v1.Subscriber/ModifyPushConfig"
Subscriber_GetSnapshot_FullMethodName = "/google.pubsub.v1.Subscriber/GetSnapshot"
Subscriber_ListSnapshots_FullMethodName = "/google.pubsub.v1.Subscriber/ListSnapshots"
Subscriber_CreateSnapshot_FullMethodName = "/google.pubsub.v1.Subscriber/CreateSnapshot"
Subscriber_UpdateSnapshot_FullMethodName = "/google.pubsub.v1.Subscriber/UpdateSnapshot"
Subscriber_DeleteSnapshot_FullMethodName = "/google.pubsub.v1.Subscriber/DeleteSnapshot"
Subscriber_Seek_FullMethodName = "/google.pubsub.v1.Subscriber/Seek"
)SchemaService_CreateSchema_FullMethodName, SchemaService_GetSchema_FullMethodName, SchemaService_ListSchemas_FullMethodName, SchemaService_ListSchemaRevisions_FullMethodName, SchemaService_CommitSchema_FullMethodName, SchemaService_RollbackSchema_FullMethodName, SchemaService_DeleteSchemaRevision_FullMethodName, SchemaService_DeleteSchema_FullMethodName, SchemaService_ValidateSchema_FullMethodName, SchemaService_ValidateMessage_FullMethodName
const (
SchemaService_CreateSchema_FullMethodName = "/google.pubsub.v1.SchemaService/CreateSchema"
SchemaService_GetSchema_FullMethodName = "/google.pubsub.v1.SchemaService/GetSchema"
SchemaService_ListSchemas_FullMethodName = "/google.pubsub.v1.SchemaService/ListSchemas"
SchemaService_ListSchemaRevisions_FullMethodName = "/google.pubsub.v1.SchemaService/ListSchemaRevisions"
SchemaService_CommitSchema_FullMethodName = "/google.pubsub.v1.SchemaService/CommitSchema"
SchemaService_RollbackSchema_FullMethodName = "/google.pubsub.v1.SchemaService/RollbackSchema"
SchemaService_DeleteSchemaRevision_FullMethodName = "/google.pubsub.v1.SchemaService/DeleteSchemaRevision"
SchemaService_DeleteSchema_FullMethodName = "/google.pubsub.v1.SchemaService/DeleteSchema"
SchemaService_ValidateSchema_FullMethodName = "/google.pubsub.v1.SchemaService/ValidateSchema"
SchemaService_ValidateMessage_FullMethodName = "/google.pubsub.v1.SchemaService/ValidateMessage"
)Variables
IngestionDataSourceSettings_AwsKinesis_State_name, IngestionDataSourceSettings_AwsKinesis_State_value
var (
IngestionDataSourceSettings_AwsKinesis_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "KINESIS_PERMISSION_DENIED",
3: "PUBLISH_PERMISSION_DENIED",
4: "STREAM_NOT_FOUND",
5: "CONSUMER_NOT_FOUND",
6: "CONFLICTING_REGION_CONSTRAINTS",
}
IngestionDataSourceSettings_AwsKinesis_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"KINESIS_PERMISSION_DENIED": 2,
"PUBLISH_PERMISSION_DENIED": 3,
"STREAM_NOT_FOUND": 4,
"CONSUMER_NOT_FOUND": 5,
"CONFLICTING_REGION_CONSTRAINTS": 6,
}
)Enum value maps for IngestionDataSourceSettings_AwsKinesis_State.
IngestionDataSourceSettings_CloudStorage_State_name, IngestionDataSourceSettings_CloudStorage_State_value
var (
IngestionDataSourceSettings_CloudStorage_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "CLOUD_STORAGE_PERMISSION_DENIED",
3: "PUBLISH_PERMISSION_DENIED",
4: "BUCKET_NOT_FOUND",
5: "TOO_MANY_OBJECTS",
8: "CONFLICTING_REGION_CONSTRAINTS",
}
IngestionDataSourceSettings_CloudStorage_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"CLOUD_STORAGE_PERMISSION_DENIED": 2,
"PUBLISH_PERMISSION_DENIED": 3,
"BUCKET_NOT_FOUND": 4,
"TOO_MANY_OBJECTS": 5,
"CONFLICTING_REGION_CONSTRAINTS": 8,
}
)Enum value maps for IngestionDataSourceSettings_CloudStorage_State.
IngestionDataSourceSettings_AzureEventHubs_State_name, IngestionDataSourceSettings_AzureEventHubs_State_value
var (
IngestionDataSourceSettings_AzureEventHubs_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "EVENT_HUBS_PERMISSION_DENIED",
3: "PUBLISH_PERMISSION_DENIED",
4: "NAMESPACE_NOT_FOUND",
5: "EVENT_HUB_NOT_FOUND",
6: "SUBSCRIPTION_NOT_FOUND",
7: "RESOURCE_GROUP_NOT_FOUND",
8: "CONFLICTING_REGION_CONSTRAINTS",
}
IngestionDataSourceSettings_AzureEventHubs_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"EVENT_HUBS_PERMISSION_DENIED": 2,
"PUBLISH_PERMISSION_DENIED": 3,
"NAMESPACE_NOT_FOUND": 4,
"EVENT_HUB_NOT_FOUND": 5,
"SUBSCRIPTION_NOT_FOUND": 6,
"RESOURCE_GROUP_NOT_FOUND": 7,
"CONFLICTING_REGION_CONSTRAINTS": 8,
}
)Enum value maps for IngestionDataSourceSettings_AzureEventHubs_State.
IngestionDataSourceSettings_AwsMsk_State_name, IngestionDataSourceSettings_AwsMsk_State_value
var (
IngestionDataSourceSettings_AwsMsk_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "MSK_PERMISSION_DENIED",
3: "PUBLISH_PERMISSION_DENIED",
4: "CLUSTER_NOT_FOUND",
5: "TOPIC_NOT_FOUND",
6: "CONFLICTING_REGION_CONSTRAINTS",
}
IngestionDataSourceSettings_AwsMsk_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"MSK_PERMISSION_DENIED": 2,
"PUBLISH_PERMISSION_DENIED": 3,
"CLUSTER_NOT_FOUND": 4,
"TOPIC_NOT_FOUND": 5,
"CONFLICTING_REGION_CONSTRAINTS": 6,
}
)Enum value maps for IngestionDataSourceSettings_AwsMsk_State.
IngestionDataSourceSettings_ConfluentCloud_State_name, IngestionDataSourceSettings_ConfluentCloud_State_value
var (
IngestionDataSourceSettings_ConfluentCloud_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "CONFLUENT_CLOUD_PERMISSION_DENIED",
3: "PUBLISH_PERMISSION_DENIED",
4: "UNREACHABLE_BOOTSTRAP_SERVER",
5: "CLUSTER_NOT_FOUND",
6: "TOPIC_NOT_FOUND",
7: "CONFLICTING_REGION_CONSTRAINTS",
}
IngestionDataSourceSettings_ConfluentCloud_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"CONFLUENT_CLOUD_PERMISSION_DENIED": 2,
"PUBLISH_PERMISSION_DENIED": 3,
"UNREACHABLE_BOOTSTRAP_SERVER": 4,
"CLUSTER_NOT_FOUND": 5,
"TOPIC_NOT_FOUND": 6,
"CONFLICTING_REGION_CONSTRAINTS": 7,
}
)Enum value maps for IngestionDataSourceSettings_ConfluentCloud_State.
PlatformLogsSettings_Severity_name, PlatformLogsSettings_Severity_value
var (
PlatformLogsSettings_Severity_name = map[int32]string{
0: "SEVERITY_UNSPECIFIED",
1: "DISABLED",
2: "DEBUG",
3: "INFO",
4: "WARNING",
5: "ERROR",
}
PlatformLogsSettings_Severity_value = map[string]int32{
"SEVERITY_UNSPECIFIED": 0,
"DISABLED": 1,
"DEBUG": 2,
"INFO": 3,
"WARNING": 4,
"ERROR": 5,
}
)Enum value maps for PlatformLogsSettings_Severity.
Compression_CompressionAlgorithm_name, Compression_CompressionAlgorithm_value
var (
Compression_CompressionAlgorithm_name = map[int32]string{
0: "COMPRESSION_ALGORITHM_UNSPECIFIED",
1: "ZLIB",
}
Compression_CompressionAlgorithm_value = map[string]int32{
"COMPRESSION_ALGORITHM_UNSPECIFIED": 0,
"ZLIB": 1,
}
)Enum value maps for Compression_CompressionAlgorithm.
Compression_CompressionMode_name, Compression_CompressionMode_value
var (
Compression_CompressionMode_name = map[int32]string{
0: "COMPRESSION_MODE_UNSPECIFIED",
1: "COMPRESS",
2: "DECOMPRESS",
}
Compression_CompressionMode_value = map[string]int32{
"COMPRESSION_MODE_UNSPECIFIED": 0,
"COMPRESS": 1,
"DECOMPRESS": 2,
}
)Enum value maps for Compression_CompressionMode.
Topic_State_name, Topic_State_value
var (
Topic_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "INGESTION_RESOURCE_ERROR",
}
Topic_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"INGESTION_RESOURCE_ERROR": 2,
}
)Enum value maps for Topic_State.
Subscription_State_name, Subscription_State_value
var (
Subscription_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "RESOURCE_ERROR",
}
Subscription_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"RESOURCE_ERROR": 2,
}
)Enum value maps for Subscription_State.
BigQueryConfig_State_name, BigQueryConfig_State_value
var (
BigQueryConfig_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "PERMISSION_DENIED",
3: "NOT_FOUND",
4: "SCHEMA_MISMATCH",
5: "IN_TRANSIT_LOCATION_RESTRICTION",
6: "VERTEX_AI_LOCATION_RESTRICTION",
}
BigQueryConfig_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"PERMISSION_DENIED": 2,
"NOT_FOUND": 3,
"SCHEMA_MISMATCH": 4,
"IN_TRANSIT_LOCATION_RESTRICTION": 5,
"VERTEX_AI_LOCATION_RESTRICTION": 6,
}
)Enum value maps for BigQueryConfig_State.
BigtableConfig_State_name, BigtableConfig_State_value
var (
BigtableConfig_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "NOT_FOUND",
3: "APP_PROFILE_MISCONFIGURED",
4: "PERMISSION_DENIED",
5: "SCHEMA_MISMATCH",
6: "IN_TRANSIT_LOCATION_RESTRICTION",
7: "VERTEX_AI_LOCATION_RESTRICTION",
}
BigtableConfig_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"NOT_FOUND": 2,
"APP_PROFILE_MISCONFIGURED": 3,
"PERMISSION_DENIED": 4,
"SCHEMA_MISMATCH": 5,
"IN_TRANSIT_LOCATION_RESTRICTION": 6,
"VERTEX_AI_LOCATION_RESTRICTION": 7,
}
)Enum value maps for BigtableConfig_State.
CloudStorageConfig_State_name, CloudStorageConfig_State_value
var (
CloudStorageConfig_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "PERMISSION_DENIED",
3: "NOT_FOUND",
4: "IN_TRANSIT_LOCATION_RESTRICTION",
5: "SCHEMA_MISMATCH",
6: "VERTEX_AI_LOCATION_RESTRICTION",
}
CloudStorageConfig_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"PERMISSION_DENIED": 2,
"NOT_FOUND": 3,
"IN_TRANSIT_LOCATION_RESTRICTION": 4,
"SCHEMA_MISMATCH": 5,
"VERTEX_AI_LOCATION_RESTRICTION": 6,
}
)Enum value maps for CloudStorageConfig_State.
SchemaView_name, SchemaView_value
var (
SchemaView_name = map[int32]string{
0: "SCHEMA_VIEW_UNSPECIFIED",
1: "BASIC",
2: "FULL",
}
SchemaView_value = map[string]int32{
"SCHEMA_VIEW_UNSPECIFIED": 0,
"BASIC": 1,
"FULL": 2,
}
)Enum value maps for SchemaView.
Encoding_name, Encoding_value
var (
Encoding_name = map[int32]string{
0: "ENCODING_UNSPECIFIED",
1: "JSON",
2: "BINARY",
}
Encoding_value = map[string]int32{
"ENCODING_UNSPECIFIED": 0,
"JSON": 1,
"BINARY": 2,
}
)Enum value maps for Encoding.
Schema_Type_name, Schema_Type_value
var (
Schema_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "PROTOCOL_BUFFER",
2: "AVRO",
}
Schema_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"PROTOCOL_BUFFER": 1,
"AVRO": 2,
}
)Enum value maps for Schema_Type.
File_google_pubsub_v1_pubsub_proto
var File_google_pubsub_v1_pubsub_proto protoreflect.FileDescriptorFile_google_pubsub_v1_schema_proto
var File_google_pubsub_v1_schema_proto protoreflect.FileDescriptorPublisher_ServiceDesc
var Publisher_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.pubsub.v1.Publisher",
HandlerType: (*PublisherServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateTopic",
Handler: _Publisher_CreateTopic_Handler,
},
{
MethodName: "UpdateTopic",
Handler: _Publisher_UpdateTopic_Handler,
},
{
MethodName: "Publish",
Handler: _Publisher_Publish_Handler,
},
{
MethodName: "GetTopic",
Handler: _Publisher_GetTopic_Handler,
},
{
MethodName: "ListTopics",
Handler: _Publisher_ListTopics_Handler,
},
{
MethodName: "ListTopicSubscriptions",
Handler: _Publisher_ListTopicSubscriptions_Handler,
},
{
MethodName: "ListTopicSnapshots",
Handler: _Publisher_ListTopicSnapshots_Handler,
},
{
MethodName: "DeleteTopic",
Handler: _Publisher_DeleteTopic_Handler,
},
{
MethodName: "DetachSubscription",
Handler: _Publisher_DetachSubscription_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/pubsub/v1/pubsub.proto",
}Publisher_ServiceDesc is the grpc.ServiceDesc for Publisher service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
SchemaService_ServiceDesc
var SchemaService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.pubsub.v1.SchemaService",
HandlerType: (*SchemaServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateSchema",
Handler: _SchemaService_CreateSchema_Handler,
},
{
MethodName: "GetSchema",
Handler: _SchemaService_GetSchema_Handler,
},
{
MethodName: "ListSchemas",
Handler: _SchemaService_ListSchemas_Handler,
},
{
MethodName: "ListSchemaRevisions",
Handler: _SchemaService_ListSchemaRevisions_Handler,
},
{
MethodName: "CommitSchema",
Handler: _SchemaService_CommitSchema_Handler,
},
{
MethodName: "RollbackSchema",
Handler: _SchemaService_RollbackSchema_Handler,
},
{
MethodName: "DeleteSchemaRevision",
Handler: _SchemaService_DeleteSchemaRevision_Handler,
},
{
MethodName: "DeleteSchema",
Handler: _SchemaService_DeleteSchema_Handler,
},
{
MethodName: "ValidateSchema",
Handler: _SchemaService_ValidateSchema_Handler,
},
{
MethodName: "ValidateMessage",
Handler: _SchemaService_ValidateMessage_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/pubsub/v1/schema.proto",
}SchemaService_ServiceDesc is the grpc.ServiceDesc for SchemaService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Subscriber_ServiceDesc
var Subscriber_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.pubsub.v1.Subscriber",
HandlerType: (*SubscriberServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateSubscription",
Handler: _Subscriber_CreateSubscription_Handler,
},
{
MethodName: "GetSubscription",
Handler: _Subscriber_GetSubscription_Handler,
},
{
MethodName: "UpdateSubscription",
Handler: _Subscriber_UpdateSubscription_Handler,
},
{
MethodName: "ListSubscriptions",
Handler: _Subscriber_ListSubscriptions_Handler,
},
{
MethodName: "DeleteSubscription",
Handler: _Subscriber_DeleteSubscription_Handler,
},
{
MethodName: "ModifyAckDeadline",
Handler: _Subscriber_ModifyAckDeadline_Handler,
},
{
MethodName: "Acknowledge",
Handler: _Subscriber_Acknowledge_Handler,
},
{
MethodName: "Pull",
Handler: _Subscriber_Pull_Handler,
},
{
MethodName: "ModifyPushConfig",
Handler: _Subscriber_ModifyPushConfig_Handler,
},
{
MethodName: "GetSnapshot",
Handler: _Subscriber_GetSnapshot_Handler,
},
{
MethodName: "ListSnapshots",
Handler: _Subscriber_ListSnapshots_Handler,
},
{
MethodName: "CreateSnapshot",
Handler: _Subscriber_CreateSnapshot_Handler,
},
{
MethodName: "UpdateSnapshot",
Handler: _Subscriber_UpdateSnapshot_Handler,
},
{
MethodName: "DeleteSnapshot",
Handler: _Subscriber_DeleteSnapshot_Handler,
},
{
MethodName: "Seek",
Handler: _Subscriber_Seek_Handler,
},
},
Streams: []grpc.StreamDesc{
{
StreamName: "StreamingPull",
Handler: _Subscriber_StreamingPull_Handler,
ServerStreams: true,
ClientStreams: true,
},
},
Metadata: "google/pubsub/v1/pubsub.proto",
}Subscriber_ServiceDesc is the grpc.ServiceDesc for Subscriber service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions
func RegisterPublisherServer
func RegisterPublisherServer(s grpc.ServiceRegistrar, srv PublisherServer)func RegisterSchemaServiceServer
func RegisterSchemaServiceServer(s grpc.ServiceRegistrar, srv SchemaServiceServer)func RegisterSubscriberServer
func RegisterSubscriberServer(s grpc.ServiceRegistrar, srv SubscriberServer)AIInference
type AIInference struct {
// Required. An endpoint to a Vertex AI model of the form
// `projects/{project}/locations/{location}/endpoints/{endpoint}` or
// `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.
// Vertex AI API requests will be sent to this endpoint.
Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
// The format of inference requests made to the endpoint.
//
// Types that are valid to be assigned to InferenceMode:
//
// *AIInference_UnstructuredInference_
InferenceMode isAIInference_InferenceMode `protobuf_oneof:"inference_mode"`
// Optional. The service account to use to make prediction requests against
// endpoints. The resource 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,3,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// contains filtered or unexported fields
}Configuration for making inference requests against Vertex AI models.
func (*AIInference) Descriptor
func (*AIInference) Descriptor() ([]byte, []int)Deprecated: Use AIInference.ProtoReflect.Descriptor instead.
func (*AIInference) GetEndpoint
func (x *AIInference) GetEndpoint() stringfunc (*AIInference) GetInferenceMode
func (x *AIInference) GetInferenceMode() isAIInference_InferenceModefunc (*AIInference) GetServiceAccountEmail
func (x *AIInference) GetServiceAccountEmail() stringfunc (*AIInference) GetUnstructuredInference
func (x *AIInference) GetUnstructuredInference() *AIInference_UnstructuredInferencefunc (*AIInference) ProtoMessage
func (*AIInference) ProtoMessage()func (*AIInference) ProtoReflect
func (x *AIInference) ProtoReflect() protoreflect.Messagefunc (*AIInference) Reset
func (x *AIInference) Reset()func (*AIInference) String
func (x *AIInference) String() stringAIInference_UnstructuredInference
type AIInference_UnstructuredInference struct {
// Optional. A parameters object to be included in each inference request.
// The parameters object is combined with the data field of the Pub/Sub
// message to form the inference request.
Parameters *structpb.Struct `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
// contains filtered or unexported fields
}Configuration for making inferences using arbitrary JSON payloads.
func (*AIInference_UnstructuredInference) Descriptor
func (*AIInference_UnstructuredInference) Descriptor() ([]byte, []int)Deprecated: Use AIInference_UnstructuredInference.ProtoReflect.Descriptor instead.
func (*AIInference_UnstructuredInference) GetParameters
func (x *AIInference_UnstructuredInference) GetParameters() *structpb.Structfunc (*AIInference_UnstructuredInference) ProtoMessage
func (*AIInference_UnstructuredInference) ProtoMessage()func (*AIInference_UnstructuredInference) ProtoReflect
func (x *AIInference_UnstructuredInference) ProtoReflect() protoreflect.Messagefunc (*AIInference_UnstructuredInference) Reset
func (x *AIInference_UnstructuredInference) Reset()func (*AIInference_UnstructuredInference) String
func (x *AIInference_UnstructuredInference) String() stringAIInference_UnstructuredInference_
type AIInference_UnstructuredInference_ struct {
// Optional. Requests and responses can be any arbitrary JSON object.
UnstructuredInference *AIInference_UnstructuredInference `protobuf:"bytes,2,opt,name=unstructured_inference,json=unstructuredInference,proto3,oneof"`
}AcknowledgeRequest
type AcknowledgeRequest struct {
// Required. The subscription whose message is being acknowledged.
// Format is `projects/{project}/subscriptions/{sub}`.
Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// Required. The acknowledgment ID for the messages being acknowledged that
// was returned by the Pub/Sub system in the `Pull` response. Must not be
// empty.
AckIds []string `protobuf:"bytes,2,rep,name=ack_ids,json=ackIds,proto3" json:"ack_ids,omitempty"`
// contains filtered or unexported fields
}Request for the Acknowledge method.
func (*AcknowledgeRequest) Descriptor
func (*AcknowledgeRequest) Descriptor() ([]byte, []int)Deprecated: Use AcknowledgeRequest.ProtoReflect.Descriptor instead.
func (*AcknowledgeRequest) GetAckIds
func (x *AcknowledgeRequest) GetAckIds() []stringfunc (*AcknowledgeRequest) GetSubscription
func (x *AcknowledgeRequest) GetSubscription() stringfunc (*AcknowledgeRequest) ProtoMessage
func (*AcknowledgeRequest) ProtoMessage()func (*AcknowledgeRequest) ProtoReflect
func (x *AcknowledgeRequest) ProtoReflect() protoreflect.Messagefunc (*AcknowledgeRequest) Reset
func (x *AcknowledgeRequest) Reset()func (*AcknowledgeRequest) String
func (x *AcknowledgeRequest) String() stringBigQueryConfig
type BigQueryConfig struct {
// Optional. The name of the table to which to write data, of the form
// {projectId}.{datasetId}.{tableId}
Table string `protobuf:"bytes,1,opt,name=table,proto3" json:"table,omitempty"`
// Optional. When true, use the topic's schema as the columns to write to in
// BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be
// enabled at the same time.
UseTopicSchema bool `protobuf:"varint,2,opt,name=use_topic_schema,json=useTopicSchema,proto3" json:"use_topic_schema,omitempty"`
// Optional. When true, write the subscription name, message_id, publish_time,
// attributes, and ordering_key to additional columns in the table. The
// subscription name, message_id, and publish_time fields are put in their own
// columns while all other message properties (other than data) are written to
// a JSON object in the attributes column.
WriteMetadata bool `protobuf:"varint,3,opt,name=write_metadata,json=writeMetadata,proto3" json:"write_metadata,omitempty"`
// Optional. If true and `use_topic_schema` is true, drops any fields that are
// part of the topic schema that are not part of the BigQuery table schema
// 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. If true and `use_table_schema` is true, drops any
// fields in the message that are not part of the BigQuery table schema when
// writing to BigQuery. Otherwise, the write to BigQuery will fail.
DropUnknownFields bool `protobuf:"varint,4,opt,name=drop_unknown_fields,json=dropUnknownFields,proto3" json:"drop_unknown_fields,omitempty"`
// Output only. An output-only field that indicates whether or not the
// subscription can receive messages.
State BigQueryConfig_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.pubsub.v1.BigQueryConfig_State" json:"state,omitempty"`
// Optional. When true, use the BigQuery table's schema as the columns to
// write to in BigQuery. `use_table_schema` and `use_topic_schema` cannot be
// enabled at the same time.
UseTableSchema bool `protobuf:"varint,6,opt,name=use_table_schema,json=useTableSchema,proto3" json:"use_table_schema,omitempty"`
// Optional. The service account to use to write to BigQuery. The subscription
// creator or updater that specifies this field must have
// `iam.serviceAccounts.actAs` permission on the service account. If not
// specified, the Pub/Sub [service
// agent](https://cloud.google.com/iam/docs/service-agents),
// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
ServiceAccountEmail string `protobuf:"bytes,7,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// contains filtered or unexported fields
}Configuration for a BigQuery subscription.
func (*BigQueryConfig) Descriptor
func (*BigQueryConfig) Descriptor() ([]byte, []int)Deprecated: Use BigQueryConfig.ProtoReflect.Descriptor instead.
func (*BigQueryConfig) GetDropUnknownFields
func (x *BigQueryConfig) GetDropUnknownFields() boolfunc (*BigQueryConfig) GetServiceAccountEmail
func (x *BigQueryConfig) GetServiceAccountEmail() stringfunc (*BigQueryConfig) GetState
func (x *BigQueryConfig) GetState() BigQueryConfig_Statefunc (*BigQueryConfig) GetTable
func (x *BigQueryConfig) GetTable() stringfunc (*BigQueryConfig) GetUseTableSchema
func (x *BigQueryConfig) GetUseTableSchema() boolfunc (*BigQueryConfig) GetUseTopicSchema
func (x *BigQueryConfig) GetUseTopicSchema() boolfunc (*BigQueryConfig) GetWriteMetadata
func (x *BigQueryConfig) GetWriteMetadata() boolfunc (*BigQueryConfig) ProtoMessage
func (*BigQueryConfig) ProtoMessage()func (*BigQueryConfig) ProtoReflect
func (x *BigQueryConfig) ProtoReflect() protoreflect.Messagefunc (*BigQueryConfig) Reset
func (x *BigQueryConfig) Reset()func (*BigQueryConfig) String
func (x *BigQueryConfig) String() stringBigQueryConfig_State
type BigQueryConfig_State int32Possible states for a BigQuery subscription.
BigQueryConfig_STATE_UNSPECIFIED, BigQueryConfig_ACTIVE, BigQueryConfig_PERMISSION_DENIED, BigQueryConfig_NOT_FOUND, BigQueryConfig_SCHEMA_MISMATCH, BigQueryConfig_IN_TRANSIT_LOCATION_RESTRICTION, BigQueryConfig_VERTEX_AI_LOCATION_RESTRICTION
const (
// Default value. This value is unused.
BigQueryConfig_STATE_UNSPECIFIED BigQueryConfig_State = 0
// The subscription can actively send messages to BigQuery
BigQueryConfig_ACTIVE BigQueryConfig_State = 1
// Cannot write to the BigQuery table because of permission denied errors.
// This can happen if
// - Pub/Sub SA has not been granted the [appropriate BigQuery IAM
// permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account)
// - bigquery.googleapis.com API is not enabled for the project
// ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))
BigQueryConfig_PERMISSION_DENIED BigQueryConfig_State = 2
// Cannot write to the BigQuery table because it does not exist.
BigQueryConfig_NOT_FOUND BigQueryConfig_State = 3
// Cannot write to the BigQuery table due to a schema mismatch.
BigQueryConfig_SCHEMA_MISMATCH BigQueryConfig_State = 4
// Cannot write to the destination because enforce_in_transit is set to true
// and the destination locations are not in the allowed regions.
BigQueryConfig_IN_TRANSIT_LOCATION_RESTRICTION BigQueryConfig_State = 5
// Cannot write to the BigQuery table because the table is not in the same
// location as where Vertex AI models used in `message_transform`s are
// deployed.
BigQueryConfig_VERTEX_AI_LOCATION_RESTRICTION BigQueryConfig_State = 6
)func (BigQueryConfig_State) Descriptor
func (BigQueryConfig_State) Descriptor() protoreflect.EnumDescriptorfunc (BigQueryConfig_State) Enum
func (x BigQueryConfig_State) Enum() *BigQueryConfig_Statefunc (BigQueryConfig_State) EnumDescriptor
func (BigQueryConfig_State) EnumDescriptor() ([]byte, []int)Deprecated: Use BigQueryConfig_State.Descriptor instead.
func (BigQueryConfig_State) Number
func (x BigQueryConfig_State) Number() protoreflect.EnumNumberfunc (BigQueryConfig_State) String
func (x BigQueryConfig_State) String() stringfunc (BigQueryConfig_State) Type
func (BigQueryConfig_State) Type() protoreflect.EnumTypeBigtableConfig
type BigtableConfig struct {
// Optional. The unique name of the table to write messages to.
//
// Values are of the form
// `projects/Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows:
- row key: subscription name, message ID hash, and message ID delimited by
#. - columns: message bytes written to a single column family
datawith an empty-string column qualifier. - cell timestamp: the message publish timestamp.
func (*BigtableConfig) Descriptor
func (*BigtableConfig) Descriptor() ([]byte, []int)Deprecated: Use BigtableConfig.ProtoReflect.Descriptor instead.
func (*BigtableConfig) GetAppProfileId
func (x *BigtableConfig) GetAppProfileId() stringfunc (*BigtableConfig) GetServiceAccountEmail
func (x *BigtableConfig) GetServiceAccountEmail() stringfunc (*BigtableConfig) GetState
func (x *BigtableConfig) GetState() BigtableConfig_Statefunc (*BigtableConfig) GetTable
func (x *BigtableConfig) GetTable() stringfunc (*BigtableConfig) GetWriteMetadata
func (x *BigtableConfig) GetWriteMetadata() boolfunc (*BigtableConfig) ProtoMessage
func (*BigtableConfig) ProtoMessage()func (*BigtableConfig) ProtoReflect
func (x *BigtableConfig) ProtoReflect() protoreflect.Messagefunc (*BigtableConfig) Reset
func (x *BigtableConfig) Reset()func (*BigtableConfig) String
func (x *BigtableConfig) String() stringBigtableConfig_State
type BigtableConfig_State int32Possible states for a Bigtable subscription. Note: more states could be added in the future. Please code accordingly.
BigtableConfig_STATE_UNSPECIFIED, BigtableConfig_ACTIVE, BigtableConfig_NOT_FOUND, BigtableConfig_APP_PROFILE_MISCONFIGURED, BigtableConfig_PERMISSION_DENIED, BigtableConfig_SCHEMA_MISMATCH, BigtableConfig_IN_TRANSIT_LOCATION_RESTRICTION, BigtableConfig_VERTEX_AI_LOCATION_RESTRICTION
const (
// Default value. This value is unused.
BigtableConfig_STATE_UNSPECIFIED BigtableConfig_State = 0
// The subscription can actively send messages to Bigtable.
BigtableConfig_ACTIVE BigtableConfig_State = 1
// Unused in the current implementation. Placeholder for future use.
BigtableConfig_NOT_FOUND BigtableConfig_State = 2
// Unused in the current implementation. Placeholder for future use.
BigtableConfig_APP_PROFILE_MISCONFIGURED BigtableConfig_State = 3
// Cannot write to Bigtable because of permission denied errors.
// This can happen if:
// - The Bigtable instance, table, or app profile does not exist.
// - The Pub/Sub service agent has not been granted the
// [appropriate Bigtable IAM permission
// bigtable.tables.mutateRows]({$universe.dns_names.final_documentation_domain}/bigtable/docs/access-control#permissions)
// - The bigtable.googleapis.com API is not enabled for the project
// ([instructions]({$universe.dns_names.final_documentation_domain}/service-usage/docs/enable-disable))
BigtableConfig_PERMISSION_DENIED BigtableConfig_State = 4
// Cannot write to Bigtable because of a missing column family (`data`), or
// if there is no structured row key for the subscription name + message ID,
// if because the app profile is not configured for single-cluster routing.
BigtableConfig_SCHEMA_MISMATCH BigtableConfig_State = 5
// Cannot write to the destination because enforce_in_transit is set to true
// and the destination locations are not in the allowed regions.
BigtableConfig_IN_TRANSIT_LOCATION_RESTRICTION BigtableConfig_State = 6
// Cannot write to Bigtable because the table is not in the same location as
// where Vertex AI models used in `message_transform`s are deployed.
BigtableConfig_VERTEX_AI_LOCATION_RESTRICTION BigtableConfig_State = 7
)func (BigtableConfig_State) Descriptor
func (BigtableConfig_State) Descriptor() protoreflect.EnumDescriptorfunc (BigtableConfig_State) Enum
func (x BigtableConfig_State) Enum() *BigtableConfig_Statefunc (BigtableConfig_State) EnumDescriptor
func (BigtableConfig_State) EnumDescriptor() ([]byte, []int)Deprecated: Use BigtableConfig_State.Descriptor instead.
func (BigtableConfig_State) Number
func (x BigtableConfig_State) Number() protoreflect.EnumNumberfunc (BigtableConfig_State) String
func (x BigtableConfig_State) String() stringfunc (BigtableConfig_State) Type
func (BigtableConfig_State) Type() protoreflect.EnumTypeCloudStorageConfig
type CloudStorageConfig struct {
// Required. User-provided name for the Cloud Storage bucket.
// The bucket must be created by the user. The bucket name must be without
// any prefix like "gs://". See the [bucket naming
// requirements] (https://cloud.google.com/storage/docs/buckets#naming).
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Optional. User-provided prefix for Cloud Storage filename. See the [object
// naming requirements](https://cloud.google.com/storage/docs/objects#naming).
FilenamePrefix string `protobuf:"bytes,2,opt,name=filename_prefix,json=filenamePrefix,proto3" json:"filename_prefix,omitempty"`
// Optional. User-provided suffix for Cloud Storage filename. See the [object
// naming requirements](https://cloud.google.com/storage/docs/objects#naming).
// Must not end in "/".
FilenameSuffix string `protobuf:"bytes,3,opt,name=filename_suffix,json=filenameSuffix,proto3" json:"filename_suffix,omitempty"`
// Optional. User-provided format string specifying how to represent datetimes
// in Cloud Storage filenames. See the [datetime format
// guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
FilenameDatetimeFormat string `protobuf:"bytes,10,opt,name=filename_datetime_format,json=filenameDatetimeFormat,proto3" json:"filename_datetime_format,omitempty"`
// Defaults to text format.
//
// Types that are valid to be assigned to OutputFormat:
//
// *CloudStorageConfig_TextConfig_
// *CloudStorageConfig_AvroConfig_
OutputFormat isCloudStorageConfig_OutputFormat `protobuf_oneof:"output_format"`
// Optional. 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 acknowledgment 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"`
// Output only. An output-only field that indicates whether or not the
// subscription can receive messages.
State CloudStorageConfig_State `protobuf:"varint,9,opt,name=state,proto3,enum=google.pubsub.v1.CloudStorageConfig_State" json:"state,omitempty"`
// Optional. The service account to use to write to Cloud Storage. The
// subscription creator or updater that specifies this field must have
// `iam.serviceAccounts.actAs` permission on the service account. If not
// specified, the Pub/Sub
// [service agent](https://cloud.google.com/iam/docs/service-agents),
// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
ServiceAccountEmail string `protobuf:"bytes,11,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// contains filtered or unexported fields
}Configuration for a Cloud Storage subscription.
func (*CloudStorageConfig) Descriptor
func (*CloudStorageConfig) Descriptor() ([]byte, []int)Deprecated: Use CloudStorageConfig.ProtoReflect.Descriptor instead.
func (*CloudStorageConfig) GetAvroConfig
func (x *CloudStorageConfig) GetAvroConfig() *CloudStorageConfig_AvroConfigfunc (*CloudStorageConfig) GetBucket
func (x *CloudStorageConfig) GetBucket() stringfunc (*CloudStorageConfig) GetFilenameDatetimeFormat
func (x *CloudStorageConfig) GetFilenameDatetimeFormat() stringfunc (*CloudStorageConfig) GetFilenamePrefix
func (x *CloudStorageConfig) GetFilenamePrefix() stringfunc (*CloudStorageConfig) GetFilenameSuffix
func (x *CloudStorageConfig) GetFilenameSuffix() stringfunc (*CloudStorageConfig) GetMaxBytes
func (x *CloudStorageConfig) GetMaxBytes() int64func (*CloudStorageConfig) GetMaxDuration
func (x *CloudStorageConfig) GetMaxDuration() *durationpb.Durationfunc (*CloudStorageConfig) GetMaxMessages
func (x *CloudStorageConfig) GetMaxMessages() int64func (*CloudStorageConfig) GetOutputFormat
func (x *CloudStorageConfig) GetOutputFormat() isCloudStorageConfig_OutputFormatfunc (*CloudStorageConfig) GetServiceAccountEmail
func (x *CloudStorageConfig) GetServiceAccountEmail() stringfunc (*CloudStorageConfig) GetState
func (x *CloudStorageConfig) GetState() CloudStorageConfig_Statefunc (*CloudStorageConfig) GetTextConfig
func (x *CloudStorageConfig) GetTextConfig() *CloudStorageConfig_TextConfigfunc (*CloudStorageConfig) ProtoMessage
func (*CloudStorageConfig) ProtoMessage()func (*CloudStorageConfig) ProtoReflect
func (x *CloudStorageConfig) ProtoReflect() protoreflect.Messagefunc (*CloudStorageConfig) Reset
func (x *CloudStorageConfig) Reset()func (*CloudStorageConfig) String
func (x *CloudStorageConfig) String() stringCloudStorageConfig_AvroConfig
type CloudStorageConfig_AvroConfig struct {
// Optional. When true, write the subscription name, message_id,
// publish_time, attributes, and ordering_key as additional fields in the
// output. The subscription name, message_id, and publish_time fields are
// put in their own fields while all other message properties other than
// data (for example, an ordering_key, if present) are added as entries in
// the attributes map.
WriteMetadata bool `protobuf:"varint,1,opt,name=write_metadata,json=writeMetadata,proto3" json:"write_metadata,omitempty"`
// Optional. When true, the output Cloud Storage file will be serialized
// using the topic schema, if it exists.
UseTopicSchema bool `protobuf:"varint,2,opt,name=use_topic_schema,json=useTopicSchema,proto3" json:"use_topic_schema,omitempty"`
// contains filtered or unexported fields
}Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.
func (*CloudStorageConfig_AvroConfig) Descriptor
func (*CloudStorageConfig_AvroConfig) Descriptor() ([]byte, []int)Deprecated: Use CloudStorageConfig_AvroConfig.ProtoReflect.Descriptor instead.
func (*CloudStorageConfig_AvroConfig) GetUseTopicSchema
func (x *CloudStorageConfig_AvroConfig) GetUseTopicSchema() boolfunc (*CloudStorageConfig_AvroConfig) GetWriteMetadata
func (x *CloudStorageConfig_AvroConfig) GetWriteMetadata() boolfunc (*CloudStorageConfig_AvroConfig) ProtoMessage
func (*CloudStorageConfig_AvroConfig) ProtoMessage()func (*CloudStorageConfig_AvroConfig) ProtoReflect
func (x *CloudStorageConfig_AvroConfig) ProtoReflect() protoreflect.Messagefunc (*CloudStorageConfig_AvroConfig) Reset
func (x *CloudStorageConfig_AvroConfig) Reset()func (*CloudStorageConfig_AvroConfig) String
func (x *CloudStorageConfig_AvroConfig) String() stringCloudStorageConfig_AvroConfig_
type CloudStorageConfig_AvroConfig_ struct {
// Optional. If set, message data will be written to Cloud Storage in Avro
// format.
AvroConfig *CloudStorageConfig_AvroConfig `protobuf:"bytes,5,opt,name=avro_config,json=avroConfig,proto3,oneof"`
}CloudStorageConfig_State
type CloudStorageConfig_State int32Possible states for a Cloud Storage subscription.
CloudStorageConfig_STATE_UNSPECIFIED, CloudStorageConfig_ACTIVE, CloudStorageConfig_PERMISSION_DENIED, CloudStorageConfig_NOT_FOUND, CloudStorageConfig_IN_TRANSIT_LOCATION_RESTRICTION, CloudStorageConfig_SCHEMA_MISMATCH, CloudStorageConfig_VERTEX_AI_LOCATION_RESTRICTION
const (
// Default value. This value is unused.
CloudStorageConfig_STATE_UNSPECIFIED CloudStorageConfig_State = 0
// The subscription can actively send messages to Cloud Storage.
CloudStorageConfig_ACTIVE CloudStorageConfig_State = 1
// Cannot write to the Cloud Storage bucket because of permission denied
// errors.
CloudStorageConfig_PERMISSION_DENIED CloudStorageConfig_State = 2
// Cannot write to the Cloud Storage bucket because it does not exist.
CloudStorageConfig_NOT_FOUND CloudStorageConfig_State = 3
// Cannot write to the destination because enforce_in_transit is set to true
// and the destination locations are not in the allowed regions.
CloudStorageConfig_IN_TRANSIT_LOCATION_RESTRICTION CloudStorageConfig_State = 4
// Cannot write to the Cloud Storage bucket due to an incompatibility
// between the topic schema and subscription settings.
CloudStorageConfig_SCHEMA_MISMATCH CloudStorageConfig_State = 5
// Cannot write to the Cloud Storage bucket because the bucket is not in the
// same location as where Vertex AI models used in `message_transform`s are
// deployed.
CloudStorageConfig_VERTEX_AI_LOCATION_RESTRICTION CloudStorageConfig_State = 6
)func (CloudStorageConfig_State) Descriptor
func (CloudStorageConfig_State) Descriptor() protoreflect.EnumDescriptorfunc (CloudStorageConfig_State) Enum
func (x CloudStorageConfig_State) Enum() *CloudStorageConfig_Statefunc (CloudStorageConfig_State) EnumDescriptor
func (CloudStorageConfig_State) EnumDescriptor() ([]byte, []int)Deprecated: Use CloudStorageConfig_State.Descriptor instead.
func (CloudStorageConfig_State) Number
func (x CloudStorageConfig_State) Number() protoreflect.EnumNumberfunc (CloudStorageConfig_State) String
func (x CloudStorageConfig_State) String() stringfunc (CloudStorageConfig_State) Type
func (CloudStorageConfig_State) Type() protoreflect.EnumTypeCloudStorageConfig_TextConfig
type CloudStorageConfig_TextConfig struct {
// contains filtered or unexported fields
}Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline.
func (*CloudStorageConfig_TextConfig) Descriptor
func (*CloudStorageConfig_TextConfig) Descriptor() ([]byte, []int)Deprecated: Use CloudStorageConfig_TextConfig.ProtoReflect.Descriptor instead.
func (*CloudStorageConfig_TextConfig) ProtoMessage
func (*CloudStorageConfig_TextConfig) ProtoMessage()func (*CloudStorageConfig_TextConfig) ProtoReflect
func (x *CloudStorageConfig_TextConfig) ProtoReflect() protoreflect.Messagefunc (*CloudStorageConfig_TextConfig) Reset
func (x *CloudStorageConfig_TextConfig) Reset()func (*CloudStorageConfig_TextConfig) String
func (x *CloudStorageConfig_TextConfig) String() stringCloudStorageConfig_TextConfig_
type CloudStorageConfig_TextConfig_ struct {
// Optional. If set, message data will be written to Cloud Storage in text
// format.
TextConfig *CloudStorageConfig_TextConfig `protobuf:"bytes,4,opt,name=text_config,json=textConfig,proto3,oneof"`
}CommitSchemaRequest
type CommitSchemaRequest struct {
// Required. The name of the schema we are revising.
// Format is `projects/{project}/schemas/{schema}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The schema revision to commit.
Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
// contains filtered or unexported fields
}Request for CommitSchema method.
func (*CommitSchemaRequest) Descriptor
func (*CommitSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use CommitSchemaRequest.ProtoReflect.Descriptor instead.
func (*CommitSchemaRequest) GetName
func (x *CommitSchemaRequest) GetName() stringfunc (*CommitSchemaRequest) GetSchema
func (x *CommitSchemaRequest) GetSchema() *Schemafunc (*CommitSchemaRequest) ProtoMessage
func (*CommitSchemaRequest) ProtoMessage()func (*CommitSchemaRequest) ProtoReflect
func (x *CommitSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*CommitSchemaRequest) Reset
func (x *CommitSchemaRequest) Reset()func (*CommitSchemaRequest) String
func (x *CommitSchemaRequest) String() stringCompiledProtoSchema
type CompiledProtoSchema struct {
// Required. The name of the root message type in the schema.
RootMessage string `protobuf:"bytes,1,opt,name=root_message,json=rootMessage,proto3" json:"root_message,omitempty"`
// Required. The compiled FileDescriptorSet binary.
CompiledBytes []byte `protobuf:"bytes,2,opt,name=compiled_bytes,json=compiledBytes,proto3" json:"compiled_bytes,omitempty"`
// contains filtered or unexported fields
}Configuration specific to compiled Protocol Buffer schemas.
func (*CompiledProtoSchema) Descriptor
func (*CompiledProtoSchema) Descriptor() ([]byte, []int)Deprecated: Use CompiledProtoSchema.ProtoReflect.Descriptor instead.
func (*CompiledProtoSchema) GetCompiledBytes
func (x *CompiledProtoSchema) GetCompiledBytes() []bytefunc (*CompiledProtoSchema) GetRootMessage
func (x *CompiledProtoSchema) GetRootMessage() stringfunc (*CompiledProtoSchema) ProtoMessage
func (*CompiledProtoSchema) ProtoMessage()func (*CompiledProtoSchema) ProtoReflect
func (x *CompiledProtoSchema) ProtoReflect() protoreflect.Messagefunc (*CompiledProtoSchema) Reset
func (x *CompiledProtoSchema) Reset()func (*CompiledProtoSchema) String
func (x *CompiledProtoSchema) String() stringCompression
type Compression struct {
// Required. Specifies the compression algorithm to use.
CompressionAlgorithm Compression_CompressionAlgorithm `protobuf:"varint,1,opt,name=compression_algorithm,json=compressionAlgorithm,proto3,enum=google.pubsub.v1.Compression_CompressionAlgorithm" json:"compression_algorithm,omitempty"`
// Required. Specifies whether to compress or decompress the message.
CompressionMode Compression_CompressionMode `protobuf:"varint,2,opt,name=compression_mode,json=compressionMode,proto3,enum=google.pubsub.v1.Compression_CompressionMode" json:"compression_mode,omitempty"`
// contains filtered or unexported fields
}Configuration for compressing/decompressing message data using a user-specified compression algorithm.
func (*Compression) Descriptor
func (*Compression) Descriptor() ([]byte, []int)Deprecated: Use Compression.ProtoReflect.Descriptor instead.
func (*Compression) GetCompressionAlgorithm
func (x *Compression) GetCompressionAlgorithm() Compression_CompressionAlgorithmfunc (*Compression) GetCompressionMode
func (x *Compression) GetCompressionMode() Compression_CompressionModefunc (*Compression) ProtoMessage
func (*Compression) ProtoMessage()func (*Compression) ProtoReflect
func (x *Compression) ProtoReflect() protoreflect.Messagefunc (*Compression) Reset
func (x *Compression) Reset()func (*Compression) String
func (x *Compression) String() stringCompression_CompressionAlgorithm
type Compression_CompressionAlgorithm int32The compression algorithm to use.
Compression_COMPRESSION_ALGORITHM_UNSPECIFIED, Compression_ZLIB
const (
// Unspecified algorithm.
Compression_COMPRESSION_ALGORITHM_UNSPECIFIED Compression_CompressionAlgorithm = 0
// ZLIB compression.
Compression_ZLIB Compression_CompressionAlgorithm = 1
)func (Compression_CompressionAlgorithm) Descriptor
func (Compression_CompressionAlgorithm) Descriptor() protoreflect.EnumDescriptorfunc (Compression_CompressionAlgorithm) Enum
func (x Compression_CompressionAlgorithm) Enum() *Compression_CompressionAlgorithmfunc (Compression_CompressionAlgorithm) EnumDescriptor
func (Compression_CompressionAlgorithm) EnumDescriptor() ([]byte, []int)Deprecated: Use Compression_CompressionAlgorithm.Descriptor instead.
func (Compression_CompressionAlgorithm) Number
func (x Compression_CompressionAlgorithm) Number() protoreflect.EnumNumberfunc (Compression_CompressionAlgorithm) String
func (x Compression_CompressionAlgorithm) String() stringfunc (Compression_CompressionAlgorithm) Type
func (Compression_CompressionAlgorithm) Type() protoreflect.EnumTypeCompression_CompressionMode
type Compression_CompressionMode int32The mode of the compression SMT.
Compression_COMPRESSION_MODE_UNSPECIFIED, Compression_COMPRESS, Compression_DECOMPRESS
const (
// Unspecified mode.
Compression_COMPRESSION_MODE_UNSPECIFIED Compression_CompressionMode = 0
// Compress.
Compression_COMPRESS Compression_CompressionMode = 1
// Decompress.
Compression_DECOMPRESS Compression_CompressionMode = 2
)func (Compression_CompressionMode) Descriptor
func (Compression_CompressionMode) Descriptor() protoreflect.EnumDescriptorfunc (Compression_CompressionMode) Enum
func (x Compression_CompressionMode) Enum() *Compression_CompressionModefunc (Compression_CompressionMode) EnumDescriptor
func (Compression_CompressionMode) EnumDescriptor() ([]byte, []int)Deprecated: Use Compression_CompressionMode.Descriptor instead.
func (Compression_CompressionMode) Number
func (x Compression_CompressionMode) Number() protoreflect.EnumNumberfunc (Compression_CompressionMode) String
func (x Compression_CompressionMode) String() stringfunc (Compression_CompressionMode) Type
func (Compression_CompressionMode) Type() protoreflect.EnumTypeCreateSchemaRequest
type CreateSchemaRequest struct {
// Required. The name of the project in which to create the schema.
// Format is `projects/{project-id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The schema object to create.
//
// This schema's `name` parameter is ignored. The schema object returned
// by CreateSchema will have a `name` made using the given `parent` and
// `schema_id`.
Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
// The ID to use for the schema, which will become the final component of
// the schema's resource name.
//
// See https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for
// resource name constraints.
SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
// contains filtered or unexported fields
}Request for the CreateSchema method.
func (*CreateSchemaRequest) Descriptor
func (*CreateSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSchemaRequest.ProtoReflect.Descriptor instead.
func (*CreateSchemaRequest) GetParent
func (x *CreateSchemaRequest) GetParent() stringfunc (*CreateSchemaRequest) GetSchema
func (x *CreateSchemaRequest) GetSchema() *Schemafunc (*CreateSchemaRequest) GetSchemaId
func (x *CreateSchemaRequest) GetSchemaId() stringfunc (*CreateSchemaRequest) ProtoMessage
func (*CreateSchemaRequest) ProtoMessage()func (*CreateSchemaRequest) ProtoReflect
func (x *CreateSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSchemaRequest) Reset
func (x *CreateSchemaRequest) Reset()func (*CreateSchemaRequest) String
func (x *CreateSchemaRequest) String() stringCreateSnapshotRequest
type CreateSnapshotRequest struct {
// Required. User-provided name for this snapshot. If the name is not provided
// in the request, the server will assign a random name for this snapshot on
// the same project as the subscription. Note that for REST API requests, you
// must specify a name. See the [resource name
// rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
// Format is `projects/{project}/snapshots/{snap}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The subscription whose backlog the snapshot retains.
// Specifically, the created snapshot is guaranteed to retain:
//
// (a) The existing backlog on the subscription. More precisely, this is
// defined as the messages in the subscription's backlog that are
// unacknowledged upon the successful completion of the
// `CreateSnapshot` request; as well as:
// (b) Any messages published to the subscription's topic following the
// successful completion of the CreateSnapshot request.
//
// Format is `projects/{project}/subscriptions/{sub}`.
Subscription string `protobuf:"bytes,2,opt,name=subscription,proto3" json:"subscription,omitempty"`
// Optional. See [Creating and managing
// labels](https://cloud.google.com/pubsub/docs/labels).
Labels map[string]string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. Input only. Immutable. Tag keys/values directly bound to this
// resource. For example:
//
// "123/environment": "production",
// "123/costCenter": "marketing"
//
// See
// https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags
// for more information on using tags with Pub/Sub resources.
Tags map[string]string `protobuf:"bytes,4,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Request for the CreateSnapshot method.
func (*CreateSnapshotRequest) Descriptor
func (*CreateSnapshotRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSnapshotRequest.ProtoReflect.Descriptor instead.
func (*CreateSnapshotRequest) GetLabels
func (x *CreateSnapshotRequest) GetLabels() map[string]stringfunc (*CreateSnapshotRequest) GetName
func (x *CreateSnapshotRequest) GetName() stringfunc (*CreateSnapshotRequest) GetSubscription
func (x *CreateSnapshotRequest) GetSubscription() stringfunc (*CreateSnapshotRequest) GetTags
func (x *CreateSnapshotRequest) GetTags() map[string]stringfunc (*CreateSnapshotRequest) ProtoMessage
func (*CreateSnapshotRequest) ProtoMessage()func (*CreateSnapshotRequest) ProtoReflect
func (x *CreateSnapshotRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSnapshotRequest) Reset
func (x *CreateSnapshotRequest) Reset()func (*CreateSnapshotRequest) String
func (x *CreateSnapshotRequest) String() stringDeadLetterPolicy
type DeadLetterPolicy struct {
// Optional. The name of the topic to which dead letter messages should be
// published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub
// service account associated with the enclosing subscription's parent project
// (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must
// have permission to Publish() to this topic.
//
// The operation will fail if the topic does not exist.
// Users should ensure that there is a subscription attached to this topic
// since messages published to a topic with no subscriptions are lost.
DeadLetterTopic string `protobuf:"bytes,1,opt,name=dead_letter_topic,json=deadLetterTopic,proto3" json:"dead_letter_topic,omitempty"`
// Optional. The maximum number of delivery attempts for any message. The
// value must be between 5 and 100.
//
// The number of delivery attempts is defined as 1 + (the sum of number of
// NACKs and number of times the acknowledgment deadline has been exceeded
// for the message).
//
// A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that
// client libraries may automatically extend ack_deadlines.
//
// This field will be honored on a best effort basis.
//
// If this parameter is 0, a default value of 5 is used.
MaxDeliveryAttempts int32 `protobuf:"varint,2,opt,name=max_delivery_attempts,json=maxDeliveryAttempts,proto3" json:"max_delivery_attempts,omitempty"`
// contains filtered or unexported fields
}Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times.
If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.
func (*DeadLetterPolicy) Descriptor
func (*DeadLetterPolicy) Descriptor() ([]byte, []int)Deprecated: Use DeadLetterPolicy.ProtoReflect.Descriptor instead.
func (*DeadLetterPolicy) GetDeadLetterTopic
func (x *DeadLetterPolicy) GetDeadLetterTopic() stringfunc (*DeadLetterPolicy) GetMaxDeliveryAttempts
func (x *DeadLetterPolicy) GetMaxDeliveryAttempts() int32func (*DeadLetterPolicy) ProtoMessage
func (*DeadLetterPolicy) ProtoMessage()func (*DeadLetterPolicy) ProtoReflect
func (x *DeadLetterPolicy) ProtoReflect() protoreflect.Messagefunc (*DeadLetterPolicy) Reset
func (x *DeadLetterPolicy) Reset()func (*DeadLetterPolicy) String
func (x *DeadLetterPolicy) String() stringDeleteSchemaRequest
type DeleteSchemaRequest struct {
// Required. Name of the schema to delete.
// Format is `projects/{project}/schemas/{schema}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for the DeleteSchema method.
func (*DeleteSchemaRequest) Descriptor
func (*DeleteSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSchemaRequest.ProtoReflect.Descriptor instead.
func (*DeleteSchemaRequest) GetName
func (x *DeleteSchemaRequest) GetName() stringfunc (*DeleteSchemaRequest) ProtoMessage
func (*DeleteSchemaRequest) ProtoMessage()func (*DeleteSchemaRequest) ProtoReflect
func (x *DeleteSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSchemaRequest) Reset
func (x *DeleteSchemaRequest) Reset()func (*DeleteSchemaRequest) String
func (x *DeleteSchemaRequest) String() stringDeleteSchemaRevisionRequest
type DeleteSchemaRevisionRequest struct {
// Required. The name of the schema revision to be deleted, with a revision ID
// explicitly included.
//
// Example: `projects/123/schemas/my-schema@c7cfa2a8`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. This field is deprecated and should not be used for specifying
// the revision ID. The revision ID should be specified via the `name`
// parameter.
//
// Deprecated: Marked as deprecated in google/pubsub/v1/schema.proto.
RevisionId string `protobuf:"bytes,2,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
// contains filtered or unexported fields
}Request for the DeleteSchemaRevision method.
func (*DeleteSchemaRevisionRequest) Descriptor
func (*DeleteSchemaRevisionRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSchemaRevisionRequest.ProtoReflect.Descriptor instead.
func (*DeleteSchemaRevisionRequest) GetName
func (x *DeleteSchemaRevisionRequest) GetName() stringfunc (*DeleteSchemaRevisionRequest) GetRevisionId
func (x *DeleteSchemaRevisionRequest) GetRevisionId() stringDeprecated: Marked as deprecated in google/pubsub/v1/schema.proto.
func (*DeleteSchemaRevisionRequest) ProtoMessage
func (*DeleteSchemaRevisionRequest) ProtoMessage()func (*DeleteSchemaRevisionRequest) ProtoReflect
func (x *DeleteSchemaRevisionRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSchemaRevisionRequest) Reset
func (x *DeleteSchemaRevisionRequest) Reset()func (*DeleteSchemaRevisionRequest) String
func (x *DeleteSchemaRevisionRequest) String() stringDeleteSnapshotRequest
type DeleteSnapshotRequest struct {
// Required. The name of the snapshot to delete.
// Format is `projects/{project}/snapshots/{snap}`.
Snapshot string `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
// contains filtered or unexported fields
}Request for the DeleteSnapshot method.
func (*DeleteSnapshotRequest) Descriptor
func (*DeleteSnapshotRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSnapshotRequest.ProtoReflect.Descriptor instead.
func (*DeleteSnapshotRequest) GetSnapshot
func (x *DeleteSnapshotRequest) GetSnapshot() stringfunc (*DeleteSnapshotRequest) ProtoMessage
func (*DeleteSnapshotRequest) ProtoMessage()func (*DeleteSnapshotRequest) ProtoReflect
func (x *DeleteSnapshotRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSnapshotRequest) Reset
func (x *DeleteSnapshotRequest) Reset()func (*DeleteSnapshotRequest) String
func (x *DeleteSnapshotRequest) String() stringDeleteSubscriptionRequest
type DeleteSubscriptionRequest struct {
// Required. The subscription to delete.
// Format is `projects/{project}/subscriptions/{sub}`.
Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// contains filtered or unexported fields
}Request for the DeleteSubscription method.
func (*DeleteSubscriptionRequest) Descriptor
func (*DeleteSubscriptionRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSubscriptionRequest.ProtoReflect.Descriptor instead.
func (*DeleteSubscriptionRequest) GetSubscription
func (x *DeleteSubscriptionRequest) GetSubscription() stringfunc (*DeleteSubscriptionRequest) ProtoMessage
func (*DeleteSubscriptionRequest) ProtoMessage()func (*DeleteSubscriptionRequest) ProtoReflect
func (x *DeleteSubscriptionRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSubscriptionRequest) Reset
func (x *DeleteSubscriptionRequest) Reset()func (*DeleteSubscriptionRequest) String
func (x *DeleteSubscriptionRequest) String() stringDeleteTopicRequest
type DeleteTopicRequest struct {
// Required. Name of the topic to delete.
// Format is `projects/{project}/topics/{topic}`.
Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
// contains filtered or unexported fields
}Request for the DeleteTopic method.
func (*DeleteTopicRequest) Descriptor
func (*DeleteTopicRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteTopicRequest.ProtoReflect.Descriptor instead.
func (*DeleteTopicRequest) GetTopic
func (x *DeleteTopicRequest) GetTopic() stringfunc (*DeleteTopicRequest) ProtoMessage
func (*DeleteTopicRequest) ProtoMessage()func (*DeleteTopicRequest) ProtoReflect
func (x *DeleteTopicRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteTopicRequest) Reset
func (x *DeleteTopicRequest) Reset()func (*DeleteTopicRequest) String
func (x *DeleteTopicRequest) String() stringDetachSubscriptionRequest
type DetachSubscriptionRequest struct {
// Required. The subscription to detach.
// Format is `projects/{project}/subscriptions/{subscription}`.
Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// contains filtered or unexported fields
}Request for the DetachSubscription method.
func (*DetachSubscriptionRequest) Descriptor
func (*DetachSubscriptionRequest) Descriptor() ([]byte, []int)Deprecated: Use DetachSubscriptionRequest.ProtoReflect.Descriptor instead.
func (*DetachSubscriptionRequest) GetSubscription
func (x *DetachSubscriptionRequest) GetSubscription() stringfunc (*DetachSubscriptionRequest) ProtoMessage
func (*DetachSubscriptionRequest) ProtoMessage()func (*DetachSubscriptionRequest) ProtoReflect
func (x *DetachSubscriptionRequest) ProtoReflect() protoreflect.Messagefunc (*DetachSubscriptionRequest) Reset
func (x *DetachSubscriptionRequest) Reset()func (*DetachSubscriptionRequest) String
func (x *DetachSubscriptionRequest) String() stringDetachSubscriptionResponse
type DetachSubscriptionResponse struct {
// contains filtered or unexported fields
}Response for the DetachSubscription method. Reserved for future use.
func (*DetachSubscriptionResponse) Descriptor
func (*DetachSubscriptionResponse) Descriptor() ([]byte, []int)Deprecated: Use DetachSubscriptionResponse.ProtoReflect.Descriptor instead.
func (*DetachSubscriptionResponse) ProtoMessage
func (*DetachSubscriptionResponse) ProtoMessage()func (*DetachSubscriptionResponse) ProtoReflect
func (x *DetachSubscriptionResponse) ProtoReflect() protoreflect.Messagefunc (*DetachSubscriptionResponse) Reset
func (x *DetachSubscriptionResponse) Reset()func (*DetachSubscriptionResponse) String
func (x *DetachSubscriptionResponse) String() stringEncoding
type Encoding int32Possible encoding types for messages.
Encoding_ENCODING_UNSPECIFIED, Encoding_JSON, Encoding_BINARY
const (
// Unspecified
Encoding_ENCODING_UNSPECIFIED Encoding = 0
// JSON encoding
Encoding_JSON Encoding = 1
// Binary encoding, as defined by the schema type. For some schema types,
// binary encoding may not be available.
Encoding_BINARY Encoding = 2
)func (Encoding) Descriptor
func (Encoding) Descriptor() protoreflect.EnumDescriptorfunc (Encoding) Enum
func (Encoding) EnumDescriptor
Deprecated: Use Encoding.Descriptor instead.
func (Encoding) Number
func (x Encoding) Number() protoreflect.EnumNumberfunc (Encoding) String
func (Encoding) Type
func (Encoding) Type() protoreflect.EnumTypeExpirationPolicy
type ExpirationPolicy struct {
// Optional. Specifies the "time-to-live" duration for an associated resource.
// The resource expires if it is not active for a period of `ttl`. The
// definition of "activity" depends on the type of the associated resource.
// The minimum and maximum allowed values for `ttl` depend on the type of the
// associated resource, as well. If `ttl` is not set, the associated resource
// never expires.
Ttl *durationpb.Duration `protobuf:"bytes,1,opt,name=ttl,proto3" json:"ttl,omitempty"`
// contains filtered or unexported fields
}A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
func (*ExpirationPolicy) Descriptor
func (*ExpirationPolicy) Descriptor() ([]byte, []int)Deprecated: Use ExpirationPolicy.ProtoReflect.Descriptor instead.
func (*ExpirationPolicy) GetTtl
func (x *ExpirationPolicy) GetTtl() *durationpb.Durationfunc (*ExpirationPolicy) ProtoMessage
func (*ExpirationPolicy) ProtoMessage()func (*ExpirationPolicy) ProtoReflect
func (x *ExpirationPolicy) ProtoReflect() protoreflect.Messagefunc (*ExpirationPolicy) Reset
func (x *ExpirationPolicy) Reset()func (*ExpirationPolicy) String
func (x *ExpirationPolicy) String() stringGetSchemaRequest
type GetSchemaRequest struct {
// Required. The name of the schema to get.
// Format is `projects/{project}/schemas/{schema}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The set of fields to return in the response. If not set, returns a Schema
// with all fields filled out. Set to `BASIC` to omit the `definition`.
View SchemaView `protobuf:"varint,2,opt,name=view,proto3,enum=google.pubsub.v1.SchemaView" json:"view,omitempty"`
// contains filtered or unexported fields
}Request for the GetSchema method.
func (*GetSchemaRequest) Descriptor
func (*GetSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.
func (*GetSchemaRequest) GetName
func (x *GetSchemaRequest) GetName() stringfunc (*GetSchemaRequest) GetView
func (x *GetSchemaRequest) GetView() SchemaViewfunc (*GetSchemaRequest) ProtoMessage
func (*GetSchemaRequest) ProtoMessage()func (*GetSchemaRequest) ProtoReflect
func (x *GetSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*GetSchemaRequest) Reset
func (x *GetSchemaRequest) Reset()func (*GetSchemaRequest) String
func (x *GetSchemaRequest) String() stringGetSnapshotRequest
type GetSnapshotRequest struct {
// Required. The name of the snapshot to get.
// Format is `projects/{project}/snapshots/{snap}`.
Snapshot string `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
// contains filtered or unexported fields
}Request for the GetSnapshot method.
func (*GetSnapshotRequest) Descriptor
func (*GetSnapshotRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSnapshotRequest.ProtoReflect.Descriptor instead.
func (*GetSnapshotRequest) GetSnapshot
func (x *GetSnapshotRequest) GetSnapshot() stringfunc (*GetSnapshotRequest) ProtoMessage
func (*GetSnapshotRequest) ProtoMessage()func (*GetSnapshotRequest) ProtoReflect
func (x *GetSnapshotRequest) ProtoReflect() protoreflect.Messagefunc (*GetSnapshotRequest) Reset
func (x *GetSnapshotRequest) Reset()func (*GetSnapshotRequest) String
func (x *GetSnapshotRequest) String() stringGetSubscriptionRequest
type GetSubscriptionRequest struct {
// Required. The name of the subscription to get.
// Format is `projects/{project}/subscriptions/{sub}`.
Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// contains filtered or unexported fields
}Request for the GetSubscription method.
func (*GetSubscriptionRequest) Descriptor
func (*GetSubscriptionRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSubscriptionRequest.ProtoReflect.Descriptor instead.
func (*GetSubscriptionRequest) GetSubscription
func (x *GetSubscriptionRequest) GetSubscription() stringfunc (*GetSubscriptionRequest) ProtoMessage
func (*GetSubscriptionRequest) ProtoMessage()func (*GetSubscriptionRequest) ProtoReflect
func (x *GetSubscriptionRequest) ProtoReflect() protoreflect.Messagefunc (*GetSubscriptionRequest) Reset
func (x *GetSubscriptionRequest) Reset()func (*GetSubscriptionRequest) String
func (x *GetSubscriptionRequest) String() stringGetTopicRequest
type GetTopicRequest struct {
// Required. The name of the topic to get.
// Format is `projects/{project}/topics/{topic}`.
Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
// contains filtered or unexported fields
}Request for the GetTopic method.
func (*GetTopicRequest) Descriptor
func (*GetTopicRequest) Descriptor() ([]byte, []int)Deprecated: Use GetTopicRequest.ProtoReflect.Descriptor instead.
func (*GetTopicRequest) GetTopic
func (x *GetTopicRequest) GetTopic() stringfunc (*GetTopicRequest) ProtoMessage
func (*GetTopicRequest) ProtoMessage()func (*GetTopicRequest) ProtoReflect
func (x *GetTopicRequest) ProtoReflect() protoreflect.Messagefunc (*GetTopicRequest) Reset
func (x *GetTopicRequest) Reset()func (*GetTopicRequest) String
func (x *GetTopicRequest) String() stringIngestionDataSourceSettings
type IngestionDataSourceSettings struct {
// Only one source type can have settings set.
//
// Types that are valid to be assigned to Source:
//
// *IngestionDataSourceSettings_AwsKinesis_
// *IngestionDataSourceSettings_CloudStorage_
// *IngestionDataSourceSettings_AzureEventHubs_
// *IngestionDataSourceSettings_AwsMsk_
// *IngestionDataSourceSettings_ConfluentCloud_
Source isIngestionDataSourceSettings_Source `protobuf_oneof:"source"`
// Optional. Platform Logs settings. If unset, no Platform Logs will be
// generated.
PlatformLogsSettings *PlatformLogsSettings `protobuf:"bytes,4,opt,name=platform_logs_settings,json=platformLogsSettings,proto3" json:"platform_logs_settings,omitempty"`
// contains filtered or unexported fields
}Settings for an ingestion data source on a topic.
func (*IngestionDataSourceSettings) Descriptor
func (*IngestionDataSourceSettings) Descriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings.ProtoReflect.Descriptor instead.
func (*IngestionDataSourceSettings) GetAwsKinesis
func (x *IngestionDataSourceSettings) GetAwsKinesis() *IngestionDataSourceSettings_AwsKinesisfunc (*IngestionDataSourceSettings) GetAwsMsk
func (x *IngestionDataSourceSettings) GetAwsMsk() *IngestionDataSourceSettings_AwsMskfunc (*IngestionDataSourceSettings) GetAzureEventHubs
func (x *IngestionDataSourceSettings) GetAzureEventHubs() *IngestionDataSourceSettings_AzureEventHubsfunc (*IngestionDataSourceSettings) GetCloudStorage
func (x *IngestionDataSourceSettings) GetCloudStorage() *IngestionDataSourceSettings_CloudStoragefunc (*IngestionDataSourceSettings) GetConfluentCloud
func (x *IngestionDataSourceSettings) GetConfluentCloud() *IngestionDataSourceSettings_ConfluentCloudfunc (*IngestionDataSourceSettings) GetPlatformLogsSettings
func (x *IngestionDataSourceSettings) GetPlatformLogsSettings() *PlatformLogsSettingsfunc (*IngestionDataSourceSettings) GetSource
func (x *IngestionDataSourceSettings) GetSource() isIngestionDataSourceSettings_Sourcefunc (*IngestionDataSourceSettings) ProtoMessage
func (*IngestionDataSourceSettings) ProtoMessage()func (*IngestionDataSourceSettings) ProtoReflect
func (x *IngestionDataSourceSettings) ProtoReflect() protoreflect.Messagefunc (*IngestionDataSourceSettings) Reset
func (x *IngestionDataSourceSettings) Reset()func (*IngestionDataSourceSettings) String
func (x *IngestionDataSourceSettings) String() stringIngestionDataSourceSettings_AwsKinesis
type IngestionDataSourceSettings_AwsKinesis struct {
// Output only. An output-only field that indicates the state of the Kinesis
// ingestion source.
State IngestionDataSourceSettings_AwsKinesis_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.pubsub.v1.IngestionDataSourceSettings_AwsKinesis_State" json:"state,omitempty"`
// Required. The Kinesis stream ARN to ingest data from.
StreamArn string `protobuf:"bytes,2,opt,name=stream_arn,json=streamArn,proto3" json:"stream_arn,omitempty"`
// Required. The Kinesis consumer ARN to used for ingestion in Enhanced
// Fan-Out mode. The consumer must be already created and ready to be used.
ConsumerArn string `protobuf:"bytes,3,opt,name=consumer_arn,json=consumerArn,proto3" json:"consumer_arn,omitempty"`
// Required. AWS role ARN to be used for Federated Identity authentication
// with Kinesis. Check the Pub/Sub docs for how to set up this role and the
// required permissions that need to be attached to it.
AwsRoleArn string `protobuf:"bytes,4,opt,name=aws_role_arn,json=awsRoleArn,proto3" json:"aws_role_arn,omitempty"`
// Required. The GCP service account to be used for Federated Identity
// authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
// the provided role). The `aws_role_arn` must be set up with
// `accounts.google.com:sub` equals to this service account number.
GcpServiceAccount string `protobuf:"bytes,5,opt,name=gcp_service_account,json=gcpServiceAccount,proto3" json:"gcp_service_account,omitempty"`
// contains filtered or unexported fields
}Ingestion settings for Amazon Kinesis Data Streams.
func (*IngestionDataSourceSettings_AwsKinesis) Descriptor
func (*IngestionDataSourceSettings_AwsKinesis) Descriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_AwsKinesis.ProtoReflect.Descriptor instead.
func (*IngestionDataSourceSettings_AwsKinesis) GetAwsRoleArn
func (x *IngestionDataSourceSettings_AwsKinesis) GetAwsRoleArn() stringfunc (*IngestionDataSourceSettings_AwsKinesis) GetConsumerArn
func (x *IngestionDataSourceSettings_AwsKinesis) GetConsumerArn() stringfunc (*IngestionDataSourceSettings_AwsKinesis) GetGcpServiceAccount
func (x *IngestionDataSourceSettings_AwsKinesis) GetGcpServiceAccount() stringfunc (*IngestionDataSourceSettings_AwsKinesis) GetState
func (x *IngestionDataSourceSettings_AwsKinesis) GetState() IngestionDataSourceSettings_AwsKinesis_Statefunc (*IngestionDataSourceSettings_AwsKinesis) GetStreamArn
func (x *IngestionDataSourceSettings_AwsKinesis) GetStreamArn() stringfunc (*IngestionDataSourceSettings_AwsKinesis) ProtoMessage
func (*IngestionDataSourceSettings_AwsKinesis) ProtoMessage()func (*IngestionDataSourceSettings_AwsKinesis) ProtoReflect
func (x *IngestionDataSourceSettings_AwsKinesis) ProtoReflect() protoreflect.Messagefunc (*IngestionDataSourceSettings_AwsKinesis) Reset
func (x *IngestionDataSourceSettings_AwsKinesis) Reset()func (*IngestionDataSourceSettings_AwsKinesis) String
func (x *IngestionDataSourceSettings_AwsKinesis) String() stringIngestionDataSourceSettings_AwsKinesis_
type IngestionDataSourceSettings_AwsKinesis_ struct {
// Optional. Amazon Kinesis Data Streams.
AwsKinesis *IngestionDataSourceSettings_AwsKinesis `protobuf:"bytes,1,opt,name=aws_kinesis,json=awsKinesis,proto3,oneof"`
}IngestionDataSourceSettings_AwsKinesis_State
type IngestionDataSourceSettings_AwsKinesis_State int32Possible states for ingestion from Amazon Kinesis Data Streams.
IngestionDataSourceSettings_AwsKinesis_STATE_UNSPECIFIED, IngestionDataSourceSettings_AwsKinesis_ACTIVE, IngestionDataSourceSettings_AwsKinesis_KINESIS_PERMISSION_DENIED, IngestionDataSourceSettings_AwsKinesis_PUBLISH_PERMISSION_DENIED, IngestionDataSourceSettings_AwsKinesis_STREAM_NOT_FOUND, IngestionDataSourceSettings_AwsKinesis_CONSUMER_NOT_FOUND, IngestionDataSourceSettings_AwsKinesis_CONFLICTING_REGION_CONSTRAINTS
const (
// Default value. This value is unused.
IngestionDataSourceSettings_AwsKinesis_STATE_UNSPECIFIED IngestionDataSourceSettings_AwsKinesis_State = 0
// Ingestion is active.
IngestionDataSourceSettings_AwsKinesis_ACTIVE IngestionDataSourceSettings_AwsKinesis_State = 1
// Permission denied encountered while consuming data from Kinesis.
// This can happen if:
// - The provided `aws_role_arn` does not exist or does not have the
// appropriate permissions attached.
// - The provided `aws_role_arn` is not set up properly for Identity
// Federation using `gcp_service_account`.
// - The Pub/Sub SA is not granted the
// `iam.serviceAccounts.getOpenIdToken` permission on
// `gcp_service_account`.
IngestionDataSourceSettings_AwsKinesis_KINESIS_PERMISSION_DENIED IngestionDataSourceSettings_AwsKinesis_State = 2
// Permission denied encountered while publishing to the topic. This can
// happen if the Pub/Sub SA has not been granted the [appropriate publish
// permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
IngestionDataSourceSettings_AwsKinesis_PUBLISH_PERMISSION_DENIED IngestionDataSourceSettings_AwsKinesis_State = 3
// The Kinesis stream does not exist.
IngestionDataSourceSettings_AwsKinesis_STREAM_NOT_FOUND IngestionDataSourceSettings_AwsKinesis_State = 4
// The Kinesis consumer does not exist.
IngestionDataSourceSettings_AwsKinesis_CONSUMER_NOT_FOUND IngestionDataSourceSettings_AwsKinesis_State = 5
// Indicates an error state where the ingestion source cannot be
// processed because the selected ingestion region is not permitted
// by the Regional Access Boundary (RAB) restrictions on the project's
// service account.
IngestionDataSourceSettings_AwsKinesis_CONFLICTING_REGION_CONSTRAINTS IngestionDataSourceSettings_AwsKinesis_State = 6
)func (IngestionDataSourceSettings_AwsKinesis_State) Descriptor
func (IngestionDataSourceSettings_AwsKinesis_State) Descriptor() protoreflect.EnumDescriptorfunc (IngestionDataSourceSettings_AwsKinesis_State) Enum
func (x IngestionDataSourceSettings_AwsKinesis_State) Enum() *IngestionDataSourceSettings_AwsKinesis_Statefunc (IngestionDataSourceSettings_AwsKinesis_State) EnumDescriptor
func (IngestionDataSourceSettings_AwsKinesis_State) EnumDescriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_AwsKinesis_State.Descriptor instead.
func (IngestionDataSourceSettings_AwsKinesis_State) Number
func (x IngestionDataSourceSettings_AwsKinesis_State) Number() protoreflect.EnumNumberfunc (IngestionDataSourceSettings_AwsKinesis_State) String
func (x IngestionDataSourceSettings_AwsKinesis_State) String() stringfunc (IngestionDataSourceSettings_AwsKinesis_State) Type
func (IngestionDataSourceSettings_AwsKinesis_State) Type() protoreflect.EnumTypeIngestionDataSourceSettings_AwsMsk
type IngestionDataSourceSettings_AwsMsk struct {
// Output only. An output-only field that indicates the state of the Amazon
// MSK ingestion source.
State IngestionDataSourceSettings_AwsMsk_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.pubsub.v1.IngestionDataSourceSettings_AwsMsk_State" json:"state,omitempty"`
// Required. The Amazon Resource Name (ARN) that uniquely identifies the
// cluster.
ClusterArn string `protobuf:"bytes,2,opt,name=cluster_arn,json=clusterArn,proto3" json:"cluster_arn,omitempty"`
// Required. The name of the topic in the Amazon MSK cluster that Pub/Sub
// will import from.
Topic string `protobuf:"bytes,3,opt,name=topic,proto3" json:"topic,omitempty"`
// Required. AWS role ARN to be used for Federated Identity authentication
// with Amazon MSK. Check the Pub/Sub docs for how to set up this role and
// the required permissions that need to be attached to it.
AwsRoleArn string `protobuf:"bytes,4,opt,name=aws_role_arn,json=awsRoleArn,proto3" json:"aws_role_arn,omitempty"`
// Required. The GCP service account to be used for Federated Identity
// authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call
// for the provided role). The `aws_role_arn` must be set up with
// `accounts.google.com:sub` equals to this service account number.
GcpServiceAccount string `protobuf:"bytes,5,opt,name=gcp_service_account,json=gcpServiceAccount,proto3" json:"gcp_service_account,omitempty"`
// contains filtered or unexported fields
}Ingestion settings for Amazon MSK.
func (*IngestionDataSourceSettings_AwsMsk) Descriptor
func (*IngestionDataSourceSettings_AwsMsk) Descriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_AwsMsk.ProtoReflect.Descriptor instead.
func (*IngestionDataSourceSettings_AwsMsk) GetAwsRoleArn
func (x *IngestionDataSourceSettings_AwsMsk) GetAwsRoleArn() stringfunc (*IngestionDataSourceSettings_AwsMsk) GetClusterArn
func (x *IngestionDataSourceSettings_AwsMsk) GetClusterArn() stringfunc (*IngestionDataSourceSettings_AwsMsk) GetGcpServiceAccount
func (x *IngestionDataSourceSettings_AwsMsk) GetGcpServiceAccount() stringfunc (*IngestionDataSourceSettings_AwsMsk) GetState
func (x *IngestionDataSourceSettings_AwsMsk) GetState() IngestionDataSourceSettings_AwsMsk_Statefunc (*IngestionDataSourceSettings_AwsMsk) GetTopic
func (x *IngestionDataSourceSettings_AwsMsk) GetTopic() stringfunc (*IngestionDataSourceSettings_AwsMsk) ProtoMessage
func (*IngestionDataSourceSettings_AwsMsk) ProtoMessage()func (*IngestionDataSourceSettings_AwsMsk) ProtoReflect
func (x *IngestionDataSourceSettings_AwsMsk) ProtoReflect() protoreflect.Messagefunc (*IngestionDataSourceSettings_AwsMsk) Reset
func (x *IngestionDataSourceSettings_AwsMsk) Reset()func (*IngestionDataSourceSettings_AwsMsk) String
func (x *IngestionDataSourceSettings_AwsMsk) String() stringIngestionDataSourceSettings_AwsMsk_
type IngestionDataSourceSettings_AwsMsk_ struct {
// Optional. Amazon MSK.
AwsMsk *IngestionDataSourceSettings_AwsMsk `protobuf:"bytes,5,opt,name=aws_msk,json=awsMsk,proto3,oneof"`
}IngestionDataSourceSettings_AwsMsk_State
type IngestionDataSourceSettings_AwsMsk_State int32Possible states for managed ingestion from Amazon MSK.
IngestionDataSourceSettings_AwsMsk_STATE_UNSPECIFIED, IngestionDataSourceSettings_AwsMsk_ACTIVE, IngestionDataSourceSettings_AwsMsk_MSK_PERMISSION_DENIED, IngestionDataSourceSettings_AwsMsk_PUBLISH_PERMISSION_DENIED, IngestionDataSourceSettings_AwsMsk_CLUSTER_NOT_FOUND, IngestionDataSourceSettings_AwsMsk_TOPIC_NOT_FOUND, IngestionDataSourceSettings_AwsMsk_CONFLICTING_REGION_CONSTRAINTS
const (
// Default value. This value is unused.
IngestionDataSourceSettings_AwsMsk_STATE_UNSPECIFIED IngestionDataSourceSettings_AwsMsk_State = 0
// Ingestion is active.
IngestionDataSourceSettings_AwsMsk_ACTIVE IngestionDataSourceSettings_AwsMsk_State = 1
// Permission denied encountered while consuming data from Amazon MSK.
IngestionDataSourceSettings_AwsMsk_MSK_PERMISSION_DENIED IngestionDataSourceSettings_AwsMsk_State = 2
// Permission denied encountered while publishing to the topic.
IngestionDataSourceSettings_AwsMsk_PUBLISH_PERMISSION_DENIED IngestionDataSourceSettings_AwsMsk_State = 3
// The provided MSK cluster wasn't found.
IngestionDataSourceSettings_AwsMsk_CLUSTER_NOT_FOUND IngestionDataSourceSettings_AwsMsk_State = 4
// The provided topic wasn't found.
IngestionDataSourceSettings_AwsMsk_TOPIC_NOT_FOUND IngestionDataSourceSettings_AwsMsk_State = 5
// Indicates an error state where the ingestion source cannot be
// processed because the selected ingestion region is not permitted
// by the Regional Access Boundary (RAB) restrictions on the project's
// service account.
IngestionDataSourceSettings_AwsMsk_CONFLICTING_REGION_CONSTRAINTS IngestionDataSourceSettings_AwsMsk_State = 6
)func (IngestionDataSourceSettings_AwsMsk_State) Descriptor
func (IngestionDataSourceSettings_AwsMsk_State) Descriptor() protoreflect.EnumDescriptorfunc (IngestionDataSourceSettings_AwsMsk_State) Enum
func (IngestionDataSourceSettings_AwsMsk_State) EnumDescriptor
func (IngestionDataSourceSettings_AwsMsk_State) EnumDescriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_AwsMsk_State.Descriptor instead.
func (IngestionDataSourceSettings_AwsMsk_State) Number
func (x IngestionDataSourceSettings_AwsMsk_State) Number() protoreflect.EnumNumberfunc (IngestionDataSourceSettings_AwsMsk_State) String
func (x IngestionDataSourceSettings_AwsMsk_State) String() stringfunc (IngestionDataSourceSettings_AwsMsk_State) Type
func (IngestionDataSourceSettings_AwsMsk_State) Type() protoreflect.EnumTypeIngestionDataSourceSettings_AzureEventHubs
type IngestionDataSourceSettings_AzureEventHubs struct {
// Output only. An output-only field that indicates the state of the Event
// Hubs ingestion source.
State IngestionDataSourceSettings_AzureEventHubs_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.pubsub.v1.IngestionDataSourceSettings_AzureEventHubs_State" json:"state,omitempty"`
// Optional. Name of the resource group within the azure subscription.
ResourceGroup string `protobuf:"bytes,2,opt,name=resource_group,json=resourceGroup,proto3" json:"resource_group,omitempty"`
// Optional. The name of the Event Hubs namespace.
Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
// Optional. The name of the Event Hub.
EventHub string `protobuf:"bytes,4,opt,name=event_hub,json=eventHub,proto3" json:"event_hub,omitempty"`
// Optional. The client id of the Azure application that is being used to
// authenticate Pub/Sub.
ClientId string `protobuf:"bytes,5,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
// Optional. The tenant id of the Azure application that is being used to
// authenticate Pub/Sub.
TenantId string `protobuf:"bytes,6,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
// Optional. The Azure subscription id.
SubscriptionId string `protobuf:"bytes,7,opt,name=subscription_id,json=subscriptionId,proto3" json:"subscription_id,omitempty"`
// Optional. The GCP service account to be used for Federated Identity
// authentication.
GcpServiceAccount string `protobuf:"bytes,8,opt,name=gcp_service_account,json=gcpServiceAccount,proto3" json:"gcp_service_account,omitempty"`
// contains filtered or unexported fields
}Ingestion settings for Azure Event Hubs.
func (*IngestionDataSourceSettings_AzureEventHubs) Descriptor
func (*IngestionDataSourceSettings_AzureEventHubs) Descriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_AzureEventHubs.ProtoReflect.Descriptor instead.
func (*IngestionDataSourceSettings_AzureEventHubs) GetClientId
func (x *IngestionDataSourceSettings_AzureEventHubs) GetClientId() stringfunc (*IngestionDataSourceSettings_AzureEventHubs) GetEventHub
func (x *IngestionDataSourceSettings_AzureEventHubs) GetEventHub() stringfunc (*IngestionDataSourceSettings_AzureEventHubs) GetGcpServiceAccount
func (x *IngestionDataSourceSettings_AzureEventHubs) GetGcpServiceAccount() stringfunc (*IngestionDataSourceSettings_AzureEventHubs) GetNamespace
func (x *IngestionDataSourceSettings_AzureEventHubs) GetNamespace() stringfunc (*IngestionDataSourceSettings_AzureEventHubs) GetResourceGroup
func (x *IngestionDataSourceSettings_AzureEventHubs) GetResourceGroup() stringfunc (*IngestionDataSourceSettings_AzureEventHubs) GetState
func (x *IngestionDataSourceSettings_AzureEventHubs) GetState() IngestionDataSourceSettings_AzureEventHubs_Statefunc (*IngestionDataSourceSettings_AzureEventHubs) GetSubscriptionId
func (x *IngestionDataSourceSettings_AzureEventHubs) GetSubscriptionId() stringfunc (*IngestionDataSourceSettings_AzureEventHubs) GetTenantId
func (x *IngestionDataSourceSettings_AzureEventHubs) GetTenantId() stringfunc (*IngestionDataSourceSettings_AzureEventHubs) ProtoMessage
func (*IngestionDataSourceSettings_AzureEventHubs) ProtoMessage()func (*IngestionDataSourceSettings_AzureEventHubs) ProtoReflect
func (x *IngestionDataSourceSettings_AzureEventHubs) ProtoReflect() protoreflect.Messagefunc (*IngestionDataSourceSettings_AzureEventHubs) Reset
func (x *IngestionDataSourceSettings_AzureEventHubs) Reset()func (*IngestionDataSourceSettings_AzureEventHubs) String
func (x *IngestionDataSourceSettings_AzureEventHubs) String() stringIngestionDataSourceSettings_AzureEventHubs_
type IngestionDataSourceSettings_AzureEventHubs_ struct {
// Optional. Azure Event Hubs.
AzureEventHubs *IngestionDataSourceSettings_AzureEventHubs `protobuf:"bytes,3,opt,name=azure_event_hubs,json=azureEventHubs,proto3,oneof"`
}IngestionDataSourceSettings_AzureEventHubs_State
type IngestionDataSourceSettings_AzureEventHubs_State int32Possible states for managed ingestion from Event Hubs.
IngestionDataSourceSettings_AzureEventHubs_STATE_UNSPECIFIED, IngestionDataSourceSettings_AzureEventHubs_ACTIVE, IngestionDataSourceSettings_AzureEventHubs_EVENT_HUBS_PERMISSION_DENIED, IngestionDataSourceSettings_AzureEventHubs_PUBLISH_PERMISSION_DENIED, IngestionDataSourceSettings_AzureEventHubs_NAMESPACE_NOT_FOUND, IngestionDataSourceSettings_AzureEventHubs_EVENT_HUB_NOT_FOUND, IngestionDataSourceSettings_AzureEventHubs_SUBSCRIPTION_NOT_FOUND, IngestionDataSourceSettings_AzureEventHubs_RESOURCE_GROUP_NOT_FOUND, IngestionDataSourceSettings_AzureEventHubs_CONFLICTING_REGION_CONSTRAINTS
const (
// Default value. This value is unused.
IngestionDataSourceSettings_AzureEventHubs_STATE_UNSPECIFIED IngestionDataSourceSettings_AzureEventHubs_State = 0
// Ingestion is active.
IngestionDataSourceSettings_AzureEventHubs_ACTIVE IngestionDataSourceSettings_AzureEventHubs_State = 1
// Permission denied encountered while consuming data from Event Hubs.
// This can happen when `client_id`, or `tenant_id` are invalid. Or the
// right permissions haven't been granted.
IngestionDataSourceSettings_AzureEventHubs_EVENT_HUBS_PERMISSION_DENIED IngestionDataSourceSettings_AzureEventHubs_State = 2
// Permission denied encountered while publishing to the topic.
IngestionDataSourceSettings_AzureEventHubs_PUBLISH_PERMISSION_DENIED IngestionDataSourceSettings_AzureEventHubs_State = 3
// The provided Event Hubs namespace couldn't be found.
IngestionDataSourceSettings_AzureEventHubs_NAMESPACE_NOT_FOUND IngestionDataSourceSettings_AzureEventHubs_State = 4
// The provided Event Hub couldn't be found.
IngestionDataSourceSettings_AzureEventHubs_EVENT_HUB_NOT_FOUND IngestionDataSourceSettings_AzureEventHubs_State = 5
// The provided Event Hubs subscription couldn't be found.
IngestionDataSourceSettings_AzureEventHubs_SUBSCRIPTION_NOT_FOUND IngestionDataSourceSettings_AzureEventHubs_State = 6
// The provided Event Hubs resource group couldn't be found.
IngestionDataSourceSettings_AzureEventHubs_RESOURCE_GROUP_NOT_FOUND IngestionDataSourceSettings_AzureEventHubs_State = 7
// Indicates an error state where the ingestion source cannot be
// processed because the selected ingestion region is not permitted
// by the Regional Access Boundary (RAB) restrictions on the project's
// service account.
IngestionDataSourceSettings_AzureEventHubs_CONFLICTING_REGION_CONSTRAINTS IngestionDataSourceSettings_AzureEventHubs_State = 8
)func (IngestionDataSourceSettings_AzureEventHubs_State) Descriptor
func (IngestionDataSourceSettings_AzureEventHubs_State) Descriptor() protoreflect.EnumDescriptorfunc (IngestionDataSourceSettings_AzureEventHubs_State) Enum
func (x IngestionDataSourceSettings_AzureEventHubs_State) Enum() *IngestionDataSourceSettings_AzureEventHubs_Statefunc (IngestionDataSourceSettings_AzureEventHubs_State) EnumDescriptor
func (IngestionDataSourceSettings_AzureEventHubs_State) EnumDescriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_AzureEventHubs_State.Descriptor instead.
func (IngestionDataSourceSettings_AzureEventHubs_State) Number
func (x IngestionDataSourceSettings_AzureEventHubs_State) Number() protoreflect.EnumNumberfunc (IngestionDataSourceSettings_AzureEventHubs_State) String
func (x IngestionDataSourceSettings_AzureEventHubs_State) String() stringfunc (IngestionDataSourceSettings_AzureEventHubs_State) Type
IngestionDataSourceSettings_CloudStorage
type IngestionDataSourceSettings_CloudStorage struct {
// Output only. An output-only field that indicates the state of the Cloud
// Storage ingestion source.
State IngestionDataSourceSettings_CloudStorage_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.pubsub.v1.IngestionDataSourceSettings_CloudStorage_State" json:"state,omitempty"`
// Optional. Cloud Storage bucket. 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,2,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Defaults to text format.
//
// Types that are valid to be assigned to InputFormat:
//
// *IngestionDataSourceSettings_CloudStorage_TextFormat_
// *IngestionDataSourceSettings_CloudStorage_AvroFormat_
// *IngestionDataSourceSettings_CloudStorage_PubsubAvroFormat
InputFormat isIngestionDataSourceSettings_CloudStorage_InputFormat `protobuf_oneof:"input_format"`
// Optional. Only objects with a larger or equal creation timestamp will be
// ingested.
MinimumObjectCreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=minimum_object_create_time,json=minimumObjectCreateTime,proto3" json:"minimum_object_create_time,omitempty"`
// Optional. Glob pattern used to match objects that will be ingested. If
// unset, all objects will be ingested. See the [supported
// patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).
MatchGlob string `protobuf:"bytes,9,opt,name=match_glob,json=matchGlob,proto3" json:"match_glob,omitempty"`
// contains filtered or unexported fields
}Ingestion settings for Cloud Storage.
func (*IngestionDataSourceSettings_CloudStorage) Descriptor
func (*IngestionDataSourceSettings_CloudStorage) Descriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_CloudStorage.ProtoReflect.Descriptor instead.
func (*IngestionDataSourceSettings_CloudStorage) GetAvroFormat
func (x *IngestionDataSourceSettings_CloudStorage) GetAvroFormat() *IngestionDataSourceSettings_CloudStorage_AvroFormatfunc (*IngestionDataSourceSettings_CloudStorage) GetBucket
func (x *IngestionDataSourceSettings_CloudStorage) GetBucket() stringfunc (*IngestionDataSourceSettings_CloudStorage) GetInputFormat
func (x *IngestionDataSourceSettings_CloudStorage) GetInputFormat() isIngestionDataSourceSettings_CloudStorage_InputFormatfunc (*IngestionDataSourceSettings_CloudStorage) GetMatchGlob
func (x *IngestionDataSourceSettings_CloudStorage) GetMatchGlob() stringfunc (*IngestionDataSourceSettings_CloudStorage) GetMinimumObjectCreateTime
func (x *IngestionDataSourceSettings_CloudStorage) GetMinimumObjectCreateTime() *timestamppb.Timestampfunc (*IngestionDataSourceSettings_CloudStorage) GetPubsubAvroFormat
func (x *IngestionDataSourceSettings_CloudStorage) GetPubsubAvroFormat() *IngestionDataSourceSettings_CloudStorage_PubSubAvroFormatfunc (*IngestionDataSourceSettings_CloudStorage) GetState
func (x *IngestionDataSourceSettings_CloudStorage) GetState() IngestionDataSourceSettings_CloudStorage_Statefunc (*IngestionDataSourceSettings_CloudStorage) GetTextFormat
func (x *IngestionDataSourceSettings_CloudStorage) GetTextFormat() *IngestionDataSourceSettings_CloudStorage_TextFormatfunc (*IngestionDataSourceSettings_CloudStorage) ProtoMessage
func (*IngestionDataSourceSettings_CloudStorage) ProtoMessage()func (*IngestionDataSourceSettings_CloudStorage) ProtoReflect
func (x *IngestionDataSourceSettings_CloudStorage) ProtoReflect() protoreflect.Messagefunc (*IngestionDataSourceSettings_CloudStorage) Reset
func (x *IngestionDataSourceSettings_CloudStorage) Reset()func (*IngestionDataSourceSettings_CloudStorage) String
func (x *IngestionDataSourceSettings_CloudStorage) String() stringIngestionDataSourceSettings_CloudStorage_
type IngestionDataSourceSettings_CloudStorage_ struct {
// Optional. Cloud Storage.
CloudStorage *IngestionDataSourceSettings_CloudStorage `protobuf:"bytes,2,opt,name=cloud_storage,json=cloudStorage,proto3,oneof"`
}IngestionDataSourceSettings_CloudStorage_AvroFormat
type IngestionDataSourceSettings_CloudStorage_AvroFormat struct {
// contains filtered or unexported fields
}Configuration for reading Cloud Storage data in Avro binary format. The
bytes of each object will be set to the data field of a Pub/Sub
message.
func (*IngestionDataSourceSettings_CloudStorage_AvroFormat) Descriptor
func (*IngestionDataSourceSettings_CloudStorage_AvroFormat) Descriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_CloudStorage_AvroFormat.ProtoReflect.Descriptor instead.
func (*IngestionDataSourceSettings_CloudStorage_AvroFormat) ProtoMessage
func (*IngestionDataSourceSettings_CloudStorage_AvroFormat) ProtoMessage()func (*IngestionDataSourceSettings_CloudStorage_AvroFormat) ProtoReflect
func (x *IngestionDataSourceSettings_CloudStorage_AvroFormat) ProtoReflect() protoreflect.Messagefunc (*IngestionDataSourceSettings_CloudStorage_AvroFormat) Reset
func (x *IngestionDataSourceSettings_CloudStorage_AvroFormat) Reset()func (*IngestionDataSourceSettings_CloudStorage_AvroFormat) String
func (x *IngestionDataSourceSettings_CloudStorage_AvroFormat) String() stringIngestionDataSourceSettings_CloudStorage_AvroFormat_
type IngestionDataSourceSettings_CloudStorage_AvroFormat_ struct {
// Optional. Data from Cloud Storage will be interpreted in Avro format.
AvroFormat *IngestionDataSourceSettings_CloudStorage_AvroFormat `protobuf:"bytes,4,opt,name=avro_format,json=avroFormat,proto3,oneof"`
}IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat
type IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat struct {
// contains filtered or unexported fields
}Configuration for reading Cloud Storage data written via Cloud Storage subscriptions. The data and attributes fields of the originally exported Pub/Sub message will be restored when publishing.
func (*IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) Descriptor
func (*IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) Descriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat.ProtoReflect.Descriptor instead.
func (*IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) ProtoMessage
func (*IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) ProtoMessage()func (*IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) ProtoReflect
func (x *IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) ProtoReflect() protoreflect.Messagefunc (*IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) Reset
func (x *IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) Reset()func (*IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) String
func (x *IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat) String() stringIngestionDataSourceSettings_CloudStorage_PubsubAvroFormat
type IngestionDataSourceSettings_CloudStorage_PubsubAvroFormat struct {
// Optional. It will be assumed data from Cloud Storage was written via
// [Cloud Storage
// subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
PubsubAvroFormat *IngestionDataSourceSettings_CloudStorage_PubSubAvroFormat `protobuf:"bytes,5,opt,name=pubsub_avro_format,json=pubsubAvroFormat,proto3,oneof"`
}IngestionDataSourceSettings_CloudStorage_State
type IngestionDataSourceSettings_CloudStorage_State int32Possible states for ingestion from Cloud Storage.
IngestionDataSourceSettings_CloudStorage_STATE_UNSPECIFIED, IngestionDataSourceSettings_CloudStorage_ACTIVE, IngestionDataSourceSettings_CloudStorage_CLOUD_STORAGE_PERMISSION_DENIED, IngestionDataSourceSettings_CloudStorage_PUBLISH_PERMISSION_DENIED, IngestionDataSourceSettings_CloudStorage_BUCKET_NOT_FOUND, IngestionDataSourceSettings_CloudStorage_TOO_MANY_OBJECTS, IngestionDataSourceSettings_CloudStorage_CONFLICTING_REGION_CONSTRAINTS
const (
// Default value. This value is unused.
IngestionDataSourceSettings_CloudStorage_STATE_UNSPECIFIED IngestionDataSourceSettings_CloudStorage_State = 0
// Ingestion is active.
IngestionDataSourceSettings_CloudStorage_ACTIVE IngestionDataSourceSettings_CloudStorage_State = 1
// Permission denied encountered while calling the Cloud Storage API. This
// can happen if the Pub/Sub SA has not been granted the
// [appropriate
// permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions):
// - storage.objects.list: to list the objects in a bucket.
// - storage.objects.get: to read the objects in a bucket.
// - storage.buckets.get: to verify the bucket exists.
IngestionDataSourceSettings_CloudStorage_CLOUD_STORAGE_PERMISSION_DENIED IngestionDataSourceSettings_CloudStorage_State = 2
// Permission denied encountered while publishing to the topic. This can
// happen if the Pub/Sub SA has not been granted the [appropriate publish
// permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
IngestionDataSourceSettings_CloudStorage_PUBLISH_PERMISSION_DENIED IngestionDataSourceSettings_CloudStorage_State = 3
// The provided Cloud Storage bucket doesn't exist.
IngestionDataSourceSettings_CloudStorage_BUCKET_NOT_FOUND IngestionDataSourceSettings_CloudStorage_State = 4
// The Cloud Storage bucket has too many objects, ingestion will be
// paused.
IngestionDataSourceSettings_CloudStorage_TOO_MANY_OBJECTS IngestionDataSourceSettings_CloudStorage_State = 5
// Indicates an error state where the ingestion source cannot be
// processed because the selected ingestion region is not permitted
// by the Regional Access Boundary (RAB) restrictions on the project's
// service account.
IngestionDataSourceSettings_CloudStorage_CONFLICTING_REGION_CONSTRAINTS IngestionDataSourceSettings_CloudStorage_State = 8
)func (IngestionDataSourceSettings_CloudStorage_State) Descriptor
func (IngestionDataSourceSettings_CloudStorage_State) Descriptor() protoreflect.EnumDescriptorfunc (IngestionDataSourceSettings_CloudStorage_State) Enum
func (x IngestionDataSourceSettings_CloudStorage_State) Enum() *IngestionDataSourceSettings_CloudStorage_Statefunc (IngestionDataSourceSettings_CloudStorage_State) EnumDescriptor
func (IngestionDataSourceSettings_CloudStorage_State) EnumDescriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_CloudStorage_State.Descriptor instead.
func (IngestionDataSourceSettings_CloudStorage_State) Number
func (x IngestionDataSourceSettings_CloudStorage_State) Number() protoreflect.EnumNumberfunc (IngestionDataSourceSettings_CloudStorage_State) String
func (x IngestionDataSourceSettings_CloudStorage_State) String() stringfunc (IngestionDataSourceSettings_CloudStorage_State) Type
IngestionDataSourceSettings_CloudStorage_TextFormat
type IngestionDataSourceSettings_CloudStorage_TextFormat struct {
// Optional. When unset, '\n' is used.
Delimiter *string `protobuf:"bytes,1,opt,name=delimiter,proto3,oneof" json:"delimiter,omitempty"`
// contains filtered or unexported fields
}Configuration for reading Cloud Storage data in text format. Each line of
text as specified by the delimiter will be set to the data field of a
Pub/Sub message.
func (*IngestionDataSourceSettings_CloudStorage_TextFormat) Descriptor
func (*IngestionDataSourceSettings_CloudStorage_TextFormat) Descriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_CloudStorage_TextFormat.ProtoReflect.Descriptor instead.
func (*IngestionDataSourceSettings_CloudStorage_TextFormat) GetDelimiter
func (x *IngestionDataSourceSettings_CloudStorage_TextFormat) GetDelimiter() stringfunc (*IngestionDataSourceSettings_CloudStorage_TextFormat) ProtoMessage
func (*IngestionDataSourceSettings_CloudStorage_TextFormat) ProtoMessage()func (*IngestionDataSourceSettings_CloudStorage_TextFormat) ProtoReflect
func (x *IngestionDataSourceSettings_CloudStorage_TextFormat) ProtoReflect() protoreflect.Messagefunc (*IngestionDataSourceSettings_CloudStorage_TextFormat) Reset
func (x *IngestionDataSourceSettings_CloudStorage_TextFormat) Reset()func (*IngestionDataSourceSettings_CloudStorage_TextFormat) String
func (x *IngestionDataSourceSettings_CloudStorage_TextFormat) String() stringIngestionDataSourceSettings_CloudStorage_TextFormat_
type IngestionDataSourceSettings_CloudStorage_TextFormat_ struct {
// Optional. Data from Cloud Storage will be interpreted as text.
TextFormat *IngestionDataSourceSettings_CloudStorage_TextFormat `protobuf:"bytes,3,opt,name=text_format,json=textFormat,proto3,oneof"`
}IngestionDataSourceSettings_ConfluentCloud
type IngestionDataSourceSettings_ConfluentCloud struct {
// Output only. An output-only field that indicates the state of the
// Confluent Cloud ingestion source.
State IngestionDataSourceSettings_ConfluentCloud_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.pubsub.v1.IngestionDataSourceSettings_ConfluentCloud_State" json:"state,omitempty"`
// Required. The address of the bootstrap server. The format is url:port.
BootstrapServer string `protobuf:"bytes,2,opt,name=bootstrap_server,json=bootstrapServer,proto3" json:"bootstrap_server,omitempty"`
// Required. The id of the cluster.
ClusterId string `protobuf:"bytes,3,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
// Required. The name of the topic in the Confluent Cloud cluster that
// Pub/Sub will import from.
Topic string `protobuf:"bytes,4,opt,name=topic,proto3" json:"topic,omitempty"`
// Required. The id of the identity pool to be used for Federated Identity
// authentication with Confluent Cloud. See
// https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
IdentityPoolId string `protobuf:"bytes,5,opt,name=identity_pool_id,json=identityPoolId,proto3" json:"identity_pool_id,omitempty"`
// Required. The GCP service account to be used for Federated Identity
// authentication with `identity_pool_id`.
GcpServiceAccount string `protobuf:"bytes,6,opt,name=gcp_service_account,json=gcpServiceAccount,proto3" json:"gcp_service_account,omitempty"`
// contains filtered or unexported fields
}Ingestion settings for Confluent Cloud.
func (*IngestionDataSourceSettings_ConfluentCloud) Descriptor
func (*IngestionDataSourceSettings_ConfluentCloud) Descriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_ConfluentCloud.ProtoReflect.Descriptor instead.
func (*IngestionDataSourceSettings_ConfluentCloud) GetBootstrapServer
func (x *IngestionDataSourceSettings_ConfluentCloud) GetBootstrapServer() stringfunc (*IngestionDataSourceSettings_ConfluentCloud) GetClusterId
func (x *IngestionDataSourceSettings_ConfluentCloud) GetClusterId() stringfunc (*IngestionDataSourceSettings_ConfluentCloud) GetGcpServiceAccount
func (x *IngestionDataSourceSettings_ConfluentCloud) GetGcpServiceAccount() stringfunc (*IngestionDataSourceSettings_ConfluentCloud) GetIdentityPoolId
func (x *IngestionDataSourceSettings_ConfluentCloud) GetIdentityPoolId() stringfunc (*IngestionDataSourceSettings_ConfluentCloud) GetState
func (x *IngestionDataSourceSettings_ConfluentCloud) GetState() IngestionDataSourceSettings_ConfluentCloud_Statefunc (*IngestionDataSourceSettings_ConfluentCloud) GetTopic
func (x *IngestionDataSourceSettings_ConfluentCloud) GetTopic() stringfunc (*IngestionDataSourceSettings_ConfluentCloud) ProtoMessage
func (*IngestionDataSourceSettings_ConfluentCloud) ProtoMessage()func (*IngestionDataSourceSettings_ConfluentCloud) ProtoReflect
func (x *IngestionDataSourceSettings_ConfluentCloud) ProtoReflect() protoreflect.Messagefunc (*IngestionDataSourceSettings_ConfluentCloud) Reset
func (x *IngestionDataSourceSettings_ConfluentCloud) Reset()func (*IngestionDataSourceSettings_ConfluentCloud) String
func (x *IngestionDataSourceSettings_ConfluentCloud) String() stringIngestionDataSourceSettings_ConfluentCloud_
type IngestionDataSourceSettings_ConfluentCloud_ struct {
// Optional. Confluent Cloud.
ConfluentCloud *IngestionDataSourceSettings_ConfluentCloud `protobuf:"bytes,6,opt,name=confluent_cloud,json=confluentCloud,proto3,oneof"`
}IngestionDataSourceSettings_ConfluentCloud_State
type IngestionDataSourceSettings_ConfluentCloud_State int32Possible states for managed ingestion from Confluent Cloud.
IngestionDataSourceSettings_ConfluentCloud_STATE_UNSPECIFIED, IngestionDataSourceSettings_ConfluentCloud_ACTIVE, IngestionDataSourceSettings_ConfluentCloud_CONFLUENT_CLOUD_PERMISSION_DENIED, IngestionDataSourceSettings_ConfluentCloud_PUBLISH_PERMISSION_DENIED, IngestionDataSourceSettings_ConfluentCloud_UNREACHABLE_BOOTSTRAP_SERVER, IngestionDataSourceSettings_ConfluentCloud_CLUSTER_NOT_FOUND, IngestionDataSourceSettings_ConfluentCloud_TOPIC_NOT_FOUND, IngestionDataSourceSettings_ConfluentCloud_CONFLICTING_REGION_CONSTRAINTS
const (
// Default value. This value is unused.
IngestionDataSourceSettings_ConfluentCloud_STATE_UNSPECIFIED IngestionDataSourceSettings_ConfluentCloud_State = 0
// Ingestion is active.
IngestionDataSourceSettings_ConfluentCloud_ACTIVE IngestionDataSourceSettings_ConfluentCloud_State = 1
// Permission denied encountered while consuming data from Confluent
// Cloud.
IngestionDataSourceSettings_ConfluentCloud_CONFLUENT_CLOUD_PERMISSION_DENIED IngestionDataSourceSettings_ConfluentCloud_State = 2
// Permission denied encountered while publishing to the topic.
IngestionDataSourceSettings_ConfluentCloud_PUBLISH_PERMISSION_DENIED IngestionDataSourceSettings_ConfluentCloud_State = 3
// The provided bootstrap server address is unreachable.
IngestionDataSourceSettings_ConfluentCloud_UNREACHABLE_BOOTSTRAP_SERVER IngestionDataSourceSettings_ConfluentCloud_State = 4
// The provided cluster wasn't found.
IngestionDataSourceSettings_ConfluentCloud_CLUSTER_NOT_FOUND IngestionDataSourceSettings_ConfluentCloud_State = 5
// The provided topic wasn't found.
IngestionDataSourceSettings_ConfluentCloud_TOPIC_NOT_FOUND IngestionDataSourceSettings_ConfluentCloud_State = 6
// Indicates an error state where the ingestion source cannot be
// processed because the selected ingestion region is not permitted
// by the Regional Access Boundary (RAB) restrictions on the project's
// service account.
IngestionDataSourceSettings_ConfluentCloud_CONFLICTING_REGION_CONSTRAINTS IngestionDataSourceSettings_ConfluentCloud_State = 7
)func (IngestionDataSourceSettings_ConfluentCloud_State) Descriptor
func (IngestionDataSourceSettings_ConfluentCloud_State) Descriptor() protoreflect.EnumDescriptorfunc (IngestionDataSourceSettings_ConfluentCloud_State) Enum
func (x IngestionDataSourceSettings_ConfluentCloud_State) Enum() *IngestionDataSourceSettings_ConfluentCloud_Statefunc (IngestionDataSourceSettings_ConfluentCloud_State) EnumDescriptor
func (IngestionDataSourceSettings_ConfluentCloud_State) EnumDescriptor() ([]byte, []int)Deprecated: Use IngestionDataSourceSettings_ConfluentCloud_State.Descriptor instead.
func (IngestionDataSourceSettings_ConfluentCloud_State) Number
func (x IngestionDataSourceSettings_ConfluentCloud_State) Number() protoreflect.EnumNumberfunc (IngestionDataSourceSettings_ConfluentCloud_State) String
func (x IngestionDataSourceSettings_ConfluentCloud_State) String() stringfunc (IngestionDataSourceSettings_ConfluentCloud_State) Type
IngestionFailureEvent
type IngestionFailureEvent struct {
// Required. Name of the import topic. Format is:
// projects/{project_name}/topics/{topic_name}.
Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
// Required. Error details explaining why ingestion to Pub/Sub has failed.
ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// Types that are valid to be assigned to Failure:
//
// *IngestionFailureEvent_CloudStorageFailure_
// *IngestionFailureEvent_AwsMskFailure
// *IngestionFailureEvent_AzureEventHubsFailure
// *IngestionFailureEvent_ConfluentCloudFailure
// *IngestionFailureEvent_AwsKinesisFailure
Failure isIngestionFailureEvent_Failure `protobuf_oneof:"failure"`
// contains filtered or unexported fields
}Payload of the Platform Log entry sent when a failure is encountered while ingesting.
func (*IngestionFailureEvent) Descriptor
func (*IngestionFailureEvent) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent) GetAwsKinesisFailure
func (x *IngestionFailureEvent) GetAwsKinesisFailure() *IngestionFailureEvent_AwsKinesisFailureReasonfunc (*IngestionFailureEvent) GetAwsMskFailure
func (x *IngestionFailureEvent) GetAwsMskFailure() *IngestionFailureEvent_AwsMskFailureReasonfunc (*IngestionFailureEvent) GetAzureEventHubsFailure
func (x *IngestionFailureEvent) GetAzureEventHubsFailure() *IngestionFailureEvent_AzureEventHubsFailureReasonfunc (*IngestionFailureEvent) GetCloudStorageFailure
func (x *IngestionFailureEvent) GetCloudStorageFailure() *IngestionFailureEvent_CloudStorageFailurefunc (*IngestionFailureEvent) GetConfluentCloudFailure
func (x *IngestionFailureEvent) GetConfluentCloudFailure() *IngestionFailureEvent_ConfluentCloudFailureReasonfunc (*IngestionFailureEvent) GetErrorMessage
func (x *IngestionFailureEvent) GetErrorMessage() stringfunc (*IngestionFailureEvent) GetFailure
func (x *IngestionFailureEvent) GetFailure() isIngestionFailureEvent_Failurefunc (*IngestionFailureEvent) GetTopic
func (x *IngestionFailureEvent) GetTopic() stringfunc (*IngestionFailureEvent) ProtoMessage
func (*IngestionFailureEvent) ProtoMessage()func (*IngestionFailureEvent) ProtoReflect
func (x *IngestionFailureEvent) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent) Reset
func (x *IngestionFailureEvent) Reset()func (*IngestionFailureEvent) String
func (x *IngestionFailureEvent) String() stringIngestionFailureEvent_ApiViolationReason
type IngestionFailureEvent_ApiViolationReason struct {
// contains filtered or unexported fields
}Specifies the reason why some data may have been left out of the desired Pub/Sub message due to the API message limits (https://cloud.google.com/pubsub/quotas#resource_limits). For example, when the number of attributes is larger than 100, the number of attributes is truncated to 100 to respect the limit on the attribute count. Other attribute limits are treated similarly. When the size of the desired message would've been larger than 10MB, the message won't be published at all, and ingestion of the subsequent messages will proceed as normal.
func (*IngestionFailureEvent_ApiViolationReason) Descriptor
func (*IngestionFailureEvent_ApiViolationReason) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent_ApiViolationReason.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent_ApiViolationReason) ProtoMessage
func (*IngestionFailureEvent_ApiViolationReason) ProtoMessage()func (*IngestionFailureEvent_ApiViolationReason) ProtoReflect
func (x *IngestionFailureEvent_ApiViolationReason) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent_ApiViolationReason) Reset
func (x *IngestionFailureEvent_ApiViolationReason) Reset()func (*IngestionFailureEvent_ApiViolationReason) String
func (x *IngestionFailureEvent_ApiViolationReason) String() stringIngestionFailureEvent_AvroFailureReason
type IngestionFailureEvent_AvroFailureReason struct {
// contains filtered or unexported fields
}Set when an Avro file is unsupported or its format is not valid. When this occurs, one or more Avro objects won't be ingested.
func (*IngestionFailureEvent_AvroFailureReason) Descriptor
func (*IngestionFailureEvent_AvroFailureReason) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent_AvroFailureReason.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent_AvroFailureReason) ProtoMessage
func (*IngestionFailureEvent_AvroFailureReason) ProtoMessage()func (*IngestionFailureEvent_AvroFailureReason) ProtoReflect
func (x *IngestionFailureEvent_AvroFailureReason) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent_AvroFailureReason) Reset
func (x *IngestionFailureEvent_AvroFailureReason) Reset()func (*IngestionFailureEvent_AvroFailureReason) String
func (x *IngestionFailureEvent_AvroFailureReason) String() stringIngestionFailureEvent_AwsKinesisFailure
type IngestionFailureEvent_AwsKinesisFailure struct {
// Optional. Failure when ingesting from AWS Kinesis.
AwsKinesisFailure *IngestionFailureEvent_AwsKinesisFailureReason `protobuf:"bytes,7,opt,name=aws_kinesis_failure,json=awsKinesisFailure,proto3,oneof"`
}IngestionFailureEvent_AwsKinesisFailureReason
type IngestionFailureEvent_AwsKinesisFailureReason struct {
// Optional. The stream ARN of the Kinesis stream being ingested from.
StreamArn string `protobuf:"bytes,1,opt,name=stream_arn,json=streamArn,proto3" json:"stream_arn,omitempty"`
// Optional. The partition key of the message that failed to be ingested.
PartitionKey string `protobuf:"bytes,2,opt,name=partition_key,json=partitionKey,proto3" json:"partition_key,omitempty"`
// Optional. The sequence number of the message that failed to be ingested.
SequenceNumber string `protobuf:"bytes,3,opt,name=sequence_number,json=sequenceNumber,proto3" json:"sequence_number,omitempty"`
// Reason why ingestion failed for the specified message.
//
// Types that are valid to be assigned to Reason:
//
// *IngestionFailureEvent_AwsKinesisFailureReason_SchemaViolationReason
// *IngestionFailureEvent_AwsKinesisFailureReason_MessageTransformationFailureReason
// *IngestionFailureEvent_AwsKinesisFailureReason_ApiViolationReason
Reason isIngestionFailureEvent_AwsKinesisFailureReason_Reason `protobuf_oneof:"reason"`
// contains filtered or unexported fields
}Failure when ingesting from an AWS Kinesis source.
func (*IngestionFailureEvent_AwsKinesisFailureReason) Descriptor
func (*IngestionFailureEvent_AwsKinesisFailureReason) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent_AwsKinesisFailureReason.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent_AwsKinesisFailureReason) GetApiViolationReason
func (x *IngestionFailureEvent_AwsKinesisFailureReason) GetApiViolationReason() *IngestionFailureEvent_ApiViolationReasonfunc (*IngestionFailureEvent_AwsKinesisFailureReason) GetMessageTransformationFailureReason
func (x *IngestionFailureEvent_AwsKinesisFailureReason) GetMessageTransformationFailureReason() *IngestionFailureEvent_MessageTransformationFailureReasonfunc (*IngestionFailureEvent_AwsKinesisFailureReason) GetPartitionKey
func (x *IngestionFailureEvent_AwsKinesisFailureReason) GetPartitionKey() stringfunc (*IngestionFailureEvent_AwsKinesisFailureReason) GetReason
func (x *IngestionFailureEvent_AwsKinesisFailureReason) GetReason() isIngestionFailureEvent_AwsKinesisFailureReason_Reasonfunc (*IngestionFailureEvent_AwsKinesisFailureReason) GetSchemaViolationReason
func (x *IngestionFailureEvent_AwsKinesisFailureReason) GetSchemaViolationReason() *IngestionFailureEvent_SchemaViolationReasonfunc (*IngestionFailureEvent_AwsKinesisFailureReason) GetSequenceNumber
func (x *IngestionFailureEvent_AwsKinesisFailureReason) GetSequenceNumber() stringfunc (*IngestionFailureEvent_AwsKinesisFailureReason) GetStreamArn
func (x *IngestionFailureEvent_AwsKinesisFailureReason) GetStreamArn() stringfunc (*IngestionFailureEvent_AwsKinesisFailureReason) ProtoMessage
func (*IngestionFailureEvent_AwsKinesisFailureReason) ProtoMessage()func (*IngestionFailureEvent_AwsKinesisFailureReason) ProtoReflect
func (x *IngestionFailureEvent_AwsKinesisFailureReason) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent_AwsKinesisFailureReason) Reset
func (x *IngestionFailureEvent_AwsKinesisFailureReason) Reset()func (*IngestionFailureEvent_AwsKinesisFailureReason) String
func (x *IngestionFailureEvent_AwsKinesisFailureReason) String() stringIngestionFailureEvent_AwsKinesisFailureReason_ApiViolationReason
type IngestionFailureEvent_AwsKinesisFailureReason_ApiViolationReason struct {
// Optional. The message failed to be published due to an API violation.
// This is only set when the size of the data field of the Kinesis record
// is zero.
ApiViolationReason *IngestionFailureEvent_ApiViolationReason `protobuf:"bytes,6,opt,name=api_violation_reason,json=apiViolationReason,proto3,oneof"`
}IngestionFailureEvent_AwsKinesisFailureReason_MessageTransformationFailureReason
type IngestionFailureEvent_AwsKinesisFailureReason_MessageTransformationFailureReason struct {
// Optional. Failure encountered when applying a message transformation to
// the Pub/Sub message.
MessageTransformationFailureReason *IngestionFailureEvent_MessageTransformationFailureReason `protobuf:"bytes,5,opt,name=message_transformation_failure_reason,json=messageTransformationFailureReason,proto3,oneof"`
}IngestionFailureEvent_AwsKinesisFailureReason_SchemaViolationReason
type IngestionFailureEvent_AwsKinesisFailureReason_SchemaViolationReason struct {
// Optional. The Pub/Sub message failed schema validation.
SchemaViolationReason *IngestionFailureEvent_SchemaViolationReason `protobuf:"bytes,4,opt,name=schema_violation_reason,json=schemaViolationReason,proto3,oneof"`
}IngestionFailureEvent_AwsMskFailure
type IngestionFailureEvent_AwsMskFailure struct {
// Optional. Failure when ingesting from Amazon MSK.
AwsMskFailure *IngestionFailureEvent_AwsMskFailureReason `protobuf:"bytes,4,opt,name=aws_msk_failure,json=awsMskFailure,proto3,oneof"`
}IngestionFailureEvent_AwsMskFailureReason
type IngestionFailureEvent_AwsMskFailureReason struct {
// Optional. The ARN of the cluster of the topic being ingested from.
ClusterArn string `protobuf:"bytes,1,opt,name=cluster_arn,json=clusterArn,proto3" json:"cluster_arn,omitempty"`
// Optional. The name of the Kafka topic being ingested from.
KafkaTopic string `protobuf:"bytes,2,opt,name=kafka_topic,json=kafkaTopic,proto3" json:"kafka_topic,omitempty"`
// Optional. The partition ID of the message that failed to be ingested.
PartitionId int64 `protobuf:"varint,3,opt,name=partition_id,json=partitionId,proto3" json:"partition_id,omitempty"`
// Optional. The offset within the partition of the message that failed to
// be ingested.
Offset int64 `protobuf:"varint,4,opt,name=offset,proto3" json:"offset,omitempty"`
// Reason why ingestion failed for the specified message.
//
// Types that are valid to be assigned to Reason:
//
// *IngestionFailureEvent_AwsMskFailureReason_ApiViolationReason
// *IngestionFailureEvent_AwsMskFailureReason_SchemaViolationReason
// *IngestionFailureEvent_AwsMskFailureReason_MessageTransformationFailureReason
Reason isIngestionFailureEvent_AwsMskFailureReason_Reason `protobuf_oneof:"reason"`
// contains filtered or unexported fields
}Failure when ingesting from an Amazon MSK source.
func (*IngestionFailureEvent_AwsMskFailureReason) Descriptor
func (*IngestionFailureEvent_AwsMskFailureReason) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent_AwsMskFailureReason.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent_AwsMskFailureReason) GetApiViolationReason
func (x *IngestionFailureEvent_AwsMskFailureReason) GetApiViolationReason() *IngestionFailureEvent_ApiViolationReasonfunc (*IngestionFailureEvent_AwsMskFailureReason) GetClusterArn
func (x *IngestionFailureEvent_AwsMskFailureReason) GetClusterArn() stringfunc (*IngestionFailureEvent_AwsMskFailureReason) GetKafkaTopic
func (x *IngestionFailureEvent_AwsMskFailureReason) GetKafkaTopic() stringfunc (*IngestionFailureEvent_AwsMskFailureReason) GetMessageTransformationFailureReason
func (x *IngestionFailureEvent_AwsMskFailureReason) GetMessageTransformationFailureReason() *IngestionFailureEvent_MessageTransformationFailureReasonfunc (*IngestionFailureEvent_AwsMskFailureReason) GetOffset
func (x *IngestionFailureEvent_AwsMskFailureReason) GetOffset() int64func (*IngestionFailureEvent_AwsMskFailureReason) GetPartitionId
func (x *IngestionFailureEvent_AwsMskFailureReason) GetPartitionId() int64func (*IngestionFailureEvent_AwsMskFailureReason) GetReason
func (x *IngestionFailureEvent_AwsMskFailureReason) GetReason() isIngestionFailureEvent_AwsMskFailureReason_Reasonfunc (*IngestionFailureEvent_AwsMskFailureReason) GetSchemaViolationReason
func (x *IngestionFailureEvent_AwsMskFailureReason) GetSchemaViolationReason() *IngestionFailureEvent_SchemaViolationReasonfunc (*IngestionFailureEvent_AwsMskFailureReason) ProtoMessage
func (*IngestionFailureEvent_AwsMskFailureReason) ProtoMessage()func (*IngestionFailureEvent_AwsMskFailureReason) ProtoReflect
func (x *IngestionFailureEvent_AwsMskFailureReason) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent_AwsMskFailureReason) Reset
func (x *IngestionFailureEvent_AwsMskFailureReason) Reset()func (*IngestionFailureEvent_AwsMskFailureReason) String
func (x *IngestionFailureEvent_AwsMskFailureReason) String() stringIngestionFailureEvent_AwsMskFailureReason_ApiViolationReason
type IngestionFailureEvent_AwsMskFailureReason_ApiViolationReason struct {
// Optional. The Pub/Sub API limits prevented the desired message from
// being published.
ApiViolationReason *IngestionFailureEvent_ApiViolationReason `protobuf:"bytes,5,opt,name=api_violation_reason,json=apiViolationReason,proto3,oneof"`
}IngestionFailureEvent_AwsMskFailureReason_MessageTransformationFailureReason
type IngestionFailureEvent_AwsMskFailureReason_MessageTransformationFailureReason struct {
// Optional. Failure encountered when applying a message transformation to
// the Pub/Sub message.
MessageTransformationFailureReason *IngestionFailureEvent_MessageTransformationFailureReason `protobuf:"bytes,7,opt,name=message_transformation_failure_reason,json=messageTransformationFailureReason,proto3,oneof"`
}IngestionFailureEvent_AwsMskFailureReason_SchemaViolationReason
type IngestionFailureEvent_AwsMskFailureReason_SchemaViolationReason struct {
// Optional. The Pub/Sub message failed schema validation.
SchemaViolationReason *IngestionFailureEvent_SchemaViolationReason `protobuf:"bytes,6,opt,name=schema_violation_reason,json=schemaViolationReason,proto3,oneof"`
}IngestionFailureEvent_AzureEventHubsFailure
type IngestionFailureEvent_AzureEventHubsFailure struct {
// Optional. Failure when ingesting from Azure Event Hubs.
AzureEventHubsFailure *IngestionFailureEvent_AzureEventHubsFailureReason `protobuf:"bytes,5,opt,name=azure_event_hubs_failure,json=azureEventHubsFailure,proto3,oneof"`
}IngestionFailureEvent_AzureEventHubsFailureReason
type IngestionFailureEvent_AzureEventHubsFailureReason struct {
// Optional. The namespace containing the event hub being ingested from.
Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
// Optional. The name of the event hub being ingested from.
EventHub string `protobuf:"bytes,2,opt,name=event_hub,json=eventHub,proto3" json:"event_hub,omitempty"`
// Optional. The partition ID of the message that failed to be ingested.
PartitionId int64 `protobuf:"varint,3,opt,name=partition_id,json=partitionId,proto3" json:"partition_id,omitempty"`
// Optional. The offset within the partition of the message that failed to
// be ingested.
Offset int64 `protobuf:"varint,4,opt,name=offset,proto3" json:"offset,omitempty"`
// Reason why ingestion failed for the specified message.
//
// Types that are valid to be assigned to Reason:
//
// *IngestionFailureEvent_AzureEventHubsFailureReason_ApiViolationReason
// *IngestionFailureEvent_AzureEventHubsFailureReason_SchemaViolationReason
// *IngestionFailureEvent_AzureEventHubsFailureReason_MessageTransformationFailureReason
Reason isIngestionFailureEvent_AzureEventHubsFailureReason_Reason `protobuf_oneof:"reason"`
// contains filtered or unexported fields
}Failure when ingesting from an Azure Event Hubs source.
func (*IngestionFailureEvent_AzureEventHubsFailureReason) Descriptor
func (*IngestionFailureEvent_AzureEventHubsFailureReason) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent_AzureEventHubsFailureReason.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent_AzureEventHubsFailureReason) GetApiViolationReason
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) GetApiViolationReason() *IngestionFailureEvent_ApiViolationReasonfunc (*IngestionFailureEvent_AzureEventHubsFailureReason) GetEventHub
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) GetEventHub() stringfunc (*IngestionFailureEvent_AzureEventHubsFailureReason) GetMessageTransformationFailureReason
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) GetMessageTransformationFailureReason() *IngestionFailureEvent_MessageTransformationFailureReasonfunc (*IngestionFailureEvent_AzureEventHubsFailureReason) GetNamespace
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) GetNamespace() stringfunc (*IngestionFailureEvent_AzureEventHubsFailureReason) GetOffset
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) GetOffset() int64func (*IngestionFailureEvent_AzureEventHubsFailureReason) GetPartitionId
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) GetPartitionId() int64func (*IngestionFailureEvent_AzureEventHubsFailureReason) GetReason
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) GetReason() isIngestionFailureEvent_AzureEventHubsFailureReason_Reasonfunc (*IngestionFailureEvent_AzureEventHubsFailureReason) GetSchemaViolationReason
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) GetSchemaViolationReason() *IngestionFailureEvent_SchemaViolationReasonfunc (*IngestionFailureEvent_AzureEventHubsFailureReason) ProtoMessage
func (*IngestionFailureEvent_AzureEventHubsFailureReason) ProtoMessage()func (*IngestionFailureEvent_AzureEventHubsFailureReason) ProtoReflect
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent_AzureEventHubsFailureReason) Reset
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) Reset()func (*IngestionFailureEvent_AzureEventHubsFailureReason) String
func (x *IngestionFailureEvent_AzureEventHubsFailureReason) String() stringIngestionFailureEvent_AzureEventHubsFailureReason_ApiViolationReason
type IngestionFailureEvent_AzureEventHubsFailureReason_ApiViolationReason struct {
// Optional. The Pub/Sub API limits prevented the desired message from
// being published.
ApiViolationReason *IngestionFailureEvent_ApiViolationReason `protobuf:"bytes,5,opt,name=api_violation_reason,json=apiViolationReason,proto3,oneof"`
}IngestionFailureEvent_AzureEventHubsFailureReason_MessageTransformationFailureReason
type IngestionFailureEvent_AzureEventHubsFailureReason_MessageTransformationFailureReason struct {
// Optional. Failure encountered when applying a message transformation to
// the Pub/Sub message.
MessageTransformationFailureReason *IngestionFailureEvent_MessageTransformationFailureReason `protobuf:"bytes,7,opt,name=message_transformation_failure_reason,json=messageTransformationFailureReason,proto3,oneof"`
}IngestionFailureEvent_AzureEventHubsFailureReason_SchemaViolationReason
type IngestionFailureEvent_AzureEventHubsFailureReason_SchemaViolationReason struct {
// Optional. The Pub/Sub message failed schema validation.
SchemaViolationReason *IngestionFailureEvent_SchemaViolationReason `protobuf:"bytes,6,opt,name=schema_violation_reason,json=schemaViolationReason,proto3,oneof"`
}IngestionFailureEvent_CloudStorageFailure
type IngestionFailureEvent_CloudStorageFailure struct {
// Optional. Name of the Cloud Storage bucket used for ingestion.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Optional. Name of the Cloud Storage object which contained the section
// that couldn't be ingested.
ObjectName string `protobuf:"bytes,2,opt,name=object_name,json=objectName,proto3" json:"object_name,omitempty"`
// Optional. Generation of the Cloud Storage object which contained the
// section that couldn't be ingested.
ObjectGeneration int64 `protobuf:"varint,3,opt,name=object_generation,json=objectGeneration,proto3" json:"object_generation,omitempty"`
// Reason why ingestion failed for the specified object.
//
// Types that are valid to be assigned to Reason:
//
// *IngestionFailureEvent_CloudStorageFailure_AvroFailureReason
// *IngestionFailureEvent_CloudStorageFailure_ApiViolationReason
// *IngestionFailureEvent_CloudStorageFailure_SchemaViolationReason
// *IngestionFailureEvent_CloudStorageFailure_MessageTransformationFailureReason
Reason isIngestionFailureEvent_CloudStorageFailure_Reason `protobuf_oneof:"reason"`
// contains filtered or unexported fields
}Failure when ingesting from a Cloud Storage source.
func (*IngestionFailureEvent_CloudStorageFailure) Descriptor
func (*IngestionFailureEvent_CloudStorageFailure) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent_CloudStorageFailure.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent_CloudStorageFailure) GetApiViolationReason
func (x *IngestionFailureEvent_CloudStorageFailure) GetApiViolationReason() *IngestionFailureEvent_ApiViolationReasonfunc (*IngestionFailureEvent_CloudStorageFailure) GetAvroFailureReason
func (x *IngestionFailureEvent_CloudStorageFailure) GetAvroFailureReason() *IngestionFailureEvent_AvroFailureReasonfunc (*IngestionFailureEvent_CloudStorageFailure) GetBucket
func (x *IngestionFailureEvent_CloudStorageFailure) GetBucket() stringfunc (*IngestionFailureEvent_CloudStorageFailure) GetMessageTransformationFailureReason
func (x *IngestionFailureEvent_CloudStorageFailure) GetMessageTransformationFailureReason() *IngestionFailureEvent_MessageTransformationFailureReasonfunc (*IngestionFailureEvent_CloudStorageFailure) GetObjectGeneration
func (x *IngestionFailureEvent_CloudStorageFailure) GetObjectGeneration() int64func (*IngestionFailureEvent_CloudStorageFailure) GetObjectName
func (x *IngestionFailureEvent_CloudStorageFailure) GetObjectName() stringfunc (*IngestionFailureEvent_CloudStorageFailure) GetReason
func (x *IngestionFailureEvent_CloudStorageFailure) GetReason() isIngestionFailureEvent_CloudStorageFailure_Reasonfunc (*IngestionFailureEvent_CloudStorageFailure) GetSchemaViolationReason
func (x *IngestionFailureEvent_CloudStorageFailure) GetSchemaViolationReason() *IngestionFailureEvent_SchemaViolationReasonfunc (*IngestionFailureEvent_CloudStorageFailure) ProtoMessage
func (*IngestionFailureEvent_CloudStorageFailure) ProtoMessage()func (*IngestionFailureEvent_CloudStorageFailure) ProtoReflect
func (x *IngestionFailureEvent_CloudStorageFailure) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent_CloudStorageFailure) Reset
func (x *IngestionFailureEvent_CloudStorageFailure) Reset()func (*IngestionFailureEvent_CloudStorageFailure) String
func (x *IngestionFailureEvent_CloudStorageFailure) String() stringIngestionFailureEvent_CloudStorageFailure_
type IngestionFailureEvent_CloudStorageFailure_ struct {
// Optional. Failure when ingesting from Cloud Storage.
CloudStorageFailure *IngestionFailureEvent_CloudStorageFailure `protobuf:"bytes,3,opt,name=cloud_storage_failure,json=cloudStorageFailure,proto3,oneof"`
}IngestionFailureEvent_CloudStorageFailure_ApiViolationReason
type IngestionFailureEvent_CloudStorageFailure_ApiViolationReason struct {
// Optional. The Pub/Sub API limits prevented the desired message from
// being published.
ApiViolationReason *IngestionFailureEvent_ApiViolationReason `protobuf:"bytes,6,opt,name=api_violation_reason,json=apiViolationReason,proto3,oneof"`
}IngestionFailureEvent_CloudStorageFailure_AvroFailureReason
type IngestionFailureEvent_CloudStorageFailure_AvroFailureReason struct {
// Optional. Failure encountered when parsing an Avro file.
AvroFailureReason *IngestionFailureEvent_AvroFailureReason `protobuf:"bytes,5,opt,name=avro_failure_reason,json=avroFailureReason,proto3,oneof"`
}IngestionFailureEvent_CloudStorageFailure_MessageTransformationFailureReason
type IngestionFailureEvent_CloudStorageFailure_MessageTransformationFailureReason struct {
// Optional. Failure encountered when applying a message transformation to
// the Pub/Sub message.
MessageTransformationFailureReason *IngestionFailureEvent_MessageTransformationFailureReason `protobuf:"bytes,8,opt,name=message_transformation_failure_reason,json=messageTransformationFailureReason,proto3,oneof"`
}IngestionFailureEvent_CloudStorageFailure_SchemaViolationReason
type IngestionFailureEvent_CloudStorageFailure_SchemaViolationReason struct {
// Optional. The Pub/Sub message failed schema validation.
SchemaViolationReason *IngestionFailureEvent_SchemaViolationReason `protobuf:"bytes,7,opt,name=schema_violation_reason,json=schemaViolationReason,proto3,oneof"`
}IngestionFailureEvent_ConfluentCloudFailure
type IngestionFailureEvent_ConfluentCloudFailure struct {
// Optional. Failure when ingesting from Confluent Cloud.
ConfluentCloudFailure *IngestionFailureEvent_ConfluentCloudFailureReason `protobuf:"bytes,6,opt,name=confluent_cloud_failure,json=confluentCloudFailure,proto3,oneof"`
}IngestionFailureEvent_ConfluentCloudFailureReason
type IngestionFailureEvent_ConfluentCloudFailureReason struct {
// Optional. The cluster ID containing the topic being ingested from.
ClusterId string `protobuf:"bytes,1,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
// Optional. The name of the Kafka topic being ingested from.
KafkaTopic string `protobuf:"bytes,2,opt,name=kafka_topic,json=kafkaTopic,proto3" json:"kafka_topic,omitempty"`
// Optional. The partition ID of the message that failed to be ingested.
PartitionId int64 `protobuf:"varint,3,opt,name=partition_id,json=partitionId,proto3" json:"partition_id,omitempty"`
// Optional. The offset within the partition of the message that failed to
// be ingested.
Offset int64 `protobuf:"varint,4,opt,name=offset,proto3" json:"offset,omitempty"`
// Reason why ingestion failed for the specified message.
//
// Types that are valid to be assigned to Reason:
//
// *IngestionFailureEvent_ConfluentCloudFailureReason_ApiViolationReason
// *IngestionFailureEvent_ConfluentCloudFailureReason_SchemaViolationReason
// *IngestionFailureEvent_ConfluentCloudFailureReason_MessageTransformationFailureReason
Reason isIngestionFailureEvent_ConfluentCloudFailureReason_Reason `protobuf_oneof:"reason"`
// contains filtered or unexported fields
}Failure when ingesting from a Confluent Cloud source.
func (*IngestionFailureEvent_ConfluentCloudFailureReason) Descriptor
func (*IngestionFailureEvent_ConfluentCloudFailureReason) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent_ConfluentCloudFailureReason.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent_ConfluentCloudFailureReason) GetApiViolationReason
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) GetApiViolationReason() *IngestionFailureEvent_ApiViolationReasonfunc (*IngestionFailureEvent_ConfluentCloudFailureReason) GetClusterId
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) GetClusterId() stringfunc (*IngestionFailureEvent_ConfluentCloudFailureReason) GetKafkaTopic
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) GetKafkaTopic() stringfunc (*IngestionFailureEvent_ConfluentCloudFailureReason) GetMessageTransformationFailureReason
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) GetMessageTransformationFailureReason() *IngestionFailureEvent_MessageTransformationFailureReasonfunc (*IngestionFailureEvent_ConfluentCloudFailureReason) GetOffset
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) GetOffset() int64func (*IngestionFailureEvent_ConfluentCloudFailureReason) GetPartitionId
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) GetPartitionId() int64func (*IngestionFailureEvent_ConfluentCloudFailureReason) GetReason
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) GetReason() isIngestionFailureEvent_ConfluentCloudFailureReason_Reasonfunc (*IngestionFailureEvent_ConfluentCloudFailureReason) GetSchemaViolationReason
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) GetSchemaViolationReason() *IngestionFailureEvent_SchemaViolationReasonfunc (*IngestionFailureEvent_ConfluentCloudFailureReason) ProtoMessage
func (*IngestionFailureEvent_ConfluentCloudFailureReason) ProtoMessage()func (*IngestionFailureEvent_ConfluentCloudFailureReason) ProtoReflect
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent_ConfluentCloudFailureReason) Reset
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) Reset()func (*IngestionFailureEvent_ConfluentCloudFailureReason) String
func (x *IngestionFailureEvent_ConfluentCloudFailureReason) String() stringIngestionFailureEvent_ConfluentCloudFailureReason_ApiViolationReason
type IngestionFailureEvent_ConfluentCloudFailureReason_ApiViolationReason struct {
// Optional. The Pub/Sub API limits prevented the desired message from
// being published.
ApiViolationReason *IngestionFailureEvent_ApiViolationReason `protobuf:"bytes,5,opt,name=api_violation_reason,json=apiViolationReason,proto3,oneof"`
}IngestionFailureEvent_ConfluentCloudFailureReason_MessageTransformationFailureReason
type IngestionFailureEvent_ConfluentCloudFailureReason_MessageTransformationFailureReason struct {
// Optional. Failure encountered when applying a message transformation to
// the Pub/Sub message.
MessageTransformationFailureReason *IngestionFailureEvent_MessageTransformationFailureReason `protobuf:"bytes,7,opt,name=message_transformation_failure_reason,json=messageTransformationFailureReason,proto3,oneof"`
}IngestionFailureEvent_ConfluentCloudFailureReason_SchemaViolationReason
type IngestionFailureEvent_ConfluentCloudFailureReason_SchemaViolationReason struct {
// Optional. The Pub/Sub message failed schema validation.
SchemaViolationReason *IngestionFailureEvent_SchemaViolationReason `protobuf:"bytes,6,opt,name=schema_violation_reason,json=schemaViolationReason,proto3,oneof"`
}IngestionFailureEvent_MessageTransformationFailureReason
type IngestionFailureEvent_MessageTransformationFailureReason struct {
// contains filtered or unexported fields
}Set when a Pub/Sub message fails to get published due to a message transformation error.
func (*IngestionFailureEvent_MessageTransformationFailureReason) Descriptor
func (*IngestionFailureEvent_MessageTransformationFailureReason) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent_MessageTransformationFailureReason.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent_MessageTransformationFailureReason) ProtoMessage
func (*IngestionFailureEvent_MessageTransformationFailureReason) ProtoMessage()func (*IngestionFailureEvent_MessageTransformationFailureReason) ProtoReflect
func (x *IngestionFailureEvent_MessageTransformationFailureReason) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent_MessageTransformationFailureReason) Reset
func (x *IngestionFailureEvent_MessageTransformationFailureReason) Reset()func (*IngestionFailureEvent_MessageTransformationFailureReason) String
func (x *IngestionFailureEvent_MessageTransformationFailureReason) String() stringIngestionFailureEvent_SchemaViolationReason
type IngestionFailureEvent_SchemaViolationReason struct {
// contains filtered or unexported fields
}Set when a Pub/Sub message fails to get published due to a schema validation violation.
func (*IngestionFailureEvent_SchemaViolationReason) Descriptor
func (*IngestionFailureEvent_SchemaViolationReason) Descriptor() ([]byte, []int)Deprecated: Use IngestionFailureEvent_SchemaViolationReason.ProtoReflect.Descriptor instead.
func (*IngestionFailureEvent_SchemaViolationReason) ProtoMessage
func (*IngestionFailureEvent_SchemaViolationReason) ProtoMessage()func (*IngestionFailureEvent_SchemaViolationReason) ProtoReflect
func (x *IngestionFailureEvent_SchemaViolationReason) ProtoReflect() protoreflect.Messagefunc (*IngestionFailureEvent_SchemaViolationReason) Reset
func (x *IngestionFailureEvent_SchemaViolationReason) Reset()func (*IngestionFailureEvent_SchemaViolationReason) String
func (x *IngestionFailureEvent_SchemaViolationReason) String() stringJavaScriptUDF
type JavaScriptUDF struct {
// Required. Name of the JavasScript function that should applied to Pub/Sub
// messages.
FunctionName string `protobuf:"bytes,1,opt,name=function_name,json=functionName,proto3" json:"function_name,omitempty"`
// Required. JavaScript code that contains a function `function_name` with the
// below signature:
//
// ```
//
// /**
// * Transforms a Pub/Sub message.
//
// * @return {(ObjectUser-defined JavaScript function that can transform or filter a Pub/Sub message.
func (*JavaScriptUDF) Descriptor
func (*JavaScriptUDF) Descriptor() ([]byte, []int)Deprecated: Use JavaScriptUDF.ProtoReflect.Descriptor instead.
func (*JavaScriptUDF) GetCode
func (x *JavaScriptUDF) GetCode() stringfunc (*JavaScriptUDF) GetFunctionName
func (x *JavaScriptUDF) GetFunctionName() stringfunc (*JavaScriptUDF) ProtoMessage
func (*JavaScriptUDF) ProtoMessage()func (*JavaScriptUDF) ProtoReflect
func (x *JavaScriptUDF) ProtoReflect() protoreflect.Messagefunc (*JavaScriptUDF) Reset
func (x *JavaScriptUDF) Reset()func (*JavaScriptUDF) String
func (x *JavaScriptUDF) String() stringListSchemaRevisionsRequest
type ListSchemaRevisionsRequest struct {
// Required. The name of the schema to list revisions for.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The set of Schema fields to return in the response. If not set, returns
// Schemas with `name` and `type`, but not `definition`. Set to `FULL` to
// retrieve all fields.
View SchemaView `protobuf:"varint,2,opt,name=view,proto3,enum=google.pubsub.v1.SchemaView" json:"view,omitempty"`
// The maximum number of revisions to return per page.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The page token, received from a previous ListSchemaRevisions call.
// Provide this to retrieve the subsequent page.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request for the ListSchemaRevisions method.
func (*ListSchemaRevisionsRequest) Descriptor
func (*ListSchemaRevisionsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSchemaRevisionsRequest.ProtoReflect.Descriptor instead.
func (*ListSchemaRevisionsRequest) GetName
func (x *ListSchemaRevisionsRequest) GetName() stringfunc (*ListSchemaRevisionsRequest) GetPageSize
func (x *ListSchemaRevisionsRequest) GetPageSize() int32func (*ListSchemaRevisionsRequest) GetPageToken
func (x *ListSchemaRevisionsRequest) GetPageToken() stringfunc (*ListSchemaRevisionsRequest) GetView
func (x *ListSchemaRevisionsRequest) GetView() SchemaViewfunc (*ListSchemaRevisionsRequest) ProtoMessage
func (*ListSchemaRevisionsRequest) ProtoMessage()func (*ListSchemaRevisionsRequest) ProtoReflect
func (x *ListSchemaRevisionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListSchemaRevisionsRequest) Reset
func (x *ListSchemaRevisionsRequest) Reset()func (*ListSchemaRevisionsRequest) String
func (x *ListSchemaRevisionsRequest) String() stringListSchemaRevisionsResponse
type ListSchemaRevisionsResponse struct {
// The revisions of the schema.
Schemas []*Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
// A token that can be sent as `page_token` to retrieve the next page.
// If this field is empty, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for the ListSchemaRevisions method.
func (*ListSchemaRevisionsResponse) Descriptor
func (*ListSchemaRevisionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSchemaRevisionsResponse.ProtoReflect.Descriptor instead.
func (*ListSchemaRevisionsResponse) GetNextPageToken
func (x *ListSchemaRevisionsResponse) GetNextPageToken() stringfunc (*ListSchemaRevisionsResponse) GetSchemas
func (x *ListSchemaRevisionsResponse) GetSchemas() []*Schemafunc (*ListSchemaRevisionsResponse) ProtoMessage
func (*ListSchemaRevisionsResponse) ProtoMessage()func (*ListSchemaRevisionsResponse) ProtoReflect
func (x *ListSchemaRevisionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListSchemaRevisionsResponse) Reset
func (x *ListSchemaRevisionsResponse) Reset()func (*ListSchemaRevisionsResponse) String
func (x *ListSchemaRevisionsResponse) String() stringListSchemasRequest
type ListSchemasRequest struct {
// Required. The name of the project in which to list schemas.
// Format is `projects/{project-id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The set of Schema fields to return in the response. If not set, returns
// Schemas with `name` and `type`, but not `definition`. Set to `FULL` to
// retrieve all fields.
View SchemaView `protobuf:"varint,2,opt,name=view,proto3,enum=google.pubsub.v1.SchemaView" json:"view,omitempty"`
// Maximum number of schemas to return.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The value returned by the last `ListSchemasResponse`; indicates that
// this is a continuation of a prior `ListSchemas` call, and that the
// system should return the next page of data.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request for the ListSchemas method.
func (*ListSchemasRequest) Descriptor
func (*ListSchemasRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSchemasRequest.ProtoReflect.Descriptor instead.
func (*ListSchemasRequest) GetPageSize
func (x *ListSchemasRequest) GetPageSize() int32func (*ListSchemasRequest) GetPageToken
func (x *ListSchemasRequest) GetPageToken() stringfunc (*ListSchemasRequest) GetParent
func (x *ListSchemasRequest) GetParent() stringfunc (*ListSchemasRequest) GetView
func (x *ListSchemasRequest) GetView() SchemaViewfunc (*ListSchemasRequest) ProtoMessage
func (*ListSchemasRequest) ProtoMessage()func (*ListSchemasRequest) ProtoReflect
func (x *ListSchemasRequest) ProtoReflect() protoreflect.Messagefunc (*ListSchemasRequest) Reset
func (x *ListSchemasRequest) Reset()func (*ListSchemasRequest) String
func (x *ListSchemasRequest) String() stringListSchemasResponse
type ListSchemasResponse struct {
// The resulting schemas.
Schemas []*Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
// If not empty, indicates that there may be more schemas that match the
// request; this value should be passed in a new `ListSchemasRequest`.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for the ListSchemas method.
func (*ListSchemasResponse) Descriptor
func (*ListSchemasResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSchemasResponse.ProtoReflect.Descriptor instead.
func (*ListSchemasResponse) GetNextPageToken
func (x *ListSchemasResponse) GetNextPageToken() stringfunc (*ListSchemasResponse) GetSchemas
func (x *ListSchemasResponse) GetSchemas() []*Schemafunc (*ListSchemasResponse) ProtoMessage
func (*ListSchemasResponse) ProtoMessage()func (*ListSchemasResponse) ProtoReflect
func (x *ListSchemasResponse) ProtoReflect() protoreflect.Messagefunc (*ListSchemasResponse) Reset
func (x *ListSchemasResponse) Reset()func (*ListSchemasResponse) String
func (x *ListSchemasResponse) String() stringListSnapshotsRequest
type ListSnapshotsRequest struct {
// Required. The name of the project in which to list snapshots.
// Format is `projects/{project-id}`.
Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
// Optional. Maximum number of snapshots to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The value returned by the last `ListSnapshotsResponse`; indicates
// that this is a continuation of a prior `ListSnapshots` call, and that the
// system should return the next page of data.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request for the ListSnapshots method.
func (*ListSnapshotsRequest) Descriptor
func (*ListSnapshotsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSnapshotsRequest.ProtoReflect.Descriptor instead.
func (*ListSnapshotsRequest) GetPageSize
func (x *ListSnapshotsRequest) GetPageSize() int32func (*ListSnapshotsRequest) GetPageToken
func (x *ListSnapshotsRequest) GetPageToken() stringfunc (*ListSnapshotsRequest) GetProject
func (x *ListSnapshotsRequest) GetProject() stringfunc (*ListSnapshotsRequest) ProtoMessage
func (*ListSnapshotsRequest) ProtoMessage()func (*ListSnapshotsRequest) ProtoReflect
func (x *ListSnapshotsRequest) ProtoReflect() protoreflect.Messagefunc (*ListSnapshotsRequest) Reset
func (x *ListSnapshotsRequest) Reset()func (*ListSnapshotsRequest) String
func (x *ListSnapshotsRequest) String() stringListSnapshotsResponse
type ListSnapshotsResponse struct {
// Optional. The resulting snapshots.
Snapshots []*Snapshot `protobuf:"bytes,1,rep,name=snapshots,proto3" json:"snapshots,omitempty"`
// Optional. If not empty, indicates that there may be more snapshot that
// match the request; this value should be passed in a new
// `ListSnapshotsRequest`.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for the ListSnapshots method.
func (*ListSnapshotsResponse) Descriptor
func (*ListSnapshotsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSnapshotsResponse.ProtoReflect.Descriptor instead.
func (*ListSnapshotsResponse) GetNextPageToken
func (x *ListSnapshotsResponse) GetNextPageToken() stringfunc (*ListSnapshotsResponse) GetSnapshots
func (x *ListSnapshotsResponse) GetSnapshots() []*Snapshotfunc (*ListSnapshotsResponse) ProtoMessage
func (*ListSnapshotsResponse) ProtoMessage()func (*ListSnapshotsResponse) ProtoReflect
func (x *ListSnapshotsResponse) ProtoReflect() protoreflect.Messagefunc (*ListSnapshotsResponse) Reset
func (x *ListSnapshotsResponse) Reset()func (*ListSnapshotsResponse) String
func (x *ListSnapshotsResponse) String() stringListSubscriptionsRequest
type ListSubscriptionsRequest struct {
// Required. The name of the project in which to list subscriptions.
// Format is `projects/{project-id}`.
Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
// Optional. Maximum number of subscriptions to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The value returned by the last `ListSubscriptionsResponse`;
// indicates that this is a continuation of a prior `ListSubscriptions` call,
// and that the system should return the next page of data.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request for the ListSubscriptions method.
func (*ListSubscriptionsRequest) Descriptor
func (*ListSubscriptionsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSubscriptionsRequest.ProtoReflect.Descriptor instead.
func (*ListSubscriptionsRequest) GetPageSize
func (x *ListSubscriptionsRequest) GetPageSize() int32func (*ListSubscriptionsRequest) GetPageToken
func (x *ListSubscriptionsRequest) GetPageToken() stringfunc (*ListSubscriptionsRequest) GetProject
func (x *ListSubscriptionsRequest) GetProject() stringfunc (*ListSubscriptionsRequest) ProtoMessage
func (*ListSubscriptionsRequest) ProtoMessage()func (*ListSubscriptionsRequest) ProtoReflect
func (x *ListSubscriptionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListSubscriptionsRequest) Reset
func (x *ListSubscriptionsRequest) Reset()func (*ListSubscriptionsRequest) String
func (x *ListSubscriptionsRequest) String() stringListSubscriptionsResponse
type ListSubscriptionsResponse struct {
// Optional. The subscriptions that match the request.
Subscriptions []*Subscription `protobuf:"bytes,1,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
// Optional. If not empty, indicates that there may be more subscriptions that
// match the request; this value should be passed in a new
// `ListSubscriptionsRequest` to get more subscriptions.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for the ListSubscriptions method.
func (*ListSubscriptionsResponse) Descriptor
func (*ListSubscriptionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSubscriptionsResponse.ProtoReflect.Descriptor instead.
func (*ListSubscriptionsResponse) GetNextPageToken
func (x *ListSubscriptionsResponse) GetNextPageToken() stringfunc (*ListSubscriptionsResponse) GetSubscriptions
func (x *ListSubscriptionsResponse) GetSubscriptions() []*Subscriptionfunc (*ListSubscriptionsResponse) ProtoMessage
func (*ListSubscriptionsResponse) ProtoMessage()func (*ListSubscriptionsResponse) ProtoReflect
func (x *ListSubscriptionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListSubscriptionsResponse) Reset
func (x *ListSubscriptionsResponse) Reset()func (*ListSubscriptionsResponse) String
func (x *ListSubscriptionsResponse) String() stringListTopicSnapshotsRequest
type ListTopicSnapshotsRequest struct {
// Required. The name of the topic that snapshots are attached to.
// Format is `projects/{project}/topics/{topic}`.
Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
// Optional. Maximum number of snapshot names to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The value returned by the last `ListTopicSnapshotsResponse`;
// indicates that this is a continuation of a prior `ListTopicSnapshots` call,
// and that the system should return the next page of data.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request for the ListTopicSnapshots method.
func (*ListTopicSnapshotsRequest) Descriptor
func (*ListTopicSnapshotsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListTopicSnapshotsRequest.ProtoReflect.Descriptor instead.
func (*ListTopicSnapshotsRequest) GetPageSize
func (x *ListTopicSnapshotsRequest) GetPageSize() int32func (*ListTopicSnapshotsRequest) GetPageToken
func (x *ListTopicSnapshotsRequest) GetPageToken() stringfunc (*ListTopicSnapshotsRequest) GetTopic
func (x *ListTopicSnapshotsRequest) GetTopic() stringfunc (*ListTopicSnapshotsRequest) ProtoMessage
func (*ListTopicSnapshotsRequest) ProtoMessage()func (*ListTopicSnapshotsRequest) ProtoReflect
func (x *ListTopicSnapshotsRequest) ProtoReflect() protoreflect.Messagefunc (*ListTopicSnapshotsRequest) Reset
func (x *ListTopicSnapshotsRequest) Reset()func (*ListTopicSnapshotsRequest) String
func (x *ListTopicSnapshotsRequest) String() stringListTopicSnapshotsResponse
type ListTopicSnapshotsResponse struct {
// Optional. The names of the snapshots that match the request.
Snapshots []string `protobuf:"bytes,1,rep,name=snapshots,proto3" json:"snapshots,omitempty"`
// Optional. If not empty, indicates that there may be more snapshots that
// match the request; this value should be passed in a new
// `ListTopicSnapshotsRequest` to get more snapshots.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for the ListTopicSnapshots method.
func (*ListTopicSnapshotsResponse) Descriptor
func (*ListTopicSnapshotsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListTopicSnapshotsResponse.ProtoReflect.Descriptor instead.
func (*ListTopicSnapshotsResponse) GetNextPageToken
func (x *ListTopicSnapshotsResponse) GetNextPageToken() stringfunc (*ListTopicSnapshotsResponse) GetSnapshots
func (x *ListTopicSnapshotsResponse) GetSnapshots() []stringfunc (*ListTopicSnapshotsResponse) ProtoMessage
func (*ListTopicSnapshotsResponse) ProtoMessage()func (*ListTopicSnapshotsResponse) ProtoReflect
func (x *ListTopicSnapshotsResponse) ProtoReflect() protoreflect.Messagefunc (*ListTopicSnapshotsResponse) Reset
func (x *ListTopicSnapshotsResponse) Reset()func (*ListTopicSnapshotsResponse) String
func (x *ListTopicSnapshotsResponse) String() stringListTopicSubscriptionsRequest
type ListTopicSubscriptionsRequest struct {
// Required. The name of the topic that subscriptions are attached to.
// Format is `projects/{project}/topics/{topic}`.
Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
// Optional. Maximum number of subscription names to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The value returned by the last `ListTopicSubscriptionsResponse`;
// indicates that this is a continuation of a prior `ListTopicSubscriptions`
// call, and that the system should return the next page of data.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request for the ListTopicSubscriptions method.
func (*ListTopicSubscriptionsRequest) Descriptor
func (*ListTopicSubscriptionsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListTopicSubscriptionsRequest.ProtoReflect.Descriptor instead.
func (*ListTopicSubscriptionsRequest) GetPageSize
func (x *ListTopicSubscriptionsRequest) GetPageSize() int32func (*ListTopicSubscriptionsRequest) GetPageToken
func (x *ListTopicSubscriptionsRequest) GetPageToken() stringfunc (*ListTopicSubscriptionsRequest) GetTopic
func (x *ListTopicSubscriptionsRequest) GetTopic() stringfunc (*ListTopicSubscriptionsRequest) ProtoMessage
func (*ListTopicSubscriptionsRequest) ProtoMessage()func (*ListTopicSubscriptionsRequest) ProtoReflect
func (x *ListTopicSubscriptionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListTopicSubscriptionsRequest) Reset
func (x *ListTopicSubscriptionsRequest) Reset()func (*ListTopicSubscriptionsRequest) String
func (x *ListTopicSubscriptionsRequest) String() stringListTopicSubscriptionsResponse
type ListTopicSubscriptionsResponse struct {
// Optional. The names of subscriptions attached to the topic specified in the
// request.
Subscriptions []string `protobuf:"bytes,1,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
// Optional. If not empty, indicates that there may be more subscriptions that
// match the request; this value should be passed in a new
// `ListTopicSubscriptionsRequest` to get more subscriptions.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for the ListTopicSubscriptions method.
func (*ListTopicSubscriptionsResponse) Descriptor
func (*ListTopicSubscriptionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListTopicSubscriptionsResponse.ProtoReflect.Descriptor instead.
func (*ListTopicSubscriptionsResponse) GetNextPageToken
func (x *ListTopicSubscriptionsResponse) GetNextPageToken() stringfunc (*ListTopicSubscriptionsResponse) GetSubscriptions
func (x *ListTopicSubscriptionsResponse) GetSubscriptions() []stringfunc (*ListTopicSubscriptionsResponse) ProtoMessage
func (*ListTopicSubscriptionsResponse) ProtoMessage()func (*ListTopicSubscriptionsResponse) ProtoReflect
func (x *ListTopicSubscriptionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListTopicSubscriptionsResponse) Reset
func (x *ListTopicSubscriptionsResponse) Reset()func (*ListTopicSubscriptionsResponse) String
func (x *ListTopicSubscriptionsResponse) String() stringListTopicsRequest
type ListTopicsRequest struct {
// Required. The name of the project in which to list topics.
// Format is `projects/{project-id}`.
Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
// Optional. Maximum number of topics to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The value returned by the last `ListTopicsResponse`; indicates
// that this is a continuation of a prior `ListTopics` call, and that the
// system should return the next page of data.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request for the ListTopics method.
func (*ListTopicsRequest) Descriptor
func (*ListTopicsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListTopicsRequest.ProtoReflect.Descriptor instead.
func (*ListTopicsRequest) GetPageSize
func (x *ListTopicsRequest) GetPageSize() int32func (*ListTopicsRequest) GetPageToken
func (x *ListTopicsRequest) GetPageToken() stringfunc (*ListTopicsRequest) GetProject
func (x *ListTopicsRequest) GetProject() stringfunc (*ListTopicsRequest) ProtoMessage
func (*ListTopicsRequest) ProtoMessage()func (*ListTopicsRequest) ProtoReflect
func (x *ListTopicsRequest) ProtoReflect() protoreflect.Messagefunc (*ListTopicsRequest) Reset
func (x *ListTopicsRequest) Reset()func (*ListTopicsRequest) String
func (x *ListTopicsRequest) String() stringListTopicsResponse
type ListTopicsResponse struct {
// Optional. The resulting topics.
Topics []*Topic `protobuf:"bytes,1,rep,name=topics,proto3" json:"topics,omitempty"`
// Optional. If not empty, indicates that there may be more topics that match
// the request; this value should be passed in a new `ListTopicsRequest`.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for the ListTopics method.
func (*ListTopicsResponse) Descriptor
func (*ListTopicsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListTopicsResponse.ProtoReflect.Descriptor instead.
func (*ListTopicsResponse) GetNextPageToken
func (x *ListTopicsResponse) GetNextPageToken() stringfunc (*ListTopicsResponse) GetTopics
func (x *ListTopicsResponse) GetTopics() []*Topicfunc (*ListTopicsResponse) ProtoMessage
func (*ListTopicsResponse) ProtoMessage()func (*ListTopicsResponse) ProtoReflect
func (x *ListTopicsResponse) ProtoReflect() protoreflect.Messagefunc (*ListTopicsResponse) Reset
func (x *ListTopicsResponse) Reset()func (*ListTopicsResponse) String
func (x *ListTopicsResponse) String() stringMessageStoragePolicy
type MessageStoragePolicy struct {
// Optional. A list of IDs of Google Cloud regions where messages that are
// published to the topic may be persisted in storage. Messages published by
// publishers running in non-allowed Google Cloud regions (or running outside
// of Google Cloud altogether) are routed for storage in one of the allowed
// regions. An empty list means that no regions are allowed, and is not a
// valid configuration.
AllowedPersistenceRegions []string `protobuf:"bytes,1,rep,name=allowed_persistence_regions,json=allowedPersistenceRegions,proto3" json:"allowed_persistence_regions,omitempty"`
// Optional. If true, `allowed_persistence_regions` is also used to enforce
// in-transit guarantees for messages. That is, Pub/Sub will fail
// Publish operations on this topic and subscribe operations
// on any subscription attached to this topic in any region that is
// not in `allowed_persistence_regions`.
EnforceInTransit bool `protobuf:"varint,2,opt,name=enforce_in_transit,json=enforceInTransit,proto3" json:"enforce_in_transit,omitempty"`
// contains filtered or unexported fields
}A policy constraining the storage of messages published to the topic.
func (*MessageStoragePolicy) Descriptor
func (*MessageStoragePolicy) Descriptor() ([]byte, []int)Deprecated: Use MessageStoragePolicy.ProtoReflect.Descriptor instead.
func (*MessageStoragePolicy) GetAllowedPersistenceRegions
func (x *MessageStoragePolicy) GetAllowedPersistenceRegions() []stringfunc (*MessageStoragePolicy) GetEnforceInTransit
func (x *MessageStoragePolicy) GetEnforceInTransit() boolfunc (*MessageStoragePolicy) ProtoMessage
func (*MessageStoragePolicy) ProtoMessage()func (*MessageStoragePolicy) ProtoReflect
func (x *MessageStoragePolicy) ProtoReflect() protoreflect.Messagefunc (*MessageStoragePolicy) Reset
func (x *MessageStoragePolicy) Reset()func (*MessageStoragePolicy) String
func (x *MessageStoragePolicy) String() stringMessageTransform
type MessageTransform struct {
// The type of transform to apply to messages.
//
// Types that are valid to be assigned to Transform:
//
// *MessageTransform_JavascriptUdf
// *MessageTransform_Compression
// *MessageTransform_AiInference
Transform isMessageTransform_Transform `protobuf_oneof:"transform"`
// Optional. This field is deprecated, use the `disabled` field to disable
// transforms.
//
// Deprecated: Marked as deprecated in google/pubsub/v1/pubsub.proto.
Enabled bool `protobuf:"varint,3,opt,name=enabled,proto3" json:"enabled,omitempty"`
// Optional. If true, the transform is disabled and will not be applied to
// messages. Defaults to `false`.
Disabled bool `protobuf:"varint,4,opt,name=disabled,proto3" json:"disabled,omitempty"`
// contains filtered or unexported fields
}All supported message transforms types.
func (*MessageTransform) Descriptor
func (*MessageTransform) Descriptor() ([]byte, []int)Deprecated: Use MessageTransform.ProtoReflect.Descriptor instead.
func (*MessageTransform) GetAiInference
func (x *MessageTransform) GetAiInference() *AIInferencefunc (*MessageTransform) GetCompression
func (x *MessageTransform) GetCompression() *Compressionfunc (*MessageTransform) GetDisabled
func (x *MessageTransform) GetDisabled() boolfunc (*MessageTransform) GetEnabled
func (x *MessageTransform) GetEnabled() boolDeprecated: Marked as deprecated in google/pubsub/v1/pubsub.proto.
func (*MessageTransform) GetJavascriptUdf
func (x *MessageTransform) GetJavascriptUdf() *JavaScriptUDFfunc (*MessageTransform) GetTransform
func (x *MessageTransform) GetTransform() isMessageTransform_Transformfunc (*MessageTransform) ProtoMessage
func (*MessageTransform) ProtoMessage()func (*MessageTransform) ProtoReflect
func (x *MessageTransform) ProtoReflect() protoreflect.Messagefunc (*MessageTransform) Reset
func (x *MessageTransform) Reset()func (*MessageTransform) String
func (x *MessageTransform) String() stringMessageTransform_AiInference
type MessageTransform_AiInference struct {
// Optional. AI Inference. Specifies the Vertex AI endpoint that inference
// requests built from the Pub/Sub message data and provided parameters will
// be sent to.
AiInference *AIInference `protobuf:"bytes,6,opt,name=ai_inference,json=aiInference,proto3,oneof"`
}MessageTransform_Compression
type MessageTransform_Compression struct {
// Optional. Compression/Decompression.
Compression *Compression `protobuf:"bytes,7,opt,name=compression,proto3,oneof"`
}MessageTransform_JavascriptUdf
type MessageTransform_JavascriptUdf struct {
// Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's
// are specified on a resource, each must have a unique `function_name`.
JavascriptUdf *JavaScriptUDF `protobuf:"bytes,2,opt,name=javascript_udf,json=javascriptUdf,proto3,oneof"`
}ModifyAckDeadlineRequest
type ModifyAckDeadlineRequest struct {
// Required. The name of the subscription.
// Format is `projects/{project}/subscriptions/{sub}`.
Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// Required. List of acknowledgment IDs.
AckIds []string `protobuf:"bytes,4,rep,name=ack_ids,json=ackIds,proto3" json:"ack_ids,omitempty"`
// Required. The new ack deadline with respect to the time this request was
// sent to the Pub/Sub system. For example, if the value is 10, the new ack
// deadline will expire 10 seconds after the `ModifyAckDeadline` call was
// made. Specifying zero might immediately make the message available for
// delivery to another subscriber client. This typically results in an
// increase in the rate of message redeliveries (that is, duplicates).
// The minimum deadline you can specify is 0 seconds.
// The maximum deadline you can specify in a single request is 600 seconds
// (10 minutes).
AckDeadlineSeconds int32 `protobuf:"varint,3,opt,name=ack_deadline_seconds,json=ackDeadlineSeconds,proto3" json:"ack_deadline_seconds,omitempty"`
// contains filtered or unexported fields
}Request for the ModifyAckDeadline method.
func (*ModifyAckDeadlineRequest) Descriptor
func (*ModifyAckDeadlineRequest) Descriptor() ([]byte, []int)Deprecated: Use ModifyAckDeadlineRequest.ProtoReflect.Descriptor instead.
func (*ModifyAckDeadlineRequest) GetAckDeadlineSeconds
func (x *ModifyAckDeadlineRequest) GetAckDeadlineSeconds() int32func (*ModifyAckDeadlineRequest) GetAckIds
func (x *ModifyAckDeadlineRequest) GetAckIds() []stringfunc (*ModifyAckDeadlineRequest) GetSubscription
func (x *ModifyAckDeadlineRequest) GetSubscription() stringfunc (*ModifyAckDeadlineRequest) ProtoMessage
func (*ModifyAckDeadlineRequest) ProtoMessage()func (*ModifyAckDeadlineRequest) ProtoReflect
func (x *ModifyAckDeadlineRequest) ProtoReflect() protoreflect.Messagefunc (*ModifyAckDeadlineRequest) Reset
func (x *ModifyAckDeadlineRequest) Reset()func (*ModifyAckDeadlineRequest) String
func (x *ModifyAckDeadlineRequest) String() stringModifyPushConfigRequest
type ModifyPushConfigRequest struct {
// Required. The name of the subscription.
// Format is `projects/{project}/subscriptions/{sub}`.
Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// Required. The push configuration for future deliveries.
//
// An empty `pushConfig` indicates that the Pub/Sub system should
// stop pushing messages from the given subscription and allow
// messages to be pulled and acknowledged - effectively pausing
// the subscription if `Pull` or `StreamingPull` is not called.
PushConfig *PushConfig `protobuf:"bytes,2,opt,name=push_config,json=pushConfig,proto3" json:"push_config,omitempty"`
// contains filtered or unexported fields
}Request for the ModifyPushConfig method.
func (*ModifyPushConfigRequest) Descriptor
func (*ModifyPushConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use ModifyPushConfigRequest.ProtoReflect.Descriptor instead.
func (*ModifyPushConfigRequest) GetPushConfig
func (x *ModifyPushConfigRequest) GetPushConfig() *PushConfigfunc (*ModifyPushConfigRequest) GetSubscription
func (x *ModifyPushConfigRequest) GetSubscription() stringfunc (*ModifyPushConfigRequest) ProtoMessage
func (*ModifyPushConfigRequest) ProtoMessage()func (*ModifyPushConfigRequest) ProtoReflect
func (x *ModifyPushConfigRequest) ProtoReflect() protoreflect.Messagefunc (*ModifyPushConfigRequest) Reset
func (x *ModifyPushConfigRequest) Reset()func (*ModifyPushConfigRequest) String
func (x *ModifyPushConfigRequest) String() stringPlatformLogsSettings
type PlatformLogsSettings struct {
// Optional. The minimum severity level of Platform Logs that will be written.
Severity PlatformLogsSettings_Severity `protobuf:"varint,1,opt,name=severity,proto3,enum=google.pubsub.v1.PlatformLogsSettings_Severity" json:"severity,omitempty"`
// contains filtered or unexported fields
}Settings for Platform Logs produced by Pub/Sub.
func (*PlatformLogsSettings) Descriptor
func (*PlatformLogsSettings) Descriptor() ([]byte, []int)Deprecated: Use PlatformLogsSettings.ProtoReflect.Descriptor instead.
func (*PlatformLogsSettings) GetSeverity
func (x *PlatformLogsSettings) GetSeverity() PlatformLogsSettings_Severityfunc (*PlatformLogsSettings) ProtoMessage
func (*PlatformLogsSettings) ProtoMessage()func (*PlatformLogsSettings) ProtoReflect
func (x *PlatformLogsSettings) ProtoReflect() protoreflect.Messagefunc (*PlatformLogsSettings) Reset
func (x *PlatformLogsSettings) Reset()func (*PlatformLogsSettings) String
func (x *PlatformLogsSettings) String() stringPlatformLogsSettings_Severity
type PlatformLogsSettings_Severity int32Severity levels of Platform Logs.
PlatformLogsSettings_SEVERITY_UNSPECIFIED, PlatformLogsSettings_DISABLED, PlatformLogsSettings_DEBUG, PlatformLogsSettings_INFO, PlatformLogsSettings_WARNING, PlatformLogsSettings_ERROR
const (
// Default value. Logs level is unspecified. Logs will be disabled.
PlatformLogsSettings_SEVERITY_UNSPECIFIED PlatformLogsSettings_Severity = 0
// Logs will be disabled.
PlatformLogsSettings_DISABLED PlatformLogsSettings_Severity = 1
// Debug logs and higher-severity logs will be written.
PlatformLogsSettings_DEBUG PlatformLogsSettings_Severity = 2
// Info logs and higher-severity logs will be written.
PlatformLogsSettings_INFO PlatformLogsSettings_Severity = 3
// Warning logs and higher-severity logs will be written.
PlatformLogsSettings_WARNING PlatformLogsSettings_Severity = 4
// Only error logs will be written.
PlatformLogsSettings_ERROR PlatformLogsSettings_Severity = 5
)func (PlatformLogsSettings_Severity) Descriptor
func (PlatformLogsSettings_Severity) Descriptor() protoreflect.EnumDescriptorfunc (PlatformLogsSettings_Severity) Enum
func (x PlatformLogsSettings_Severity) Enum() *PlatformLogsSettings_Severityfunc (PlatformLogsSettings_Severity) EnumDescriptor
func (PlatformLogsSettings_Severity) EnumDescriptor() ([]byte, []int)Deprecated: Use PlatformLogsSettings_Severity.Descriptor instead.
func (PlatformLogsSettings_Severity) Number
func (x PlatformLogsSettings_Severity) Number() protoreflect.EnumNumberfunc (PlatformLogsSettings_Severity) String
func (x PlatformLogsSettings_Severity) String() stringfunc (PlatformLogsSettings_Severity) Type
func (PlatformLogsSettings_Severity) Type() protoreflect.EnumTypePublishRequest
type PublishRequest struct {
// Required. The messages in the request will be published on this topic.
// Format is `projects/{project}/topics/{topic}`.
Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
// Required. The messages to publish.
Messages []*PubsubMessage `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
// contains filtered or unexported fields
}Request for the Publish method.
func (*PublishRequest) Descriptor
func (*PublishRequest) Descriptor() ([]byte, []int)Deprecated: Use PublishRequest.ProtoReflect.Descriptor instead.
func (*PublishRequest) GetMessages
func (x *PublishRequest) GetMessages() []*PubsubMessagefunc (*PublishRequest) GetTopic
func (x *PublishRequest) GetTopic() stringfunc (*PublishRequest) ProtoMessage
func (*PublishRequest) ProtoMessage()func (*PublishRequest) ProtoReflect
func (x *PublishRequest) ProtoReflect() protoreflect.Messagefunc (*PublishRequest) Reset
func (x *PublishRequest) Reset()func (*PublishRequest) String
func (x *PublishRequest) String() stringPublishResponse
type PublishResponse struct {
// Optional. The server-assigned ID of each published message, in the same
// order as the messages in the request. IDs are guaranteed to be unique
// within the topic.
MessageIds []string `protobuf:"bytes,1,rep,name=message_ids,json=messageIds,proto3" json:"message_ids,omitempty"`
// contains filtered or unexported fields
}Response for the Publish method.
func (*PublishResponse) Descriptor
func (*PublishResponse) Descriptor() ([]byte, []int)Deprecated: Use PublishResponse.ProtoReflect.Descriptor instead.
func (*PublishResponse) GetMessageIds
func (x *PublishResponse) GetMessageIds() []stringfunc (*PublishResponse) ProtoMessage
func (*PublishResponse) ProtoMessage()func (*PublishResponse) ProtoReflect
func (x *PublishResponse) ProtoReflect() protoreflect.Messagefunc (*PublishResponse) Reset
func (x *PublishResponse) Reset()func (*PublishResponse) String
func (x *PublishResponse) String() stringPublisherClient
type PublisherClient interface {
// Creates the given topic with the given name. See the [resource name rules]
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
CreateTopic(ctx context.Context, in *Topic, opts ...grpc.CallOption) (*Topic, error)
// Updates an existing topic by updating the fields specified in the update
// mask. Note that certain properties of a topic are not modifiable.
UpdateTopic(ctx context.Context, in *UpdateTopicRequest, opts ...grpc.CallOption) (*Topic, error)
// Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
// does not exist.
Publish(ctx context.Context, in *PublishRequest, opts ...grpc.CallOption) (*PublishResponse, error)
// Gets the configuration of a topic.
GetTopic(ctx context.Context, in *GetTopicRequest, opts ...grpc.CallOption) (*Topic, error)
// Lists matching topics.
ListTopics(ctx context.Context, in *ListTopicsRequest, opts ...grpc.CallOption) (*ListTopicsResponse, error)
// Lists the names of the attached subscriptions on this topic.
ListTopicSubscriptions(ctx context.Context, in *ListTopicSubscriptionsRequest, opts ...grpc.CallOption) (*ListTopicSubscriptionsResponse, error)
// Lists the names of the snapshots on this topic. Snapshots are used in
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
// which allow you to manage message acknowledgments in bulk. That is, you can
// set the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
ListTopicSnapshots(ctx context.Context, in *ListTopicSnapshotsRequest, opts ...grpc.CallOption) (*ListTopicSnapshotsResponse, error)
// Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
// does not exist. After a topic is deleted, a new topic may be created with
// the same name; this is an entirely new topic with none of the old
// configuration or subscriptions. Existing subscriptions to this topic are
// not deleted, but their `topic` field is set to `_deleted-topic_`.
DeleteTopic(ctx context.Context, in *DeleteTopicRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Detaches a subscription from this topic. All messages retained in the
// subscription are dropped. Subsequent `Pull` and `StreamingPull` requests
// will return FAILED_PRECONDITION. If the subscription is a push
// subscription, pushes to the endpoint will stop.
DetachSubscription(ctx context.Context, in *DetachSubscriptionRequest, opts ...grpc.CallOption) (*DetachSubscriptionResponse, error)
}PublisherClient is the client API for Publisher service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewPublisherClient
func NewPublisherClient(cc grpc.ClientConnInterface) PublisherClientPublisherServer
type PublisherServer interface {
// Creates the given topic with the given name. See the [resource name rules]
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
CreateTopic(context.Context, *Topic) (*Topic, error)
// Updates an existing topic by updating the fields specified in the update
// mask. Note that certain properties of a topic are not modifiable.
UpdateTopic(context.Context, *UpdateTopicRequest) (*Topic, error)
// Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
// does not exist.
Publish(context.Context, *PublishRequest) (*PublishResponse, error)
// Gets the configuration of a topic.
GetTopic(context.Context, *GetTopicRequest) (*Topic, error)
// Lists matching topics.
ListTopics(context.Context, *ListTopicsRequest) (*ListTopicsResponse, error)
// Lists the names of the attached subscriptions on this topic.
ListTopicSubscriptions(context.Context, *ListTopicSubscriptionsRequest) (*ListTopicSubscriptionsResponse, error)
// Lists the names of the snapshots on this topic. Snapshots are used in
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
// which allow you to manage message acknowledgments in bulk. That is, you can
// set the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
ListTopicSnapshots(context.Context, *ListTopicSnapshotsRequest) (*ListTopicSnapshotsResponse, error)
// Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
// does not exist. After a topic is deleted, a new topic may be created with
// the same name; this is an entirely new topic with none of the old
// configuration or subscriptions. Existing subscriptions to this topic are
// not deleted, but their `topic` field is set to `_deleted-topic_`.
DeleteTopic(context.Context, *DeleteTopicRequest) (*emptypb.Empty, error)
// Detaches a subscription from this topic. All messages retained in the
// subscription are dropped. Subsequent `Pull` and `StreamingPull` requests
// will return FAILED_PRECONDITION. If the subscription is a push
// subscription, pushes to the endpoint will stop.
DetachSubscription(context.Context, *DetachSubscriptionRequest) (*DetachSubscriptionResponse, error)
}PublisherServer is the server API for Publisher service. All implementations should embed UnimplementedPublisherServer for forward compatibility
PubsubMessage
type PubsubMessage struct {
// Optional. The message data field. If this field is empty, the message must
// contain at least one attribute.
Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// Optional. Attributes for this message. If this field is empty, the message
// must contain non-empty data. This can be used to filter messages on the
// subscription.
Attributes map[string]string `protobuf:"bytes,2,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// ID of this message, assigned by the server when the message is published.
// Guaranteed to be unique within the topic. This value may be read by a
// subscriber that receives a `PubsubMessage` via a `Pull` call or a push
// delivery. It must not be populated by the publisher in a `Publish` call.
MessageId string `protobuf:"bytes,3,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
// The time at which the message was published, populated by the server when
// it receives the `Publish` call. It must not be populated by the
// publisher in a `Publish` call.
PublishTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=publish_time,json=publishTime,proto3" json:"publish_time,omitempty"`
// Optional. If non-empty, identifies related messages for which publish order
// should be respected. If a `Subscription` has `enable_message_ordering` set
// to `true`, messages published with the same non-empty `ordering_key` value
// will be delivered to subscribers in the order in which they are received by
// the Pub/Sub system. All `PubsubMessage`s published in a given
// `PublishRequest` must specify the same `ordering_key` value. For more
// information, see [ordering
// messages](https://cloud.google.com/pubsub/docs/ordering).
OrderingKey string `protobuf:"bytes,5,opt,name=ordering_key,json=orderingKey,proto3" json:"ordering_key,omitempty"`
// contains filtered or unexported fields
}A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See quotas and limits for more information about message limits.
func (*PubsubMessage) Descriptor
func (*PubsubMessage) Descriptor() ([]byte, []int)Deprecated: Use PubsubMessage.ProtoReflect.Descriptor instead.
func (*PubsubMessage) GetAttributes
func (x *PubsubMessage) GetAttributes() map[string]stringfunc (*PubsubMessage) GetData
func (x *PubsubMessage) GetData() []bytefunc (*PubsubMessage) GetMessageId
func (x *PubsubMessage) GetMessageId() stringfunc (*PubsubMessage) GetOrderingKey
func (x *PubsubMessage) GetOrderingKey() stringfunc (*PubsubMessage) GetPublishTime
func (x *PubsubMessage) GetPublishTime() *timestamppb.Timestampfunc (*PubsubMessage) ProtoMessage
func (*PubsubMessage) ProtoMessage()func (*PubsubMessage) ProtoReflect
func (x *PubsubMessage) ProtoReflect() protoreflect.Messagefunc (*PubsubMessage) Reset
func (x *PubsubMessage) Reset()func (*PubsubMessage) String
func (x *PubsubMessage) String() stringPullRequest
type PullRequest struct {
// Required. The subscription from which messages should be pulled.
// Format is `projects/{project}/subscriptions/{sub}`.
Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// Optional. If this field set to true, the system will respond immediately
// even if it there are no messages available to return in the `Pull`
// response. Otherwise, the system may wait (for a bounded amount of time)
// until at least one message is available, rather than returning no messages.
// Warning: setting this field to `true` is discouraged because it adversely
// impacts the performance of `Pull` operations. We recommend that users do
// not set this field.
//
// Deprecated: Marked as deprecated in google/pubsub/v1/pubsub.proto.
ReturnImmediately bool `protobuf:"varint,2,opt,name=return_immediately,json=returnImmediately,proto3" json:"return_immediately,omitempty"`
// Required. The maximum number of messages to return for this request. Must
// be a positive integer. The Pub/Sub system may return fewer than the number
// specified.
MaxMessages int32 `protobuf:"varint,3,opt,name=max_messages,json=maxMessages,proto3" json:"max_messages,omitempty"`
// contains filtered or unexported fields
}Request for the Pull method.
func (*PullRequest) Descriptor
func (*PullRequest) Descriptor() ([]byte, []int)Deprecated: Use PullRequest.ProtoReflect.Descriptor instead.
func (*PullRequest) GetMaxMessages
func (x *PullRequest) GetMaxMessages() int32func (*PullRequest) GetReturnImmediately
func (x *PullRequest) GetReturnImmediately() boolDeprecated: Marked as deprecated in google/pubsub/v1/pubsub.proto.
func (*PullRequest) GetSubscription
func (x *PullRequest) GetSubscription() stringfunc (*PullRequest) ProtoMessage
func (*PullRequest) ProtoMessage()func (*PullRequest) ProtoReflect
func (x *PullRequest) ProtoReflect() protoreflect.Messagefunc (*PullRequest) Reset
func (x *PullRequest) Reset()func (*PullRequest) String
func (x *PullRequest) String() stringPullResponse
type PullResponse struct {
// Optional. Received Pub/Sub messages. The list will be empty if there are no
// more messages available in the backlog, or if no messages could be returned
// before the request timeout. For JSON, the response can be entirely
// empty. The Pub/Sub system may return fewer than the `maxMessages` requested
// even if there are more messages available in the backlog.
ReceivedMessages []*ReceivedMessage `protobuf:"bytes,1,rep,name=received_messages,json=receivedMessages,proto3" json:"received_messages,omitempty"`
// contains filtered or unexported fields
}Response for the Pull method.
func (*PullResponse) Descriptor
func (*PullResponse) Descriptor() ([]byte, []int)Deprecated: Use PullResponse.ProtoReflect.Descriptor instead.
func (*PullResponse) GetReceivedMessages
func (x *PullResponse) GetReceivedMessages() []*ReceivedMessagefunc (*PullResponse) ProtoMessage
func (*PullResponse) ProtoMessage()func (*PullResponse) ProtoReflect
func (x *PullResponse) ProtoReflect() protoreflect.Messagefunc (*PullResponse) Reset
func (x *PullResponse) Reset()func (*PullResponse) String
func (x *PullResponse) String() stringPushConfig
type PushConfig struct {
// Optional. A URL locating the endpoint to which messages should be pushed.
// For example, a Webhook endpoint might use `https://example.com/push`.
PushEndpoint string `protobuf:"bytes,1,opt,name=push_endpoint,json=pushEndpoint,proto3" json:"push_endpoint,omitempty"`
// Optional. Endpoint configuration attributes that can be used to control
// different aspects of the message delivery.
//
// The only currently supported attribute is `x-goog-version`, which you can
// use to change the format of the pushed message. This attribute
// indicates the version of the data expected by the endpoint. This
// controls the shape of the pushed message (i.e., its fields and metadata).
//
// If not present during the `CreateSubscription` call, it will default to
// the version of the Pub/Sub API used to make such call. If not present in a
// `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
// calls will always return a valid version, even if the subscription was
// created without this attribute.
//
// The only supported values for the `x-goog-version` attribute are:
//
// * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
// * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
//
// For example:
// `attributes { "x-goog-version": "v1" }`
Attributes map[string]string `protobuf:"bytes,2,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// 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 valid to be assigned 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 valid to be assigned to Wrapper:
//
// *PushConfig_PubsubWrapper_
// *PushConfig_NoWrapper_
Wrapper isPushConfig_Wrapper `protobuf_oneof:"wrapper"`
// contains filtered or unexported fields
}Configuration for a push delivery endpoint.
func (*PushConfig) Descriptor
func (*PushConfig) Descriptor() ([]byte, []int)Deprecated: Use PushConfig.ProtoReflect.Descriptor instead.
func (*PushConfig) GetAttributes
func (x *PushConfig) GetAttributes() map[string]stringfunc (*PushConfig) GetAuthenticationMethod
func (x *PushConfig) GetAuthenticationMethod() isPushConfig_AuthenticationMethodfunc (*PushConfig) GetNoWrapper
func (x *PushConfig) GetNoWrapper() *PushConfig_NoWrapperfunc (*PushConfig) GetOidcToken
func (x *PushConfig) GetOidcToken() *PushConfig_OidcTokenfunc (*PushConfig) GetPubsubWrapper
func (x *PushConfig) GetPubsubWrapper() *PushConfig_PubsubWrapperfunc (*PushConfig) GetPushEndpoint
func (x *PushConfig) GetPushEndpoint() stringfunc (*PushConfig) GetWrapper
func (x *PushConfig) GetWrapper() isPushConfig_Wrapperfunc (*PushConfig) ProtoMessage
func (*PushConfig) ProtoMessage()func (*PushConfig) ProtoReflect
func (x *PushConfig) ProtoReflect() protoreflect.Messagefunc (*PushConfig) Reset
func (x *PushConfig) Reset()func (*PushConfig) String
func (x *PushConfig) String() stringPushConfig_NoWrapper
type PushConfig_NoWrapper struct {
// Optional. When true, writes the Pub/Sub message metadata to
// `x-goog-pubsub-Sets the data field as the HTTP body for delivery.
func (*PushConfig_NoWrapper) Descriptor
func (*PushConfig_NoWrapper) Descriptor() ([]byte, []int)Deprecated: Use PushConfig_NoWrapper.ProtoReflect.Descriptor instead.
func (*PushConfig_NoWrapper) GetWriteMetadata
func (x *PushConfig_NoWrapper) GetWriteMetadata() boolfunc (*PushConfig_NoWrapper) ProtoMessage
func (*PushConfig_NoWrapper) ProtoMessage()func (*PushConfig_NoWrapper) ProtoReflect
func (x *PushConfig_NoWrapper) ProtoReflect() protoreflect.Messagefunc (*PushConfig_NoWrapper) Reset
func (x *PushConfig_NoWrapper) Reset()func (*PushConfig_NoWrapper) String
func (x *PushConfig_NoWrapper) String() stringPushConfig_NoWrapper_
type PushConfig_NoWrapper_ struct {
// Optional. When set, the payload to the push endpoint is not wrapped.
NoWrapper *PushConfig_NoWrapper `protobuf:"bytes,5,opt,name=no_wrapper,json=noWrapper,proto3,oneof"`
}PushConfig_OidcToken
type PushConfig_OidcToken struct {
// Optional. [Service account
// email](https://cloud.google.com/iam/docs/service-accounts)
// used for generating the OIDC token. For more information
// on setting up authentication, see
// [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
ServiceAccountEmail string `protobuf:"bytes,1,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// Optional. Audience to be used when generating OIDC token. The audience
// claim identifies the recipients that the JWT is intended for. The
// audience value is a single case-sensitive string. Having multiple values
// (array) for the audience field is not supported. More info about the OIDC
// JWT token audience here:
// https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified,
// the Push endpoint URL will be used.
Audience string `protobuf:"bytes,2,opt,name=audience,proto3" json:"audience,omitempty"`
// contains filtered or unexported fields
}Contains information needed for generating an OpenID Connect token.
func (*PushConfig_OidcToken) Descriptor
func (*PushConfig_OidcToken) Descriptor() ([]byte, []int)Deprecated: Use PushConfig_OidcToken.ProtoReflect.Descriptor instead.
func (*PushConfig_OidcToken) GetAudience
func (x *PushConfig_OidcToken) GetAudience() stringfunc (*PushConfig_OidcToken) GetServiceAccountEmail
func (x *PushConfig_OidcToken) GetServiceAccountEmail() stringfunc (*PushConfig_OidcToken) ProtoMessage
func (*PushConfig_OidcToken) ProtoMessage()func (*PushConfig_OidcToken) ProtoReflect
func (x *PushConfig_OidcToken) ProtoReflect() protoreflect.Messagefunc (*PushConfig_OidcToken) Reset
func (x *PushConfig_OidcToken) Reset()func (*PushConfig_OidcToken) String
func (x *PushConfig_OidcToken) String() stringPushConfig_OidcToken_
type PushConfig_OidcToken_ struct {
// Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
// token as an `Authorization` header in the HTTP request for every pushed
// message.
OidcToken *PushConfig_OidcToken `protobuf:"bytes,3,opt,name=oidc_token,json=oidcToken,proto3,oneof"`
}PushConfig_PubsubWrapper
type PushConfig_PubsubWrapper struct {
// contains filtered or unexported fields
}The payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
func (*PushConfig_PubsubWrapper) Descriptor
func (*PushConfig_PubsubWrapper) Descriptor() ([]byte, []int)Deprecated: Use PushConfig_PubsubWrapper.ProtoReflect.Descriptor instead.
func (*PushConfig_PubsubWrapper) ProtoMessage
func (*PushConfig_PubsubWrapper) ProtoMessage()func (*PushConfig_PubsubWrapper) ProtoReflect
func (x *PushConfig_PubsubWrapper) ProtoReflect() protoreflect.Messagefunc (*PushConfig_PubsubWrapper) Reset
func (x *PushConfig_PubsubWrapper) Reset()func (*PushConfig_PubsubWrapper) String
func (x *PushConfig_PubsubWrapper) String() stringPushConfig_PubsubWrapper_
type PushConfig_PubsubWrapper_ struct {
// Optional. When set, the payload to the push endpoint is in the form of
// the JSON representation of a PubsubMessage
// (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
PubsubWrapper *PushConfig_PubsubWrapper `protobuf:"bytes,4,opt,name=pubsub_wrapper,json=pubsubWrapper,proto3,oneof"`
}ReceivedMessage
type ReceivedMessage struct {
// Optional. This ID can be used to acknowledge the received message.
AckId string `protobuf:"bytes,1,opt,name=ack_id,json=ackId,proto3" json:"ack_id,omitempty"`
// Optional. The message.
Message *PubsubMessage `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// Optional. The approximate number of times that Pub/Sub has attempted to
// deliver the associated message to a subscriber.
//
// More precisely, this is 1 + (number of NACKs) +
// (number of ack_deadline exceeds) for this message.
//
// A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
// exceeds event is whenever a message is not acknowledged within
// ack_deadline. Note that ack_deadline is initially
// Subscription.ackDeadlineSeconds, but may get extended automatically by
// the client library.
//
// Upon the first delivery of a given message, `delivery_attempt` will have a
// value of 1. The value is calculated at best effort and is approximate.
//
// If a DeadLetterPolicy is not set on the subscription, this will be 0.
DeliveryAttempt int32 `protobuf:"varint,3,opt,name=delivery_attempt,json=deliveryAttempt,proto3" json:"delivery_attempt,omitempty"`
// contains filtered or unexported fields
}A message and its corresponding acknowledgment ID.
func (*ReceivedMessage) Descriptor
func (*ReceivedMessage) Descriptor() ([]byte, []int)Deprecated: Use ReceivedMessage.ProtoReflect.Descriptor instead.
func (*ReceivedMessage) GetAckId
func (x *ReceivedMessage) GetAckId() stringfunc (*ReceivedMessage) GetDeliveryAttempt
func (x *ReceivedMessage) GetDeliveryAttempt() int32func (*ReceivedMessage) GetMessage
func (x *ReceivedMessage) GetMessage() *PubsubMessagefunc (*ReceivedMessage) ProtoMessage
func (*ReceivedMessage) ProtoMessage()func (*ReceivedMessage) ProtoReflect
func (x *ReceivedMessage) ProtoReflect() protoreflect.Messagefunc (*ReceivedMessage) Reset
func (x *ReceivedMessage) Reset()func (*ReceivedMessage) String
func (x *ReceivedMessage) String() stringRetryPolicy
type RetryPolicy struct {
// Optional. The minimum delay between consecutive deliveries of a given
// message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
MinimumBackoff *durationpb.Duration `protobuf:"bytes,1,opt,name=minimum_backoff,json=minimumBackoff,proto3" json:"minimum_backoff,omitempty"`
// Optional. The maximum delay between consecutive deliveries of a given
// message. Value should be between 0 and 600 seconds. Defaults to 600
// seconds.
MaximumBackoff *durationpb.Duration `protobuf:"bytes,2,opt,name=maximum_backoff,json=maximumBackoff,proto3" json:"maximum_backoff,omitempty"`
// contains filtered or unexported fields
}A policy that specifies how Pub/Sub retries message delivery.
Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.
RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message.
Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.
func (*RetryPolicy) Descriptor
func (*RetryPolicy) Descriptor() ([]byte, []int)Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.
func (*RetryPolicy) GetMaximumBackoff
func (x *RetryPolicy) GetMaximumBackoff() *durationpb.Durationfunc (*RetryPolicy) GetMinimumBackoff
func (x *RetryPolicy) GetMinimumBackoff() *durationpb.Durationfunc (*RetryPolicy) ProtoMessage
func (*RetryPolicy) ProtoMessage()func (*RetryPolicy) ProtoReflect
func (x *RetryPolicy) ProtoReflect() protoreflect.Messagefunc (*RetryPolicy) Reset
func (x *RetryPolicy) Reset()func (*RetryPolicy) String
func (x *RetryPolicy) String() stringRollbackSchemaRequest
type RollbackSchemaRequest struct {
// Required. The schema being rolled back with revision id.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The revision ID to roll back to.
// It must be a revision of the same schema.
//
// Example: c7cfa2a8
RevisionId string `protobuf:"bytes,2,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
// contains filtered or unexported fields
}Request for the RollbackSchema method.
func (*RollbackSchemaRequest) Descriptor
func (*RollbackSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use RollbackSchemaRequest.ProtoReflect.Descriptor instead.
func (*RollbackSchemaRequest) GetName
func (x *RollbackSchemaRequest) GetName() stringfunc (*RollbackSchemaRequest) GetRevisionId
func (x *RollbackSchemaRequest) GetRevisionId() stringfunc (*RollbackSchemaRequest) ProtoMessage
func (*RollbackSchemaRequest) ProtoMessage()func (*RollbackSchemaRequest) ProtoReflect
func (x *RollbackSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*RollbackSchemaRequest) Reset
func (x *RollbackSchemaRequest) Reset()func (*RollbackSchemaRequest) String
func (x *RollbackSchemaRequest) String() stringSchema
type Schema struct {
// Required. Name of the schema.
// Format is `projects/{project}/schemas/{schema}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The type of the schema definition.
Type Schema_Type `protobuf:"varint,2,opt,name=type,proto3,enum=google.pubsub.v1.Schema_Type" json:"type,omitempty"`
// The definition of the schema. This should contain a string representing
// the full definition of the schema that is a valid schema definition of
// the type specified in `type`.
Definition string `protobuf:"bytes,3,opt,name=definition,proto3" json:"definition,omitempty"`
// The configuration of the schema.
// This field is mutually exclusive with the `definition` field above, meaning
// either `definition` or one of the fields below can be set in a valid Schema
// object.
//
// Types that are valid to be assigned to Configuration:
//
// *Schema_CompiledProtoSchema
Configuration isSchema_Configuration `protobuf_oneof:"configuration"`
// Output only. Immutable. The revision ID of the schema.
RevisionId string `protobuf:"bytes,4,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
// Output only. The timestamp that the revision was created.
RevisionCreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=revision_create_time,json=revisionCreateTime,proto3" json:"revision_create_time,omitempty"`
// contains filtered or unexported fields
}A schema resource.
func (*Schema) Descriptor
Deprecated: Use Schema.ProtoReflect.Descriptor instead.
func (*Schema) GetCompiledProtoSchema
func (x *Schema) GetCompiledProtoSchema() *CompiledProtoSchemafunc (*Schema) GetConfiguration
func (x *Schema) GetConfiguration() isSchema_Configurationfunc (*Schema) GetDefinition
func (*Schema) GetName
func (*Schema) GetRevisionCreateTime
func (x *Schema) GetRevisionCreateTime() *timestamppb.Timestampfunc (*Schema) GetRevisionId
func (*Schema) GetType
func (x *Schema) GetType() Schema_Typefunc (*Schema) ProtoMessage
func (*Schema) ProtoMessage()func (*Schema) ProtoReflect
func (x *Schema) ProtoReflect() protoreflect.Messagefunc (*Schema) Reset
func (x *Schema) Reset()func (*Schema) String
SchemaServiceClient
type SchemaServiceClient interface {
// Creates a schema.
CreateSchema(ctx context.Context, in *CreateSchemaRequest, opts ...grpc.CallOption) (*Schema, error)
// Gets a schema.
GetSchema(ctx context.Context, in *GetSchemaRequest, opts ...grpc.CallOption) (*Schema, error)
// Lists schemas in a project.
ListSchemas(ctx context.Context, in *ListSchemasRequest, opts ...grpc.CallOption) (*ListSchemasResponse, error)
// Lists all schema revisions for the named schema.
ListSchemaRevisions(ctx context.Context, in *ListSchemaRevisionsRequest, opts ...grpc.CallOption) (*ListSchemaRevisionsResponse, error)
// Commits a new schema revision to an existing schema.
CommitSchema(ctx context.Context, in *CommitSchemaRequest, opts ...grpc.CallOption) (*Schema, error)
// Creates a new schema revision that is a copy of the provided revision_id.
RollbackSchema(ctx context.Context, in *RollbackSchemaRequest, opts ...grpc.CallOption) (*Schema, error)
// Deletes a specific schema revision.
DeleteSchemaRevision(ctx context.Context, in *DeleteSchemaRevisionRequest, opts ...grpc.CallOption) (*Schema, error)
// Deletes a schema.
DeleteSchema(ctx context.Context, in *DeleteSchemaRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Validates a schema.
ValidateSchema(ctx context.Context, in *ValidateSchemaRequest, opts ...grpc.CallOption) (*ValidateSchemaResponse, error)
// Validates a message against a schema.
ValidateMessage(ctx context.Context, in *ValidateMessageRequest, opts ...grpc.CallOption) (*ValidateMessageResponse, error)
}SchemaServiceClient is the client API for SchemaService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSchemaServiceClient
func NewSchemaServiceClient(cc grpc.ClientConnInterface) SchemaServiceClientSchemaServiceServer
type SchemaServiceServer interface {
// Creates a schema.
CreateSchema(context.Context, *CreateSchemaRequest) (*Schema, error)
// Gets a schema.
GetSchema(context.Context, *GetSchemaRequest) (*Schema, error)
// Lists schemas in a project.
ListSchemas(context.Context, *ListSchemasRequest) (*ListSchemasResponse, error)
// Lists all schema revisions for the named schema.
ListSchemaRevisions(context.Context, *ListSchemaRevisionsRequest) (*ListSchemaRevisionsResponse, error)
// Commits a new schema revision to an existing schema.
CommitSchema(context.Context, *CommitSchemaRequest) (*Schema, error)
// Creates a new schema revision that is a copy of the provided revision_id.
RollbackSchema(context.Context, *RollbackSchemaRequest) (*Schema, error)
// Deletes a specific schema revision.
DeleteSchemaRevision(context.Context, *DeleteSchemaRevisionRequest) (*Schema, error)
// Deletes a schema.
DeleteSchema(context.Context, *DeleteSchemaRequest) (*emptypb.Empty, error)
// Validates a schema.
ValidateSchema(context.Context, *ValidateSchemaRequest) (*ValidateSchemaResponse, error)
// Validates a message against a schema.
ValidateMessage(context.Context, *ValidateMessageRequest) (*ValidateMessageResponse, error)
}SchemaServiceServer is the server API for SchemaService service. All implementations should embed UnimplementedSchemaServiceServer for forward compatibility
SchemaSettings
type SchemaSettings struct {
// Required. The name of the schema that messages published should be
// validated against. Format is `projects/{project}/schemas/{schema}`. The
// value of this field will be `_deleted-schema_` if the schema has been
// deleted.
Schema string `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
// Optional. The encoding of messages validated against `schema`.
Encoding Encoding `protobuf:"varint,2,opt,name=encoding,proto3,enum=google.pubsub.v1.Encoding" json:"encoding,omitempty"`
// Optional. The minimum (inclusive) revision allowed for validating messages.
// If empty or not present, allow any revision to be validated against
// last_revision or any revision created before.
FirstRevisionId string `protobuf:"bytes,3,opt,name=first_revision_id,json=firstRevisionId,proto3" json:"first_revision_id,omitempty"`
// Optional. The maximum (inclusive) revision allowed for validating messages.
// If empty or not present, allow any revision to be validated against
// first_revision or any revision created after.
LastRevisionId string `protobuf:"bytes,4,opt,name=last_revision_id,json=lastRevisionId,proto3" json:"last_revision_id,omitempty"`
// contains filtered or unexported fields
}Settings for validating messages published against a schema.
func (*SchemaSettings) Descriptor
func (*SchemaSettings) Descriptor() ([]byte, []int)Deprecated: Use SchemaSettings.ProtoReflect.Descriptor instead.
func (*SchemaSettings) GetEncoding
func (x *SchemaSettings) GetEncoding() Encodingfunc (*SchemaSettings) GetFirstRevisionId
func (x *SchemaSettings) GetFirstRevisionId() stringfunc (*SchemaSettings) GetLastRevisionId
func (x *SchemaSettings) GetLastRevisionId() stringfunc (*SchemaSettings) GetSchema
func (x *SchemaSettings) GetSchema() stringfunc (*SchemaSettings) ProtoMessage
func (*SchemaSettings) ProtoMessage()func (*SchemaSettings) ProtoReflect
func (x *SchemaSettings) ProtoReflect() protoreflect.Messagefunc (*SchemaSettings) Reset
func (x *SchemaSettings) Reset()func (*SchemaSettings) String
func (x *SchemaSettings) String() stringSchemaView
type SchemaView int32View of Schema object fields to be returned by GetSchema and ListSchemas.
SchemaView_SCHEMA_VIEW_UNSPECIFIED, SchemaView_BASIC, SchemaView_FULL
const (
// The default / unset value.
// The API will default to the BASIC view.
SchemaView_SCHEMA_VIEW_UNSPECIFIED SchemaView = 0
// Include the name and type of the schema, but not the definition.
SchemaView_BASIC SchemaView = 1
// Include all Schema object fields.
SchemaView_FULL SchemaView = 2
)func (SchemaView) Descriptor
func (SchemaView) Descriptor() protoreflect.EnumDescriptorfunc (SchemaView) Enum
func (x SchemaView) Enum() *SchemaViewfunc (SchemaView) EnumDescriptor
func (SchemaView) EnumDescriptor() ([]byte, []int)Deprecated: Use SchemaView.Descriptor instead.
func (SchemaView) Number
func (x SchemaView) Number() protoreflect.EnumNumberfunc (SchemaView) String
func (x SchemaView) String() stringfunc (SchemaView) Type
func (SchemaView) Type() protoreflect.EnumTypeSchema_CompiledProtoSchema
type Schema_CompiledProtoSchema struct {
// Optional. Configuration for a schema provided as a pre-compiled Protocol
// Buffer FileDescriptorSet. The `type` field above must be set to
// PROTOCOL_BUFFER.
CompiledProtoSchema *CompiledProtoSchema `protobuf:"bytes,8,opt,name=compiled_proto_schema,json=compiledProtoSchema,proto3,oneof"`
}Schema_Type
type Schema_Type int32Possible schema definition types.
Schema_TYPE_UNSPECIFIED, Schema_PROTOCOL_BUFFER, Schema_AVRO
const (
// Default value. This value is unused.
Schema_TYPE_UNSPECIFIED Schema_Type = 0
// A Protocol Buffer schema definition.
Schema_PROTOCOL_BUFFER Schema_Type = 1
// An Avro schema definition.
Schema_AVRO Schema_Type = 2
)func (Schema_Type) Descriptor
func (Schema_Type) Descriptor() protoreflect.EnumDescriptorfunc (Schema_Type) Enum
func (x Schema_Type) Enum() *Schema_Typefunc (Schema_Type) EnumDescriptor
func (Schema_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use Schema_Type.Descriptor instead.
func (Schema_Type) Number
func (x Schema_Type) Number() protoreflect.EnumNumberfunc (Schema_Type) String
func (x Schema_Type) String() stringfunc (Schema_Type) Type
func (Schema_Type) Type() protoreflect.EnumTypeSeekRequest
type SeekRequest struct {
// Required. The subscription to affect.
Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// Types that are valid to be assigned to Target:
//
// *SeekRequest_Time
// *SeekRequest_Snapshot
Target isSeekRequest_Target `protobuf_oneof:"target"`
// contains filtered or unexported fields
}Request for the Seek method.
func (*SeekRequest) Descriptor
func (*SeekRequest) Descriptor() ([]byte, []int)Deprecated: Use SeekRequest.ProtoReflect.Descriptor instead.
func (*SeekRequest) GetSnapshot
func (x *SeekRequest) GetSnapshot() stringfunc (*SeekRequest) GetSubscription
func (x *SeekRequest) GetSubscription() stringfunc (*SeekRequest) GetTarget
func (x *SeekRequest) GetTarget() isSeekRequest_Targetfunc (*SeekRequest) GetTime
func (x *SeekRequest) GetTime() *timestamppb.Timestampfunc (*SeekRequest) ProtoMessage
func (*SeekRequest) ProtoMessage()func (*SeekRequest) ProtoReflect
func (x *SeekRequest) ProtoReflect() protoreflect.Messagefunc (*SeekRequest) Reset
func (x *SeekRequest) Reset()func (*SeekRequest) String
func (x *SeekRequest) String() stringSeekRequest_Snapshot
type SeekRequest_Snapshot struct {
// Optional. The snapshot to seek to. The snapshot's topic must be the same
// as that of the provided subscription. Format is
// `projects/{project}/snapshots/{snap}`.
Snapshot string `protobuf:"bytes,3,opt,name=snapshot,proto3,oneof"`
}SeekRequest_Time
type SeekRequest_Time struct {
// Optional. The time to seek to.
// Messages retained in the subscription that were published before this
// time are marked as acknowledged, and messages retained in the
// subscription that were published after this time are marked as
// unacknowledged. Note that this operation affects only those messages
// retained in the subscription (configured by the combination of
// `message_retention_duration` and `retain_acked_messages`). For example,
// if `time` corresponds to a point before the message retention
// window (or to a point before the system's notion of the subscription
// creation time), only retained messages will be marked as unacknowledged,
// and already-expunged messages will not be restored.
Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3,oneof"`
}SeekResponse
type SeekResponse struct {
// contains filtered or unexported fields
}Response for the Seek method (this response is empty).
func (*SeekResponse) Descriptor
func (*SeekResponse) Descriptor() ([]byte, []int)Deprecated: Use SeekResponse.ProtoReflect.Descriptor instead.
func (*SeekResponse) ProtoMessage
func (*SeekResponse) ProtoMessage()func (*SeekResponse) ProtoReflect
func (x *SeekResponse) ProtoReflect() protoreflect.Messagefunc (*SeekResponse) Reset
func (x *SeekResponse) Reset()func (*SeekResponse) String
func (x *SeekResponse) String() stringSnapshot
type Snapshot struct {
// Optional. The name of the snapshot.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The name of the topic from which this snapshot is retaining
// messages.
Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
// Optional. The snapshot is guaranteed to exist up until this time.
// A newly-created snapshot expires no later than 7 days from the time of its
// creation. Its exact lifetime is determined at creation by the existing
// backlog in the source subscription. Specifically, the lifetime of the
// snapshot is `7 days - (age of oldest unacked message in the subscription)`.
// For example, consider a subscription whose oldest unacked message is 3 days
// old. If a snapshot is created from this subscription, the snapshot -- which
// will always capture this 3-day-old backlog as long as the snapshot
// exists -- will expire in 4 days. The service will refuse to create a
// snapshot that would expire in less than 1 hour after creation.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// Optional. See [Creating and managing labels]
// (https://cloud.google.com/pubsub/docs/labels).
Labels map[string]string `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}A snapshot resource. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
func (*Snapshot) Descriptor
Deprecated: Use Snapshot.ProtoReflect.Descriptor instead.
func (*Snapshot) GetExpireTime
func (x *Snapshot) GetExpireTime() *timestamppb.Timestampfunc (*Snapshot) GetLabels
func (*Snapshot) GetName
func (*Snapshot) GetTopic
func (*Snapshot) ProtoMessage
func (*Snapshot) ProtoMessage()func (*Snapshot) ProtoReflect
func (x *Snapshot) ProtoReflect() protoreflect.Messagefunc (*Snapshot) Reset
func (x *Snapshot) Reset()func (*Snapshot) String
StreamingPullRequest
type StreamingPullRequest struct {
// Required. The subscription for which to initialize the new stream. This
// must be provided in the first request on the stream, and must not be set in
// subsequent requests from client to server.
// Format is `projects/{project}/subscriptions/{sub}`.
Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// Optional. List of acknowledgment IDs for acknowledging previously received
// messages (received on this stream or a different stream). If an ack ID has
// expired, the corresponding message may be redelivered later. Acknowledging
// a message more than once will not result in an error. If the acknowledgment
// ID is malformed, the stream will be aborted with status `INVALID_ARGUMENT`.
AckIds []string `protobuf:"bytes,2,rep,name=ack_ids,json=ackIds,proto3" json:"ack_ids,omitempty"`
// Optional. The list of new ack deadlines for the IDs listed in
// `modify_deadline_ack_ids`. The size of this list must be the same as the
// size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
// with `INVALID_ARGUMENT`. Each element in this list is applied to the
// element in the same position in `modify_deadline_ack_ids`. The new ack
// deadline is with respect to the time this request was sent to the Pub/Sub
// system. Must be >= 0. For example, if the value is 10, the new ack deadline
// will expire 10 seconds after this request is received. If the value is 0,
// the message is immediately made available for another streaming or
// non-streaming pull request. If the value is < 0="" (an="" error),="" the="" stream="" will="" be="" aborted="" with="" status="" `invalid_argument`.="" modifydeadlineseconds="">int32 `protobuf:"varint,3,rep,packed,name=modify_deadline_seconds,json=modifyDeadlineSeconds,proto3" json:"modify_deadline_seconds,omitempty"`
// Optional. List of acknowledgment IDs whose deadline will be modified based
// on the corresponding element in `modify_deadline_seconds`. This field can
// be used to indicate that more time is needed to process a message by the
// subscriber, or to make the message available for redelivery if the
// processing was interrupted.
ModifyDeadlineAckIds []string `protobuf:"bytes,4,rep,name=modify_deadline_ack_ids,json=modifyDeadlineAckIds,proto3" json:"modify_deadline_ack_ids,omitempty"`
// Required. The ack deadline to use for the stream. This must be provided in
// the first request on the stream, but it can also be updated on subsequent
// requests from client to server. The minimum deadline you can specify is 10
// seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
StreamAckDeadlineSeconds int32 `protobuf:"varint,5,opt,name=stream_ack_deadline_seconds,json=streamAckDeadlineSeconds,proto3" json:"stream_ack_deadline_seconds,omitempty"`
// Optional. A unique identifier that is used to distinguish client instances
// from each other. Only needs to be provided on the initial request. When a
// stream disconnects and reconnects for the same stream, the client_id should
// be set to the same value so that state associated with the old stream can
// be transferred to the new stream. The same client_id should not be used for
// different client instances.
ClientId string `protobuf:"bytes,6,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
// Optional. Flow control settings for the maximum number of outstanding
// messages. When there are `max_outstanding_messages` currently sent to the
// streaming pull client that have not yet been acked or nacked, the server
// stops sending more messages. The sending of messages resumes once the
// number of outstanding messages is less than this value. If the value is
// <= 0,="" there="" is="" no="" limit="" to="" the="" number="" of="" outstanding="" messages.="" this="" property="" can="" only="" be="" set="" on="" the="" initial="" streamingpullrequest.="" if="" it="" is="" set="" on="" a="" subsequent="" request,="" the="" stream="" will="" be="" aborted="" with="" status="" `invalid_argument`.="" maxoutstandingmessages="">int64 `protobuf:"varint,7,opt,name=max_outstanding_messages,json=maxOutstandingMessages,proto3" json:"max_outstanding_messages,omitempty"`
// Optional. Flow control settings for the maximum number of outstanding
// bytes. When there are `max_outstanding_bytes` or more worth of messages
// currently sent to the streaming pull client that have not yet been acked or
// nacked, the server will stop sending more messages. The sending of messages
// resumes once the number of outstanding bytes is less than this value. If
// the value is <= 0,="" there="" is="" no="" limit="" to="" the="" number="" of="" outstanding="" bytes.="" this="" property="" can="" only="" be="" set="" on="" the="" initial="" streamingpullrequest.="" if="" it="" is="" set="" on="" a="" subsequent="" request,="" the="" stream="" will="" be="" aborted="" with="" status="" `invalid_argument`.="" maxoutstandingbytes="">int64 `protobuf:"varint,8,opt,name=max_outstanding_bytes,json=maxOutstandingBytes,proto3" json:"max_outstanding_bytes,omitempty"`
// Optional. The protocol version used by the client. This property can only
// be set on the initial StreamingPullRequest. If it is set on a subsequent
// request, the stream will be aborted with status `INVALID_ARGUMENT`.
ProtocolVersion int64 `protobuf:"varint,10,opt,name=protocol_version,json=protocolVersion,proto3" json:"protocol_version,omitempty"`
// contains filtered or unexported fields
}Request for the StreamingPull streaming RPC method. This request is used to
establish the initial stream as well as to stream acknowledgments and ack
deadline modifications from the client to the server.
func (*StreamingPullRequest) Descriptor
func (*StreamingPullRequest) Descriptor() ([]byte, []int)Deprecated: Use StreamingPullRequest.ProtoReflect.Descriptor instead.
func (*StreamingPullRequest) GetAckIds
func (x *StreamingPullRequest) GetAckIds() []stringfunc (*StreamingPullRequest) GetClientId
func (x *StreamingPullRequest) GetClientId() stringfunc (*StreamingPullRequest) GetMaxOutstandingBytes
func (x *StreamingPullRequest) GetMaxOutstandingBytes() int64func (*StreamingPullRequest) GetMaxOutstandingMessages
func (x *StreamingPullRequest) GetMaxOutstandingMessages() int64func (*StreamingPullRequest) GetModifyDeadlineAckIds
func (x *StreamingPullRequest) GetModifyDeadlineAckIds() []stringfunc (*StreamingPullRequest) GetModifyDeadlineSeconds
func (x *StreamingPullRequest) GetModifyDeadlineSeconds() []int32func (*StreamingPullRequest) GetProtocolVersion
func (x *StreamingPullRequest) GetProtocolVersion() int64func (*StreamingPullRequest) GetStreamAckDeadlineSeconds
func (x *StreamingPullRequest) GetStreamAckDeadlineSeconds() int32func (*StreamingPullRequest) GetSubscription
func (x *StreamingPullRequest) GetSubscription() stringfunc (*StreamingPullRequest) ProtoMessage
func (*StreamingPullRequest) ProtoMessage()func (*StreamingPullRequest) ProtoReflect
func (x *StreamingPullRequest) ProtoReflect() protoreflect.Messagefunc (*StreamingPullRequest) Reset
func (x *StreamingPullRequest) Reset()func (*StreamingPullRequest) String
func (x *StreamingPullRequest) String() stringStreamingPullResponse
type StreamingPullResponse struct {
// Optional. Received Pub/Sub messages.
ReceivedMessages []*ReceivedMessage `protobuf:"bytes,1,rep,name=received_messages,json=receivedMessages,proto3" json:"received_messages,omitempty"`
// Optional. This field will only be set if `enable_exactly_once_delivery` is
// set to `true` and is not guaranteed to be populated.
AcknowledgeConfirmation *StreamingPullResponse_AcknowledgeConfirmation `protobuf:"bytes,5,opt,name=acknowledge_confirmation,json=acknowledgeConfirmation,proto3" json:"acknowledge_confirmation,omitempty"`
// Optional. This field will only be set if `enable_exactly_once_delivery` is
// set to `true` and is not guaranteed to be populated.
ModifyAckDeadlineConfirmation *StreamingPullResponse_ModifyAckDeadlineConfirmation `protobuf:"bytes,3,opt,name=modify_ack_deadline_confirmation,json=modifyAckDeadlineConfirmation,proto3" json:"modify_ack_deadline_confirmation,omitempty"`
// Optional. Properties associated with this subscription.
SubscriptionProperties *StreamingPullResponse_SubscriptionProperties `protobuf:"bytes,4,opt,name=subscription_properties,json=subscriptionProperties,proto3" json:"subscription_properties,omitempty"`
// contains filtered or unexported fields
}Response for the StreamingPull method. This response is used to stream
messages from the server to the client.
func (*StreamingPullResponse) Descriptor
func (*StreamingPullResponse) Descriptor() ([]byte, []int)Deprecated: Use StreamingPullResponse.ProtoReflect.Descriptor instead.
func (*StreamingPullResponse) GetAcknowledgeConfirmation
func (x *StreamingPullResponse) GetAcknowledgeConfirmation() *StreamingPullResponse_AcknowledgeConfirmationfunc (*StreamingPullResponse) GetModifyAckDeadlineConfirmation
func (x *StreamingPullResponse) GetModifyAckDeadlineConfirmation() *StreamingPullResponse_ModifyAckDeadlineConfirmationfunc (*StreamingPullResponse) GetReceivedMessages
func (x *StreamingPullResponse) GetReceivedMessages() []*ReceivedMessagefunc (*StreamingPullResponse) GetSubscriptionProperties
func (x *StreamingPullResponse) GetSubscriptionProperties() *StreamingPullResponse_SubscriptionPropertiesfunc (*StreamingPullResponse) ProtoMessage
func (*StreamingPullResponse) ProtoMessage()func (*StreamingPullResponse) ProtoReflect
func (x *StreamingPullResponse) ProtoReflect() protoreflect.Messagefunc (*StreamingPullResponse) Reset
func (x *StreamingPullResponse) Reset()func (*StreamingPullResponse) String
func (x *StreamingPullResponse) String() stringStreamingPullResponse_AcknowledgeConfirmation
type StreamingPullResponse_AcknowledgeConfirmation struct {
// Optional. Successfully processed acknowledgment IDs.
AckIds []string `protobuf:"bytes,1,rep,name=ack_ids,json=ackIds,proto3" json:"ack_ids,omitempty"`
// Optional. List of acknowledgment IDs that were malformed or whose
// acknowledgment deadline has expired.
InvalidAckIds []string `protobuf:"bytes,2,rep,name=invalid_ack_ids,json=invalidAckIds,proto3" json:"invalid_ack_ids,omitempty"`
// Optional. List of acknowledgment IDs that were out of order.
UnorderedAckIds []string `protobuf:"bytes,3,rep,name=unordered_ack_ids,json=unorderedAckIds,proto3" json:"unordered_ack_ids,omitempty"`
// Optional. List of acknowledgment IDs that failed processing with
// temporary issues.
TemporaryFailedAckIds []string `protobuf:"bytes,4,rep,name=temporary_failed_ack_ids,json=temporaryFailedAckIds,proto3" json:"temporary_failed_ack_ids,omitempty"`
// contains filtered or unexported fields
}Acknowledgment IDs sent in one or more previous requests to acknowledge a previously received message.
func (*StreamingPullResponse_AcknowledgeConfirmation) Descriptor
func (*StreamingPullResponse_AcknowledgeConfirmation) Descriptor() ([]byte, []int)Deprecated: Use StreamingPullResponse_AcknowledgeConfirmation.ProtoReflect.Descriptor instead.
func (*StreamingPullResponse_AcknowledgeConfirmation) GetAckIds
func (x *StreamingPullResponse_AcknowledgeConfirmation) GetAckIds() []stringfunc (*StreamingPullResponse_AcknowledgeConfirmation) GetInvalidAckIds
func (x *StreamingPullResponse_AcknowledgeConfirmation) GetInvalidAckIds() []stringfunc (*StreamingPullResponse_AcknowledgeConfirmation) GetTemporaryFailedAckIds
func (x *StreamingPullResponse_AcknowledgeConfirmation) GetTemporaryFailedAckIds() []stringfunc (*StreamingPullResponse_AcknowledgeConfirmation) GetUnorderedAckIds
func (x *StreamingPullResponse_AcknowledgeConfirmation) GetUnorderedAckIds() []stringfunc (*StreamingPullResponse_AcknowledgeConfirmation) ProtoMessage
func (*StreamingPullResponse_AcknowledgeConfirmation) ProtoMessage()func (*StreamingPullResponse_AcknowledgeConfirmation) ProtoReflect
func (x *StreamingPullResponse_AcknowledgeConfirmation) ProtoReflect() protoreflect.Messagefunc (*StreamingPullResponse_AcknowledgeConfirmation) Reset
func (x *StreamingPullResponse_AcknowledgeConfirmation) Reset()func (*StreamingPullResponse_AcknowledgeConfirmation) String
func (x *StreamingPullResponse_AcknowledgeConfirmation) String() stringStreamingPullResponse_ModifyAckDeadlineConfirmation
type StreamingPullResponse_ModifyAckDeadlineConfirmation struct {
// Optional. Successfully processed acknowledgment IDs.
AckIds []string `protobuf:"bytes,1,rep,name=ack_ids,json=ackIds,proto3" json:"ack_ids,omitempty"`
// Optional. List of acknowledgment IDs that were malformed or whose
// acknowledgment deadline has expired.
InvalidAckIds []string `protobuf:"bytes,2,rep,name=invalid_ack_ids,json=invalidAckIds,proto3" json:"invalid_ack_ids,omitempty"`
// Optional. List of acknowledgment IDs that failed processing with
// temporary issues.
TemporaryFailedAckIds []string `protobuf:"bytes,3,rep,name=temporary_failed_ack_ids,json=temporaryFailedAckIds,proto3" json:"temporary_failed_ack_ids,omitempty"`
// contains filtered or unexported fields
}Acknowledgment IDs sent in one or more previous requests to modify the deadline for a specific message.
func (*StreamingPullResponse_ModifyAckDeadlineConfirmation) Descriptor
func (*StreamingPullResponse_ModifyAckDeadlineConfirmation) Descriptor() ([]byte, []int)Deprecated: Use StreamingPullResponse_ModifyAckDeadlineConfirmation.ProtoReflect.Descriptor instead.
func (*StreamingPullResponse_ModifyAckDeadlineConfirmation) GetAckIds
func (x *StreamingPullResponse_ModifyAckDeadlineConfirmation) GetAckIds() []stringfunc (*StreamingPullResponse_ModifyAckDeadlineConfirmation) GetInvalidAckIds
func (x *StreamingPullResponse_ModifyAckDeadlineConfirmation) GetInvalidAckIds() []stringfunc (*StreamingPullResponse_ModifyAckDeadlineConfirmation) GetTemporaryFailedAckIds
func (x *StreamingPullResponse_ModifyAckDeadlineConfirmation) GetTemporaryFailedAckIds() []stringfunc (*StreamingPullResponse_ModifyAckDeadlineConfirmation) ProtoMessage
func (*StreamingPullResponse_ModifyAckDeadlineConfirmation) ProtoMessage()func (*StreamingPullResponse_ModifyAckDeadlineConfirmation) ProtoReflect
func (x *StreamingPullResponse_ModifyAckDeadlineConfirmation) ProtoReflect() protoreflect.Messagefunc (*StreamingPullResponse_ModifyAckDeadlineConfirmation) Reset
func (x *StreamingPullResponse_ModifyAckDeadlineConfirmation) Reset()func (*StreamingPullResponse_ModifyAckDeadlineConfirmation) String
func (x *StreamingPullResponse_ModifyAckDeadlineConfirmation) String() stringStreamingPullResponse_SubscriptionProperties
type StreamingPullResponse_SubscriptionProperties struct {
// Optional. True iff exactly once delivery is enabled for this
// subscription.
ExactlyOnceDeliveryEnabled bool `protobuf:"varint,1,opt,name=exactly_once_delivery_enabled,json=exactlyOnceDeliveryEnabled,proto3" json:"exactly_once_delivery_enabled,omitempty"`
// Optional. True iff message ordering is enabled for this subscription.
MessageOrderingEnabled bool `protobuf:"varint,2,opt,name=message_ordering_enabled,json=messageOrderingEnabled,proto3" json:"message_ordering_enabled,omitempty"`
// contains filtered or unexported fields
}Subscription properties sent as part of the response.
func (*StreamingPullResponse_SubscriptionProperties) Descriptor
func (*StreamingPullResponse_SubscriptionProperties) Descriptor() ([]byte, []int)Deprecated: Use StreamingPullResponse_SubscriptionProperties.ProtoReflect.Descriptor instead.
func (*StreamingPullResponse_SubscriptionProperties) GetExactlyOnceDeliveryEnabled
func (x *StreamingPullResponse_SubscriptionProperties) GetExactlyOnceDeliveryEnabled() boolfunc (*StreamingPullResponse_SubscriptionProperties) GetMessageOrderingEnabled
func (x *StreamingPullResponse_SubscriptionProperties) GetMessageOrderingEnabled() boolfunc (*StreamingPullResponse_SubscriptionProperties) ProtoMessage
func (*StreamingPullResponse_SubscriptionProperties) ProtoMessage()func (*StreamingPullResponse_SubscriptionProperties) ProtoReflect
func (x *StreamingPullResponse_SubscriptionProperties) ProtoReflect() protoreflect.Messagefunc (*StreamingPullResponse_SubscriptionProperties) Reset
func (x *StreamingPullResponse_SubscriptionProperties) Reset()func (*StreamingPullResponse_SubscriptionProperties) String
func (x *StreamingPullResponse_SubscriptionProperties) String() stringSubscriberClient
type SubscriberClient interface {
// Creates a subscription to a given topic. See the [resource name rules]
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
// If the subscription already exists, returns `ALREADY_EXISTS`.
// If the corresponding topic doesn't exist, returns `NOT_FOUND`.
//
// If the name is not provided in the request, the server will assign a random
// name for this subscription on the same project as the topic, conforming
// to the [resource name format]
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
// generated name is populated in the returned Subscription object. Note that
// for REST API requests, you must specify a name in the request.
CreateSubscription(ctx context.Context, in *Subscription, opts ...grpc.CallOption) (*Subscription, error)
// Gets the configuration details of a subscription.
GetSubscription(ctx context.Context, in *GetSubscriptionRequest, opts ...grpc.CallOption) (*Subscription, error)
// Updates an existing subscription by updating the fields specified in the
// update mask. Note that certain properties of a subscription, such as its
// topic, are not modifiable.
UpdateSubscription(ctx context.Context, in *UpdateSubscriptionRequest, opts ...grpc.CallOption) (*Subscription, error)
// Lists matching subscriptions.
ListSubscriptions(ctx context.Context, in *ListSubscriptionsRequest, opts ...grpc.CallOption) (*ListSubscriptionsResponse, error)
// Deletes an existing subscription. All messages retained in the subscription
// are immediately dropped. Calls to `Pull` after deletion will return
// `NOT_FOUND`. After a subscription is deleted, a new one may be created with
// the same name, but the new one has no association with the old
// subscription or its topic unless the same topic is specified.
DeleteSubscription(ctx context.Context, in *DeleteSubscriptionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Modifies the ack deadline for a specific message. This method is useful
// to indicate that more time is needed to process a message by the
// subscriber, or to make the message available for redelivery if the
// processing was interrupted. Note that this does not modify the
// subscription-level `ackDeadlineSeconds` used for subsequent messages.
ModifyAckDeadline(ctx context.Context, in *ModifyAckDeadlineRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Acknowledges the messages associated with the `ack_ids` in the
// `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
// from the subscription.
//
// Acknowledging a message whose ack deadline has expired may succeed,
// but such a message may be redelivered later. Acknowledging a message more
// than once will not result in an error.
Acknowledge(ctx context.Context, in *AcknowledgeRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Pulls messages from the server.
Pull(ctx context.Context, in *PullRequest, opts ...grpc.CallOption) (*PullResponse, error)
// Establishes a stream with the server, which sends messages down to the
// client. The client streams acknowledgments and ack deadline modifications
// back to the server. The server will close the stream and return the status
// on any error. The server may close the stream with status `UNAVAILABLE` to
// reassign server-side resources, in which case, the client should
// re-establish the stream. Flow control can be achieved by configuring the
// underlying RPC channel.
StreamingPull(ctx context.Context, opts ...grpc.CallOption) (Subscriber_StreamingPullClient, error)
// Modifies the `PushConfig` for a specified subscription.
//
// This may be used to change a push subscription to a pull one (signified by
// an empty `PushConfig`) or vice versa, or change the endpoint URL and other
// attributes of a push subscription. Messages will accumulate for delivery
// continuously through the call regardless of changes to the `PushConfig`.
ModifyPushConfig(ctx context.Context, in *ModifyPushConfigRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Gets the configuration details of a snapshot. Snapshots are used in
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
// which allow you to manage message acknowledgments in bulk. That is, you can
// set the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
GetSnapshot(ctx context.Context, in *GetSnapshotRequest, opts ...grpc.CallOption) (*Snapshot, error)
// Lists the existing snapshots. Snapshots are used in [Seek](
// https://cloud.google.com/pubsub/docs/replay-overview) operations, which
// allow you to manage message acknowledgments in bulk. That is, you can set
// the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
ListSnapshots(ctx context.Context, in *ListSnapshotsRequest, opts ...grpc.CallOption) (*ListSnapshotsResponse, error)
// Creates a snapshot from the requested subscription. Snapshots are used in
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
// which allow you to manage message acknowledgments in bulk. That is, you can
// set the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
// If the snapshot already exists, returns `ALREADY_EXISTS`.
// If the requested subscription doesn't exist, returns `NOT_FOUND`.
// If the backlog in the subscription is too old -- and the resulting snapshot
// would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.
// See also the `Snapshot.expire_time` field. If the name is not provided in
// the request, the server will assign a random
// name for this snapshot on the same project as the subscription, conforming
// to the [resource name format]
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
// generated name is populated in the returned Snapshot object. Note that for
// REST API requests, you must specify a name in the request.
CreateSnapshot(ctx context.Context, in *CreateSnapshotRequest, opts ...grpc.CallOption) (*Snapshot, error)
// Updates an existing snapshot by updating the fields specified in the update
// mask. Snapshots are used in
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
// which allow you to manage message acknowledgments in bulk. That is, you can
// set the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
UpdateSnapshot(ctx context.Context, in *UpdateSnapshotRequest, opts ...grpc.CallOption) (*Snapshot, error)
// Removes an existing snapshot. Snapshots are used in [Seek]
// (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
// allow you to manage message acknowledgments in bulk. That is, you can set
// the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
// When the snapshot is deleted, all messages retained in the snapshot
// are immediately dropped. After a snapshot is deleted, a new one may be
// created with the same name, but the new one has no association with the old
// snapshot or its subscription, unless the same subscription is specified.
DeleteSnapshot(ctx context.Context, in *DeleteSnapshotRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Seeks an existing subscription to a point in time or to a given snapshot,
// whichever is provided in the request. Snapshots are used in [Seek]
// (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
// allow you to manage message acknowledgments in bulk. That is, you can set
// the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot. Note that both the subscription and the
// snapshot must be on the same topic.
Seek(ctx context.Context, in *SeekRequest, opts ...grpc.CallOption) (*SeekResponse, error)
}SubscriberClient is the client API for Subscriber service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSubscriberClient
func NewSubscriberClient(cc grpc.ClientConnInterface) SubscriberClientSubscriberServer
type SubscriberServer interface {
// Creates a subscription to a given topic. See the [resource name rules]
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
// If the subscription already exists, returns `ALREADY_EXISTS`.
// If the corresponding topic doesn't exist, returns `NOT_FOUND`.
//
// If the name is not provided in the request, the server will assign a random
// name for this subscription on the same project as the topic, conforming
// to the [resource name format]
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
// generated name is populated in the returned Subscription object. Note that
// for REST API requests, you must specify a name in the request.
CreateSubscription(context.Context, *Subscription) (*Subscription, error)
// Gets the configuration details of a subscription.
GetSubscription(context.Context, *GetSubscriptionRequest) (*Subscription, error)
// Updates an existing subscription by updating the fields specified in the
// update mask. Note that certain properties of a subscription, such as its
// topic, are not modifiable.
UpdateSubscription(context.Context, *UpdateSubscriptionRequest) (*Subscription, error)
// Lists matching subscriptions.
ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*ListSubscriptionsResponse, error)
// Deletes an existing subscription. All messages retained in the subscription
// are immediately dropped. Calls to `Pull` after deletion will return
// `NOT_FOUND`. After a subscription is deleted, a new one may be created with
// the same name, but the new one has no association with the old
// subscription or its topic unless the same topic is specified.
DeleteSubscription(context.Context, *DeleteSubscriptionRequest) (*emptypb.Empty, error)
// Modifies the ack deadline for a specific message. This method is useful
// to indicate that more time is needed to process a message by the
// subscriber, or to make the message available for redelivery if the
// processing was interrupted. Note that this does not modify the
// subscription-level `ackDeadlineSeconds` used for subsequent messages.
ModifyAckDeadline(context.Context, *ModifyAckDeadlineRequest) (*emptypb.Empty, error)
// Acknowledges the messages associated with the `ack_ids` in the
// `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
// from the subscription.
//
// Acknowledging a message whose ack deadline has expired may succeed,
// but such a message may be redelivered later. Acknowledging a message more
// than once will not result in an error.
Acknowledge(context.Context, *AcknowledgeRequest) (*emptypb.Empty, error)
// Pulls messages from the server.
Pull(context.Context, *PullRequest) (*PullResponse, error)
// Establishes a stream with the server, which sends messages down to the
// client. The client streams acknowledgments and ack deadline modifications
// back to the server. The server will close the stream and return the status
// on any error. The server may close the stream with status `UNAVAILABLE` to
// reassign server-side resources, in which case, the client should
// re-establish the stream. Flow control can be achieved by configuring the
// underlying RPC channel.
StreamingPull(Subscriber_StreamingPullServer) error
// Modifies the `PushConfig` for a specified subscription.
//
// This may be used to change a push subscription to a pull one (signified by
// an empty `PushConfig`) or vice versa, or change the endpoint URL and other
// attributes of a push subscription. Messages will accumulate for delivery
// continuously through the call regardless of changes to the `PushConfig`.
ModifyPushConfig(context.Context, *ModifyPushConfigRequest) (*emptypb.Empty, error)
// Gets the configuration details of a snapshot. Snapshots are used in
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
// which allow you to manage message acknowledgments in bulk. That is, you can
// set the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
GetSnapshot(context.Context, *GetSnapshotRequest) (*Snapshot, error)
// Lists the existing snapshots. Snapshots are used in [Seek](
// https://cloud.google.com/pubsub/docs/replay-overview) operations, which
// allow you to manage message acknowledgments in bulk. That is, you can set
// the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
ListSnapshots(context.Context, *ListSnapshotsRequest) (*ListSnapshotsResponse, error)
// Creates a snapshot from the requested subscription. Snapshots are used in
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
// which allow you to manage message acknowledgments in bulk. That is, you can
// set the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
// If the snapshot already exists, returns `ALREADY_EXISTS`.
// If the requested subscription doesn't exist, returns `NOT_FOUND`.
// If the backlog in the subscription is too old -- and the resulting snapshot
// would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.
// See also the `Snapshot.expire_time` field. If the name is not provided in
// the request, the server will assign a random
// name for this snapshot on the same project as the subscription, conforming
// to the [resource name format]
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
// generated name is populated in the returned Snapshot object. Note that for
// REST API requests, you must specify a name in the request.
CreateSnapshot(context.Context, *CreateSnapshotRequest) (*Snapshot, error)
// Updates an existing snapshot by updating the fields specified in the update
// mask. Snapshots are used in
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
// which allow you to manage message acknowledgments in bulk. That is, you can
// set the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
UpdateSnapshot(context.Context, *UpdateSnapshotRequest) (*Snapshot, error)
// Removes an existing snapshot. Snapshots are used in [Seek]
// (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
// allow you to manage message acknowledgments in bulk. That is, you can set
// the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot.
// When the snapshot is deleted, all messages retained in the snapshot
// are immediately dropped. After a snapshot is deleted, a new one may be
// created with the same name, but the new one has no association with the old
// snapshot or its subscription, unless the same subscription is specified.
DeleteSnapshot(context.Context, *DeleteSnapshotRequest) (*emptypb.Empty, error)
// Seeks an existing subscription to a point in time or to a given snapshot,
// whichever is provided in the request. Snapshots are used in [Seek]
// (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
// allow you to manage message acknowledgments in bulk. That is, you can set
// the acknowledgment state of messages in an existing subscription to the
// state captured by a snapshot. Note that both the subscription and the
// snapshot must be on the same topic.
Seek(context.Context, *SeekRequest) (*SeekResponse, error)
}SubscriberServer is the server API for Subscriber service. All implementations should embed UnimplementedSubscriberServer for forward compatibility
Subscriber_StreamingPullClient
type Subscriber_StreamingPullClient interface {
Send(*StreamingPullRequest) error
Recv() (*StreamingPullResponse, error)
grpc.ClientStream
}Subscriber_StreamingPullServer
type Subscriber_StreamingPullServer interface {
Send(*StreamingPullResponse) error
Recv() (*StreamingPullRequest, error)
grpc.ServerStream
}Subscription
type Subscription struct {
// Required. Identifier. The name of the subscription. It must have the format
// `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
// start with a letter, and contain only letters (`[A-Za-z]`), numbers
// (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
// plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
// in length, and it must not start with `"goog"`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The name of the topic from which this subscription is receiving
// messages. Format is `projects/{project}/topics/{topic}`. The value of this
// field will be `_deleted-topic_` if the topic has been deleted.
Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,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. If delivery to Bigtable is used with this subscription, this
// field is used to configure it.
BigtableConfig *BigtableConfig `protobuf:"bytes,27,opt,name=bigtable_config,json=bigtableConfig,proto3" json:"bigtable_config,omitempty"`
// Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
// waits for the subscriber to acknowledge receipt before resending the
// message. In the interval after the message is delivered and before it is
// acknowledged, it is considered to be _outstanding_. During that time
// period, the message will not be redelivered (on a best-effort basis).
//
// For pull subscriptions, this value is used as the initial value for the ack
// deadline. To override this value for a given message, call
// `ModifyAckDeadline` with the corresponding `ack_id` if using
// non-streaming pull or send the `ack_id` in a
// `StreamingModifyAckDeadlineRequest` if using streaming pull.
// The minimum custom deadline you can specify is 10 seconds.
// The maximum custom deadline you can specify is 600 seconds (10 minutes).
// If this parameter is 0, a default value of 10 seconds is used.
//
// For push delivery, this value is also used to set the request timeout for
// the call to the push endpoint.
//
// If the subscriber never acknowledges the message, the Pub/Sub
// system will eventually redeliver the message.
AckDeadlineSeconds int32 `protobuf:"varint,5,opt,name=ack_deadline_seconds,json=ackDeadlineSeconds,proto3" json:"ack_deadline_seconds,omitempty"`
// Optional. Indicates whether to retain acknowledged messages. If true, then
// messages are not expunged from the subscription's backlog, even if they are
// acknowledged, until they fall out of the `message_retention_duration`
// window. This must be true if you would like to [`Seek` to a timestamp]
// (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
// the past to replay previously-acknowledged messages.
RetainAckedMessages bool `protobuf:"varint,7,opt,name=retain_acked_messages,json=retainAckedMessages,proto3" json:"retain_acked_messages,omitempty"`
// Optional. How long to retain unacknowledged messages in the subscription's
// backlog, from the moment a message is published. If `retain_acked_messages`
// is true, then this also configures the retention of acknowledged messages,
// and thus configures how far back in time a `Seek` can be done. Defaults to
// 7 days. Cannot be more than 31 days or less than 10 minutes.
MessageRetentionDuration *durationpb.Duration `protobuf:"bytes,8,opt,name=message_retention_duration,json=messageRetentionDuration,proto3" json:"message_retention_duration,omitempty"`
// Optional. See [Creating and managing
// labels](https://cloud.google.com/pubsub/docs/labels).
Labels map[string]string `protobuf:"bytes,9,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. If true, messages published with the same `ordering_key` in
// `PubsubMessage` will be delivered to the subscribers in the order in which
// they are received by the Pub/Sub system. Otherwise, they may be delivered
// in any order.
EnableMessageOrdering bool `protobuf:"varint,10,opt,name=enable_message_ordering,json=enableMessageOrdering,proto3" json:"enable_message_ordering,omitempty"`
// Optional. A policy that specifies the conditions for this subscription's
// expiration. A subscription is considered active as long as any connected
// subscriber is successfully consuming messages from the subscription or is
// issuing operations on the subscription. If `expiration_policy` is not set,
// a *default policy* with `ttl` of 31 days will be used. The minimum allowed
// value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
// but `expiration_policy.ttl` is not set, the subscription never expires.
ExpirationPolicy *ExpirationPolicy `protobuf:"bytes,11,opt,name=expiration_policy,json=expirationPolicy,proto3" json:"expiration_policy,omitempty"`
// Optional. An expression written in the Pub/Sub [filter
// language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
// then only `PubsubMessage`s whose `attributes` field matches the filter are
// delivered on this subscription. If empty, then no messages are filtered
// out.
Filter string `protobuf:"bytes,12,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. A policy that specifies the conditions for dead lettering
// messages in this subscription. If dead_letter_policy is not set, dead
// lettering is disabled.
//
// The Pub/Sub service account associated with this subscriptions's
// parent project (i.e.,
// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
// permission to Acknowledge() messages on this subscription.
DeadLetterPolicy *DeadLetterPolicy `protobuf:"bytes,13,opt,name=dead_letter_policy,json=deadLetterPolicy,proto3" json:"dead_letter_policy,omitempty"`
// Optional. A policy that specifies how Pub/Sub retries message delivery for
// this subscription.
//
// If not set, the default retry policy is applied. This generally implies
// that messages will be retried as soon as possible for healthy subscribers.
// RetryPolicy will be triggered on NACKs or acknowledgment 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 acknowledgment deadline expires.
// * An acknowledged message will not be resent to a subscriber.
//
// Note that subscribers may still receive multiple copies of a message
// when `enable_exactly_once_delivery` is true if the message was published
// multiple times by a publisher client. These copies are considered distinct
// by Pub/Sub and have distinct `message_id` values.
EnableExactlyOnceDelivery bool `protobuf:"varint,16,opt,name=enable_exactly_once_delivery,json=enableExactlyOnceDelivery,proto3" json:"enable_exactly_once_delivery,omitempty"`
// Output only. Indicates the minimum duration for which a message is retained
// after it is published to the subscription's topic. If this field is set,
// messages published to the subscription's topic in the last
// `topic_message_retention_duration` are always available to subscribers. See
// the `message_retention_duration` field in `Topic`. This field is set only
// in responses from the server; it is ignored if it is set in any requests.
TopicMessageRetentionDuration *durationpb.Duration `protobuf:"bytes,17,opt,name=topic_message_retention_duration,json=topicMessageRetentionDuration,proto3" json:"topic_message_retention_duration,omitempty"`
// Output only. An output-only field indicating whether or not the
// subscription can receive messages.
State Subscription_State `protobuf:"varint,19,opt,name=state,proto3,enum=google.pubsub.v1.Subscription_State" json:"state,omitempty"`
// Output only. Information about the associated Analytics Hub subscription.
// Only set if the subscription is created by Analytics Hub.
AnalyticsHubSubscriptionInfo *Subscription_AnalyticsHubSubscriptionInfo `protobuf:"bytes,23,opt,name=analytics_hub_subscription_info,json=analyticsHubSubscriptionInfo,proto3" json:"analytics_hub_subscription_info,omitempty"`
// Optional. Transforms to be applied to messages before they are delivered to
// subscribers. Transforms are applied in the order specified.
MessageTransforms []*MessageTransform `protobuf:"bytes,25,rep,name=message_transforms,json=messageTransforms,proto3" json:"message_transforms,omitempty"`
// Optional. Input only. Immutable. Tag keys/values directly bound to this
// resource. For example:
//
// "123/environment": "production",
// "123/costCenter": "marketing"
//
// See
// https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags
// for more information on using tags with Pub/Sub resources.
Tags map[string]string `protobuf:"bytes,26,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}A subscription resource. If none of push_config, bigquery_config,
cloud_storage_config, or bigtable_config is set, then the subscriber will
pull and ack messages using API methods. At most one of these fields may be
set.
func (*Subscription) Descriptor
func (*Subscription) Descriptor() ([]byte, []int)Deprecated: Use Subscription.ProtoReflect.Descriptor instead.
func (*Subscription) GetAckDeadlineSeconds
func (x *Subscription) GetAckDeadlineSeconds() int32func (*Subscription) GetAnalyticsHubSubscriptionInfo
func (x *Subscription) GetAnalyticsHubSubscriptionInfo() *Subscription_AnalyticsHubSubscriptionInfofunc (*Subscription) GetBigqueryConfig
func (x *Subscription) GetBigqueryConfig() *BigQueryConfigfunc (*Subscription) GetBigtableConfig
func (x *Subscription) GetBigtableConfig() *BigtableConfigfunc (*Subscription) GetCloudStorageConfig
func (x *Subscription) GetCloudStorageConfig() *CloudStorageConfigfunc (*Subscription) GetDeadLetterPolicy
func (x *Subscription) GetDeadLetterPolicy() *DeadLetterPolicyfunc (*Subscription) GetDetached
func (x *Subscription) GetDetached() boolfunc (*Subscription) GetEnableExactlyOnceDelivery
func (x *Subscription) GetEnableExactlyOnceDelivery() boolfunc (*Subscription) GetEnableMessageOrdering
func (x *Subscription) GetEnableMessageOrdering() boolfunc (*Subscription) GetExpirationPolicy
func (x *Subscription) GetExpirationPolicy() *ExpirationPolicyfunc (*Subscription) GetFilter
func (x *Subscription) GetFilter() stringfunc (*Subscription) GetLabels
func (x *Subscription) GetLabels() map[string]stringfunc (*Subscription) GetMessageRetentionDuration
func (x *Subscription) GetMessageRetentionDuration() *durationpb.Durationfunc (*Subscription) GetMessageTransforms
func (x *Subscription) GetMessageTransforms() []*MessageTransformfunc (*Subscription) GetName
func (x *Subscription) GetName() stringfunc (*Subscription) GetPushConfig
func (x *Subscription) GetPushConfig() *PushConfigfunc (*Subscription) GetRetainAckedMessages
func (x *Subscription) GetRetainAckedMessages() boolfunc (*Subscription) GetRetryPolicy
func (x *Subscription) GetRetryPolicy() *RetryPolicyfunc (*Subscription) GetState
func (x *Subscription) GetState() Subscription_Statefunc (*Subscription) GetTags
func (x *Subscription) GetTags() map[string]stringfunc (*Subscription) GetTopic
func (x *Subscription) GetTopic() stringfunc (*Subscription) GetTopicMessageRetentionDuration
func (x *Subscription) GetTopicMessageRetentionDuration() *durationpb.Durationfunc (*Subscription) ProtoMessage
func (*Subscription) ProtoMessage()func (*Subscription) ProtoReflect
func (x *Subscription) ProtoReflect() protoreflect.Messagefunc (*Subscription) Reset
func (x *Subscription) Reset()func (*Subscription) String
func (x *Subscription) String() stringSubscription_AnalyticsHubSubscriptionInfo
type Subscription_AnalyticsHubSubscriptionInfo struct {
// Optional. The name of the associated Analytics Hub listing resource.
// Pattern:
// "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}"
Listing string `protobuf:"bytes,1,opt,name=listing,proto3" json:"listing,omitempty"`
// Optional. The name of the associated Analytics Hub subscription resource.
// Pattern:
// "projects/{project}/locations/{location}/subscriptions/{subscription}"
Subscription string `protobuf:"bytes,2,opt,name=subscription,proto3" json:"subscription,omitempty"`
// contains filtered or unexported fields
}Information about an associated Analytics Hub subscription.
func (*Subscription_AnalyticsHubSubscriptionInfo) Descriptor
func (*Subscription_AnalyticsHubSubscriptionInfo) Descriptor() ([]byte, []int)Deprecated: Use Subscription_AnalyticsHubSubscriptionInfo.ProtoReflect.Descriptor instead.
func (*Subscription_AnalyticsHubSubscriptionInfo) GetListing
func (x *Subscription_AnalyticsHubSubscriptionInfo) GetListing() stringfunc (*Subscription_AnalyticsHubSubscriptionInfo) GetSubscription
func (x *Subscription_AnalyticsHubSubscriptionInfo) GetSubscription() stringfunc (*Subscription_AnalyticsHubSubscriptionInfo) ProtoMessage
func (*Subscription_AnalyticsHubSubscriptionInfo) ProtoMessage()func (*Subscription_AnalyticsHubSubscriptionInfo) ProtoReflect
func (x *Subscription_AnalyticsHubSubscriptionInfo) ProtoReflect() protoreflect.Messagefunc (*Subscription_AnalyticsHubSubscriptionInfo) Reset
func (x *Subscription_AnalyticsHubSubscriptionInfo) Reset()func (*Subscription_AnalyticsHubSubscriptionInfo) String
func (x *Subscription_AnalyticsHubSubscriptionInfo) String() stringSubscription_State
type Subscription_State int32Possible states for a subscription.
Subscription_STATE_UNSPECIFIED, Subscription_ACTIVE, Subscription_RESOURCE_ERROR
const (
// Default value. This value is unused.
Subscription_STATE_UNSPECIFIED Subscription_State = 0
// The subscription can actively receive messages
Subscription_ACTIVE Subscription_State = 1
// The subscription cannot receive messages because of an error with the
// resource to which it pushes messages. See the more detailed error state
// in the corresponding configuration.
Subscription_RESOURCE_ERROR Subscription_State = 2
)func (Subscription_State) Descriptor
func (Subscription_State) Descriptor() protoreflect.EnumDescriptorfunc (Subscription_State) Enum
func (x Subscription_State) Enum() *Subscription_Statefunc (Subscription_State) EnumDescriptor
func (Subscription_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Subscription_State.Descriptor instead.
func (Subscription_State) Number
func (x Subscription_State) Number() protoreflect.EnumNumberfunc (Subscription_State) String
func (x Subscription_State) String() stringfunc (Subscription_State) Type
func (Subscription_State) Type() protoreflect.EnumTypeTopic
type Topic struct {
// Required. Identifier. The name of the topic. It must have the format
// `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
// and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
// underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
// signs (`%`). It must be between 3 and 255 characters in length, and it
// must not start with `"goog"`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. See [Creating and managing labels]
// (https://cloud.google.com/pubsub/docs/labels).
Labels map[string]string `protobuf:"bytes,2,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. Policy constraining the set of Google Cloud Platform regions
// where messages published to the topic may be stored. If not present, then
// no constraints are in effect.
MessageStoragePolicy *MessageStoragePolicy `protobuf:"bytes,3,opt,name=message_storage_policy,json=messageStoragePolicy,proto3" json:"message_storage_policy,omitempty"`
// Optional. The resource name of the Cloud KMS CryptoKey to be used to
// protect access to messages published on this topic.
//
// The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
KmsKeyName string `protobuf:"bytes,5,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
// Optional. Settings for validating messages published against a schema.
SchemaSettings *SchemaSettings `protobuf:"bytes,6,opt,name=schema_settings,json=schemaSettings,proto3" json:"schema_settings,omitempty"`
// Optional. Reserved for future use. This field is set only in responses from
// the server; it is ignored if it is set in any requests.
SatisfiesPzs bool `protobuf:"varint,7,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,omitempty"`
// Optional. Indicates the minimum duration to retain a message after it is
// published to the topic. If this field is set, messages published to the
// topic in the last `message_retention_duration` are always available to
// subscribers. For instance, it allows any attached subscription to [seek to
// a
// timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
// that is up to `message_retention_duration` in the past. If this field is
// not set, message retention is controlled by settings on individual
// subscriptions. Cannot be more than 31 days or less than 10 minutes.
MessageRetentionDuration *durationpb.Duration `protobuf:"bytes,8,opt,name=message_retention_duration,json=messageRetentionDuration,proto3" json:"message_retention_duration,omitempty"`
// Output only. An output-only field indicating the state of the topic.
State Topic_State `protobuf:"varint,9,opt,name=state,proto3,enum=google.pubsub.v1.Topic_State" json:"state,omitempty"`
// Optional. Settings for ingestion from a data source into this topic.
IngestionDataSourceSettings *IngestionDataSourceSettings `protobuf:"bytes,10,opt,name=ingestion_data_source_settings,json=ingestionDataSourceSettings,proto3" json:"ingestion_data_source_settings,omitempty"`
// Optional. Transforms to be applied to messages published to the topic.
// Transforms are applied in the order specified.
MessageTransforms []*MessageTransform `protobuf:"bytes,13,rep,name=message_transforms,json=messageTransforms,proto3" json:"message_transforms,omitempty"`
// Optional. Input only. Immutable. Tag keys/values directly bound to this
// resource. For example:
//
// "123/environment": "production",
// "123/costCenter": "marketing"
//
// See
// https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags
// for more information on using tags with Pub/Sub resources.
Tags map[string]string `protobuf:"bytes,14,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}A topic resource.
func (*Topic) Descriptor
Deprecated: Use Topic.ProtoReflect.Descriptor instead.
func (*Topic) GetIngestionDataSourceSettings
func (x *Topic) GetIngestionDataSourceSettings() *IngestionDataSourceSettingsfunc (*Topic) GetKmsKeyName
func (*Topic) GetLabels
func (*Topic) GetMessageRetentionDuration
func (x *Topic) GetMessageRetentionDuration() *durationpb.Durationfunc (*Topic) GetMessageStoragePolicy
func (x *Topic) GetMessageStoragePolicy() *MessageStoragePolicyfunc (*Topic) GetMessageTransforms
func (x *Topic) GetMessageTransforms() []*MessageTransformfunc (*Topic) GetName
func (*Topic) GetSatisfiesPzs
func (*Topic) GetSchemaSettings
func (x *Topic) GetSchemaSettings() *SchemaSettingsfunc (*Topic) GetState
func (x *Topic) GetState() Topic_Statefunc (*Topic) GetTags
func (*Topic) ProtoMessage
func (*Topic) ProtoMessage()func (*Topic) ProtoReflect
func (x *Topic) ProtoReflect() protoreflect.Messagefunc (*Topic) Reset
func (x *Topic) Reset()func (*Topic) String
Topic_State
type Topic_State int32The state of the topic.
Topic_STATE_UNSPECIFIED, Topic_ACTIVE, Topic_INGESTION_RESOURCE_ERROR
const (
// Default value. This value is unused.
Topic_STATE_UNSPECIFIED Topic_State = 0
// The topic does not have any persistent errors.
Topic_ACTIVE Topic_State = 1
// Ingestion from the data source has encountered a permanent error.
// See the more detailed error state in the corresponding ingestion
// source configuration.
Topic_INGESTION_RESOURCE_ERROR Topic_State = 2
)func (Topic_State) Descriptor
func (Topic_State) Descriptor() protoreflect.EnumDescriptorfunc (Topic_State) Enum
func (x Topic_State) Enum() *Topic_Statefunc (Topic_State) EnumDescriptor
func (Topic_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Topic_State.Descriptor instead.
func (Topic_State) Number
func (x Topic_State) Number() protoreflect.EnumNumberfunc (Topic_State) String
func (x Topic_State) String() stringfunc (Topic_State) Type
func (Topic_State) Type() protoreflect.EnumTypeUnimplementedPublisherServer
type UnimplementedPublisherServer struct {
}UnimplementedPublisherServer should be embedded to have forward compatible implementations.
func (UnimplementedPublisherServer) CreateTopic
func (UnimplementedPublisherServer) DeleteTopic
func (UnimplementedPublisherServer) DeleteTopic(context.Context, *DeleteTopicRequest) (*emptypb.Empty, error)func (UnimplementedPublisherServer) DetachSubscription
func (UnimplementedPublisherServer) DetachSubscription(context.Context, *DetachSubscriptionRequest) (*DetachSubscriptionResponse, error)func (UnimplementedPublisherServer) GetTopic
func (UnimplementedPublisherServer) GetTopic(context.Context, *GetTopicRequest) (*Topic, error)func (UnimplementedPublisherServer) ListTopicSnapshots
func (UnimplementedPublisherServer) ListTopicSnapshots(context.Context, *ListTopicSnapshotsRequest) (*ListTopicSnapshotsResponse, error)func (UnimplementedPublisherServer) ListTopicSubscriptions
func (UnimplementedPublisherServer) ListTopicSubscriptions(context.Context, *ListTopicSubscriptionsRequest) (*ListTopicSubscriptionsResponse, error)func (UnimplementedPublisherServer) ListTopics
func (UnimplementedPublisherServer) ListTopics(context.Context, *ListTopicsRequest) (*ListTopicsResponse, error)func (UnimplementedPublisherServer) Publish
func (UnimplementedPublisherServer) Publish(context.Context, *PublishRequest) (*PublishResponse, error)func (UnimplementedPublisherServer) UpdateTopic
func (UnimplementedPublisherServer) UpdateTopic(context.Context, *UpdateTopicRequest) (*Topic, error)UnimplementedSchemaServiceServer
type UnimplementedSchemaServiceServer struct {
}UnimplementedSchemaServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedSchemaServiceServer) CommitSchema
func (UnimplementedSchemaServiceServer) CommitSchema(context.Context, *CommitSchemaRequest) (*Schema, error)func (UnimplementedSchemaServiceServer) CreateSchema
func (UnimplementedSchemaServiceServer) CreateSchema(context.Context, *CreateSchemaRequest) (*Schema, error)func (UnimplementedSchemaServiceServer) DeleteSchema
func (UnimplementedSchemaServiceServer) DeleteSchema(context.Context, *DeleteSchemaRequest) (*emptypb.Empty, error)func (UnimplementedSchemaServiceServer) DeleteSchemaRevision
func (UnimplementedSchemaServiceServer) DeleteSchemaRevision(context.Context, *DeleteSchemaRevisionRequest) (*Schema, error)func (UnimplementedSchemaServiceServer) GetSchema
func (UnimplementedSchemaServiceServer) GetSchema(context.Context, *GetSchemaRequest) (*Schema, error)func (UnimplementedSchemaServiceServer) ListSchemaRevisions
func (UnimplementedSchemaServiceServer) ListSchemaRevisions(context.Context, *ListSchemaRevisionsRequest) (*ListSchemaRevisionsResponse, error)func (UnimplementedSchemaServiceServer) ListSchemas
func (UnimplementedSchemaServiceServer) ListSchemas(context.Context, *ListSchemasRequest) (*ListSchemasResponse, error)func (UnimplementedSchemaServiceServer) RollbackSchema
func (UnimplementedSchemaServiceServer) RollbackSchema(context.Context, *RollbackSchemaRequest) (*Schema, error)func (UnimplementedSchemaServiceServer) ValidateMessage
func (UnimplementedSchemaServiceServer) ValidateMessage(context.Context, *ValidateMessageRequest) (*ValidateMessageResponse, error)func (UnimplementedSchemaServiceServer) ValidateSchema
func (UnimplementedSchemaServiceServer) ValidateSchema(context.Context, *ValidateSchemaRequest) (*ValidateSchemaResponse, error)UnimplementedSubscriberServer
type UnimplementedSubscriberServer struct {
}UnimplementedSubscriberServer should be embedded to have forward compatible implementations.
func (UnimplementedSubscriberServer) Acknowledge
func (UnimplementedSubscriberServer) Acknowledge(context.Context, *AcknowledgeRequest) (*emptypb.Empty, error)func (UnimplementedSubscriberServer) CreateSnapshot
func (UnimplementedSubscriberServer) CreateSnapshot(context.Context, *CreateSnapshotRequest) (*Snapshot, error)func (UnimplementedSubscriberServer) CreateSubscription
func (UnimplementedSubscriberServer) CreateSubscription(context.Context, *Subscription) (*Subscription, error)func (UnimplementedSubscriberServer) DeleteSnapshot
func (UnimplementedSubscriberServer) DeleteSnapshot(context.Context, *DeleteSnapshotRequest) (*emptypb.Empty, error)func (UnimplementedSubscriberServer) DeleteSubscription
func (UnimplementedSubscriberServer) DeleteSubscription(context.Context, *DeleteSubscriptionRequest) (*emptypb.Empty, error)func (UnimplementedSubscriberServer) GetSnapshot
func (UnimplementedSubscriberServer) GetSnapshot(context.Context, *GetSnapshotRequest) (*Snapshot, error)func (UnimplementedSubscriberServer) GetSubscription
func (UnimplementedSubscriberServer) GetSubscription(context.Context, *GetSubscriptionRequest) (*Subscription, error)func (UnimplementedSubscriberServer) ListSnapshots
func (UnimplementedSubscriberServer) ListSnapshots(context.Context, *ListSnapshotsRequest) (*ListSnapshotsResponse, error)func (UnimplementedSubscriberServer) ListSubscriptions
func (UnimplementedSubscriberServer) ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*ListSubscriptionsResponse, error)func (UnimplementedSubscriberServer) ModifyAckDeadline
func (UnimplementedSubscriberServer) ModifyAckDeadline(context.Context, *ModifyAckDeadlineRequest) (*emptypb.Empty, error)func (UnimplementedSubscriberServer) ModifyPushConfig
func (UnimplementedSubscriberServer) ModifyPushConfig(context.Context, *ModifyPushConfigRequest) (*emptypb.Empty, error)func (UnimplementedSubscriberServer) Pull
func (UnimplementedSubscriberServer) Pull(context.Context, *PullRequest) (*PullResponse, error)func (UnimplementedSubscriberServer) Seek
func (UnimplementedSubscriberServer) Seek(context.Context, *SeekRequest) (*SeekResponse, error)func (UnimplementedSubscriberServer) StreamingPull
func (UnimplementedSubscriberServer) StreamingPull(Subscriber_StreamingPullServer) errorfunc (UnimplementedSubscriberServer) UpdateSnapshot
func (UnimplementedSubscriberServer) UpdateSnapshot(context.Context, *UpdateSnapshotRequest) (*Snapshot, error)func (UnimplementedSubscriberServer) UpdateSubscription
func (UnimplementedSubscriberServer) UpdateSubscription(context.Context, *UpdateSubscriptionRequest) (*Subscription, error)UnsafePublisherServer
type UnsafePublisherServer interface {
// contains filtered or unexported methods
}UnsafePublisherServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PublisherServer will result in compilation errors.
UnsafeSchemaServiceServer
type UnsafeSchemaServiceServer interface {
// contains filtered or unexported methods
}UnsafeSchemaServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SchemaServiceServer will result in compilation errors.
UnsafeSubscriberServer
type UnsafeSubscriberServer interface {
// contains filtered or unexported methods
}UnsafeSubscriberServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SubscriberServer will result in compilation errors.
UpdateSnapshotRequest
type UpdateSnapshotRequest struct {
// Required. The updated snapshot object.
Snapshot *Snapshot `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
// Required. Indicates which fields in the provided snapshot to update.
// Must be specified and non-empty.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for the UpdateSnapshot method.
func (*UpdateSnapshotRequest) Descriptor
func (*UpdateSnapshotRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateSnapshotRequest.ProtoReflect.Descriptor instead.
func (*UpdateSnapshotRequest) GetSnapshot
func (x *UpdateSnapshotRequest) GetSnapshot() *Snapshotfunc (*UpdateSnapshotRequest) GetUpdateMask
func (x *UpdateSnapshotRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateSnapshotRequest) ProtoMessage
func (*UpdateSnapshotRequest) ProtoMessage()func (*UpdateSnapshotRequest) ProtoReflect
func (x *UpdateSnapshotRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateSnapshotRequest) Reset
func (x *UpdateSnapshotRequest) Reset()func (*UpdateSnapshotRequest) String
func (x *UpdateSnapshotRequest) String() stringUpdateSubscriptionRequest
type UpdateSubscriptionRequest struct {
// Required. The updated subscription object.
Subscription *Subscription `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
// Required. Indicates which fields in the provided subscription to update.
// Must be specified and non-empty.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for the UpdateSubscription method.
func (*UpdateSubscriptionRequest) Descriptor
func (*UpdateSubscriptionRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateSubscriptionRequest.ProtoReflect.Descriptor instead.
func (*UpdateSubscriptionRequest) GetSubscription
func (x *UpdateSubscriptionRequest) GetSubscription() *Subscriptionfunc (*UpdateSubscriptionRequest) GetUpdateMask
func (x *UpdateSubscriptionRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateSubscriptionRequest) ProtoMessage
func (*UpdateSubscriptionRequest) ProtoMessage()func (*UpdateSubscriptionRequest) ProtoReflect
func (x *UpdateSubscriptionRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateSubscriptionRequest) Reset
func (x *UpdateSubscriptionRequest) Reset()func (*UpdateSubscriptionRequest) String
func (x *UpdateSubscriptionRequest) String() stringUpdateTopicRequest
type UpdateTopicRequest struct {
// Required. The updated topic object.
Topic *Topic `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
// Required. Indicates which fields in the provided topic to update. Must be
// specified and non-empty. Note that if `update_mask` contains
// "message_storage_policy" but the `message_storage_policy` is not set in
// the `topic` provided above, then the updated value is determined by the
// policy configured at the project or organization level.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for the UpdateTopic method.
func (*UpdateTopicRequest) Descriptor
func (*UpdateTopicRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateTopicRequest.ProtoReflect.Descriptor instead.
func (*UpdateTopicRequest) GetTopic
func (x *UpdateTopicRequest) GetTopic() *Topicfunc (*UpdateTopicRequest) GetUpdateMask
func (x *UpdateTopicRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateTopicRequest) ProtoMessage
func (*UpdateTopicRequest) ProtoMessage()func (*UpdateTopicRequest) ProtoReflect
func (x *UpdateTopicRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateTopicRequest) Reset
func (x *UpdateTopicRequest) Reset()func (*UpdateTopicRequest) String
func (x *UpdateTopicRequest) String() stringValidateMessageRequest
type ValidateMessageRequest struct {
// Required. The name of the project in which to validate schemas.
// Format is `projects/{project-id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Types that are valid to be assigned to SchemaSpec:
//
// *ValidateMessageRequest_Name
// *ValidateMessageRequest_Schema
SchemaSpec isValidateMessageRequest_SchemaSpec `protobuf_oneof:"schema_spec"`
// Message to validate against the provided `schema_spec`.
Message []byte `protobuf:"bytes,4,opt,name=message,proto3" json:"message,omitempty"`
// The encoding expected for messages
Encoding Encoding `protobuf:"varint,5,opt,name=encoding,proto3,enum=google.pubsub.v1.Encoding" json:"encoding,omitempty"`
// contains filtered or unexported fields
}Request for the ValidateMessage method.
func (*ValidateMessageRequest) Descriptor
func (*ValidateMessageRequest) Descriptor() ([]byte, []int)Deprecated: Use ValidateMessageRequest.ProtoReflect.Descriptor instead.
func (*ValidateMessageRequest) GetEncoding
func (x *ValidateMessageRequest) GetEncoding() Encodingfunc (*ValidateMessageRequest) GetMessage
func (x *ValidateMessageRequest) GetMessage() []bytefunc (*ValidateMessageRequest) GetName
func (x *ValidateMessageRequest) GetName() stringfunc (*ValidateMessageRequest) GetParent
func (x *ValidateMessageRequest) GetParent() stringfunc (*ValidateMessageRequest) GetSchema
func (x *ValidateMessageRequest) GetSchema() *Schemafunc (*ValidateMessageRequest) GetSchemaSpec
func (x *ValidateMessageRequest) GetSchemaSpec() isValidateMessageRequest_SchemaSpecfunc (*ValidateMessageRequest) ProtoMessage
func (*ValidateMessageRequest) ProtoMessage()func (*ValidateMessageRequest) ProtoReflect
func (x *ValidateMessageRequest) ProtoReflect() protoreflect.Messagefunc (*ValidateMessageRequest) Reset
func (x *ValidateMessageRequest) Reset()func (*ValidateMessageRequest) String
func (x *ValidateMessageRequest) String() stringValidateMessageRequest_Name
type ValidateMessageRequest_Name struct {
// Name of the schema against which to validate.
//
// Format is `projects/{project}/schemas/{schema}`.
Name string `protobuf:"bytes,2,opt,name=name,proto3,oneof"`
}ValidateMessageRequest_Schema
type ValidateMessageRequest_Schema struct {
// Ad-hoc schema against which to validate
Schema *Schema `protobuf:"bytes,3,opt,name=schema,proto3,oneof"`
}ValidateMessageResponse
type ValidateMessageResponse struct {
// contains filtered or unexported fields
}Response for the ValidateMessage method.
Empty for now.
func (*ValidateMessageResponse) Descriptor
func (*ValidateMessageResponse) Descriptor() ([]byte, []int)Deprecated: Use ValidateMessageResponse.ProtoReflect.Descriptor instead.
func (*ValidateMessageResponse) ProtoMessage
func (*ValidateMessageResponse) ProtoMessage()func (*ValidateMessageResponse) ProtoReflect
func (x *ValidateMessageResponse) ProtoReflect() protoreflect.Messagefunc (*ValidateMessageResponse) Reset
func (x *ValidateMessageResponse) Reset()func (*ValidateMessageResponse) String
func (x *ValidateMessageResponse) String() stringValidateSchemaRequest
type ValidateSchemaRequest struct {
// Required. The name of the project in which to validate schemas.
// Format is `projects/{project-id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The schema object to validate.
Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
// contains filtered or unexported fields
}Request for the ValidateSchema method.
func (*ValidateSchemaRequest) Descriptor
func (*ValidateSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use ValidateSchemaRequest.ProtoReflect.Descriptor instead.
func (*ValidateSchemaRequest) GetParent
func (x *ValidateSchemaRequest) GetParent() stringfunc (*ValidateSchemaRequest) GetSchema
func (x *ValidateSchemaRequest) GetSchema() *Schemafunc (*ValidateSchemaRequest) ProtoMessage
func (*ValidateSchemaRequest) ProtoMessage()func (*ValidateSchemaRequest) ProtoReflect
func (x *ValidateSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*ValidateSchemaRequest) Reset
func (x *ValidateSchemaRequest) Reset()func (*ValidateSchemaRequest) String
func (x *ValidateSchemaRequest) String() stringValidateSchemaResponse
type ValidateSchemaResponse struct {
// contains filtered or unexported fields
}Response for the ValidateSchema method.
Empty for now.
func (*ValidateSchemaResponse) Descriptor
func (*ValidateSchemaResponse) Descriptor() ([]byte, []int)Deprecated: Use ValidateSchemaResponse.ProtoReflect.Descriptor instead.
func (*ValidateSchemaResponse) ProtoMessage
func (*ValidateSchemaResponse) ProtoMessage()func (*ValidateSchemaResponse) ProtoReflect
func (x *ValidateSchemaResponse) ProtoReflect() protoreflect.Messagefunc (*ValidateSchemaResponse) Reset
func (x *ValidateSchemaResponse) Reset()func (*ValidateSchemaResponse) String
func (x *ValidateSchemaResponse) String() string