genproto: google.golang.org/genproto/googleapis/pubsub/v1 Index | Files

package pubsub

import "google.golang.org/genproto/googleapis/pubsub/v1"

Index

Package Files

pubsub.pb.go schema.pb.go

Variables

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.

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.

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.

var File_google_pubsub_v1_pubsub_proto protoreflect.FileDescriptor
var File_google_pubsub_v1_schema_proto protoreflect.FileDescriptor

func RegisterPublisherServer Uses

func RegisterPublisherServer(s *grpc.Server, srv PublisherServer)

func RegisterSchemaServiceServer Uses

func RegisterSchemaServiceServer(s *grpc.Server, srv SchemaServiceServer)

func RegisterSubscriberServer Uses

func RegisterSubscriberServer(s *grpc.Server, srv SubscriberServer)

type AcknowledgeRequest Uses

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 Uses

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

Deprecated: Use AcknowledgeRequest.ProtoReflect.Descriptor instead.

func (*AcknowledgeRequest) GetAckIds Uses

func (x *AcknowledgeRequest) GetAckIds() []string

func (*AcknowledgeRequest) GetSubscription Uses

func (x *AcknowledgeRequest) GetSubscription() string

func (*AcknowledgeRequest) ProtoMessage Uses

func (*AcknowledgeRequest) ProtoMessage()

func (*AcknowledgeRequest) ProtoReflect Uses

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

func (*AcknowledgeRequest) Reset Uses

func (x *AcknowledgeRequest) Reset()

func (*AcknowledgeRequest) String Uses

func (x *AcknowledgeRequest) String() string

type CreateSchemaRequest Uses

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/admin#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 Uses

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

Deprecated: Use CreateSchemaRequest.ProtoReflect.Descriptor instead.

func (*CreateSchemaRequest) GetParent Uses

func (x *CreateSchemaRequest) GetParent() string

func (*CreateSchemaRequest) GetSchema Uses

func (x *CreateSchemaRequest) GetSchema() *Schema

func (*CreateSchemaRequest) GetSchemaId Uses

func (x *CreateSchemaRequest) GetSchemaId() string

func (*CreateSchemaRequest) ProtoMessage Uses

func (*CreateSchemaRequest) ProtoMessage()

func (*CreateSchemaRequest) ProtoReflect Uses

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

func (*CreateSchemaRequest) Reset Uses

func (x *CreateSchemaRequest) Reset()

func (*CreateSchemaRequest) String Uses

func (x *CreateSchemaRequest) String() string

type CreateSnapshotRequest Uses

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 <a
    // href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource
    // name rules</a>. 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"`
    // See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
    // managing labels</a>.
    Labels map[string]string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // contains filtered or unexported fields
}

Request for the `CreateSnapshot` method.

func (*CreateSnapshotRequest) Descriptor Uses

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

Deprecated: Use CreateSnapshotRequest.ProtoReflect.Descriptor instead.

func (*CreateSnapshotRequest) GetLabels Uses

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

func (*CreateSnapshotRequest) GetName Uses

func (x *CreateSnapshotRequest) GetName() string

func (*CreateSnapshotRequest) GetSubscription Uses

func (x *CreateSnapshotRequest) GetSubscription() string

func (*CreateSnapshotRequest) ProtoMessage Uses

func (*CreateSnapshotRequest) ProtoMessage()

func (*CreateSnapshotRequest) ProtoReflect Uses

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

func (*CreateSnapshotRequest) Reset Uses

func (x *CreateSnapshotRequest) Reset()

func (*CreateSnapshotRequest) String Uses

func (x *CreateSnapshotRequest) String() string

type DeadLetterPolicy Uses

type DeadLetterPolicy struct {

    // The name of the topic to which dead letter messages should be published.
    // Format is `projects/{project}/topics/{topic}`.The Cloud 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"`
    // The maximum number of delivery attempts for any message. The value must be
    // between 5 and 100.
    //
    // The number of delivery attempts is defined as 1 + (the sum of number of
    // NACKs and number of times the acknowledgement deadline has been exceeded
    // for the message).
    //
    // A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that
    // client libraries may automatically extend ack_deadlines.
    //
    // This field will be honored on a best effort basis.
    //
    // If this parameter is 0, a default value of 5 is used.
    MaxDeliveryAttempts int32 `protobuf:"varint,2,opt,name=max_delivery_attempts,json=maxDeliveryAttempts,proto3" json:"max_delivery_attempts,omitempty"`
    // contains filtered or unexported fields
}

Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times.

If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.

func (*DeadLetterPolicy) Descriptor Uses

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

Deprecated: Use DeadLetterPolicy.ProtoReflect.Descriptor instead.

func (*DeadLetterPolicy) GetDeadLetterTopic Uses

func (x *DeadLetterPolicy) GetDeadLetterTopic() string

func (*DeadLetterPolicy) GetMaxDeliveryAttempts Uses

func (x *DeadLetterPolicy) GetMaxDeliveryAttempts() int32

func (*DeadLetterPolicy) ProtoMessage Uses

func (*DeadLetterPolicy) ProtoMessage()

func (*DeadLetterPolicy) ProtoReflect Uses

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

func (*DeadLetterPolicy) Reset Uses

func (x *DeadLetterPolicy) Reset()

func (*DeadLetterPolicy) String Uses

func (x *DeadLetterPolicy) String() string

type DeleteSchemaRequest Uses

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 Uses

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

Deprecated: Use DeleteSchemaRequest.ProtoReflect.Descriptor instead.

func (*DeleteSchemaRequest) GetName Uses

func (x *DeleteSchemaRequest) GetName() string

func (*DeleteSchemaRequest) ProtoMessage Uses

func (*DeleteSchemaRequest) ProtoMessage()

func (*DeleteSchemaRequest) ProtoReflect Uses

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

func (*DeleteSchemaRequest) Reset Uses

func (x *DeleteSchemaRequest) Reset()

func (*DeleteSchemaRequest) String Uses

func (x *DeleteSchemaRequest) String() string

type DeleteSnapshotRequest Uses

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 Uses

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

Deprecated: Use DeleteSnapshotRequest.ProtoReflect.Descriptor instead.

func (*DeleteSnapshotRequest) GetSnapshot Uses

func (x *DeleteSnapshotRequest) GetSnapshot() string

func (*DeleteSnapshotRequest) ProtoMessage Uses

func (*DeleteSnapshotRequest) ProtoMessage()

func (*DeleteSnapshotRequest) ProtoReflect Uses

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

func (*DeleteSnapshotRequest) Reset Uses

func (x *DeleteSnapshotRequest) Reset()

func (*DeleteSnapshotRequest) String Uses

func (x *DeleteSnapshotRequest) String() string

type DeleteSubscriptionRequest Uses

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 Uses

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

Deprecated: Use DeleteSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*DeleteSubscriptionRequest) GetSubscription Uses

func (x *DeleteSubscriptionRequest) GetSubscription() string

func (*DeleteSubscriptionRequest) ProtoMessage Uses

func (*DeleteSubscriptionRequest) ProtoMessage()

func (*DeleteSubscriptionRequest) ProtoReflect Uses

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

func (*DeleteSubscriptionRequest) Reset Uses

func (x *DeleteSubscriptionRequest) Reset()

func (*DeleteSubscriptionRequest) String Uses

func (x *DeleteSubscriptionRequest) String() string

type DeleteTopicRequest Uses

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 Uses

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

Deprecated: Use DeleteTopicRequest.ProtoReflect.Descriptor instead.

func (*DeleteTopicRequest) GetTopic Uses

func (x *DeleteTopicRequest) GetTopic() string

func (*DeleteTopicRequest) ProtoMessage Uses

func (*DeleteTopicRequest) ProtoMessage()

func (*DeleteTopicRequest) ProtoReflect Uses

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

func (*DeleteTopicRequest) Reset Uses

func (x *DeleteTopicRequest) Reset()

func (*DeleteTopicRequest) String Uses

func (x *DeleteTopicRequest) String() string

type DetachSubscriptionRequest Uses

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 Uses

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

Deprecated: Use DetachSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*DetachSubscriptionRequest) GetSubscription Uses

func (x *DetachSubscriptionRequest) GetSubscription() string

func (*DetachSubscriptionRequest) ProtoMessage Uses

func (*DetachSubscriptionRequest) ProtoMessage()

func (*DetachSubscriptionRequest) ProtoReflect Uses

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

func (*DetachSubscriptionRequest) Reset Uses

func (x *DetachSubscriptionRequest) Reset()

func (*DetachSubscriptionRequest) String Uses

func (x *DetachSubscriptionRequest) String() string

type DetachSubscriptionResponse Uses

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

Response for the DetachSubscription method. Reserved for future use.

func (*DetachSubscriptionResponse) Descriptor Uses

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

Deprecated: Use DetachSubscriptionResponse.ProtoReflect.Descriptor instead.

func (*DetachSubscriptionResponse) ProtoMessage Uses

func (*DetachSubscriptionResponse) ProtoMessage()

func (*DetachSubscriptionResponse) ProtoReflect Uses

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

func (*DetachSubscriptionResponse) Reset Uses

func (x *DetachSubscriptionResponse) Reset()

func (*DetachSubscriptionResponse) String Uses

func (x *DetachSubscriptionResponse) String() string

type Encoding Uses

type Encoding int32

Possible encoding types for messages.

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 Uses

func (Encoding) Descriptor() protoreflect.EnumDescriptor

func (Encoding) Enum Uses

func (x Encoding) Enum() *Encoding

func (Encoding) EnumDescriptor Uses

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

Deprecated: Use Encoding.Descriptor instead.

func (Encoding) Number Uses

func (x Encoding) Number() protoreflect.EnumNumber

func (Encoding) String Uses

func (x Encoding) String() string

func (Encoding) Type Uses

func (Encoding) Type() protoreflect.EnumType

type ExpirationPolicy Uses

type ExpirationPolicy struct {

    // 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 Uses

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

Deprecated: Use ExpirationPolicy.ProtoReflect.Descriptor instead.

func (*ExpirationPolicy) GetTtl Uses

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

func (*ExpirationPolicy) ProtoMessage Uses

func (*ExpirationPolicy) ProtoMessage()

func (*ExpirationPolicy) ProtoReflect Uses

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

func (*ExpirationPolicy) Reset Uses

func (x *ExpirationPolicy) Reset()

func (*ExpirationPolicy) String Uses

func (x *ExpirationPolicy) String() string

type GetSchemaRequest Uses

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 `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"`
    // contains filtered or unexported fields
}

Request for the GetSchema method.

func (*GetSchemaRequest) Descriptor Uses

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

Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.

func (*GetSchemaRequest) GetName Uses

func (x *GetSchemaRequest) GetName() string

func (*GetSchemaRequest) GetView Uses

func (x *GetSchemaRequest) GetView() SchemaView

func (*GetSchemaRequest) ProtoMessage Uses

func (*GetSchemaRequest) ProtoMessage()

func (*GetSchemaRequest) ProtoReflect Uses

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

func (*GetSchemaRequest) Reset Uses

func (x *GetSchemaRequest) Reset()

func (*GetSchemaRequest) String Uses

func (x *GetSchemaRequest) String() string

type GetSnapshotRequest Uses

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 Uses

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

Deprecated: Use GetSnapshotRequest.ProtoReflect.Descriptor instead.

func (*GetSnapshotRequest) GetSnapshot Uses

func (x *GetSnapshotRequest) GetSnapshot() string

func (*GetSnapshotRequest) ProtoMessage Uses

func (*GetSnapshotRequest) ProtoMessage()

func (*GetSnapshotRequest) ProtoReflect Uses

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

func (*GetSnapshotRequest) Reset Uses

func (x *GetSnapshotRequest) Reset()

func (*GetSnapshotRequest) String Uses

func (x *GetSnapshotRequest) String() string

type GetSubscriptionRequest Uses

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 Uses

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

Deprecated: Use GetSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*GetSubscriptionRequest) GetSubscription Uses

func (x *GetSubscriptionRequest) GetSubscription() string

func (*GetSubscriptionRequest) ProtoMessage Uses

func (*GetSubscriptionRequest) ProtoMessage()

func (*GetSubscriptionRequest) ProtoReflect Uses

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

func (*GetSubscriptionRequest) Reset Uses

func (x *GetSubscriptionRequest) Reset()

func (*GetSubscriptionRequest) String Uses

func (x *GetSubscriptionRequest) String() string

type GetTopicRequest Uses

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 Uses

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

Deprecated: Use GetTopicRequest.ProtoReflect.Descriptor instead.

func (*GetTopicRequest) GetTopic Uses

func (x *GetTopicRequest) GetTopic() string

func (*GetTopicRequest) ProtoMessage Uses

func (*GetTopicRequest) ProtoMessage()

func (*GetTopicRequest) ProtoReflect Uses

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

func (*GetTopicRequest) Reset Uses

func (x *GetTopicRequest) Reset()

func (*GetTopicRequest) String Uses

func (x *GetTopicRequest) String() string

type ListSchemasRequest Uses

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 Uses

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

Deprecated: Use ListSchemasRequest.ProtoReflect.Descriptor instead.

func (*ListSchemasRequest) GetPageSize Uses

func (x *ListSchemasRequest) GetPageSize() int32

func (*ListSchemasRequest) GetPageToken Uses

func (x *ListSchemasRequest) GetPageToken() string

func (*ListSchemasRequest) GetParent Uses

func (x *ListSchemasRequest) GetParent() string

func (*ListSchemasRequest) GetView Uses

func (x *ListSchemasRequest) GetView() SchemaView

func (*ListSchemasRequest) ProtoMessage Uses

func (*ListSchemasRequest) ProtoMessage()

func (*ListSchemasRequest) ProtoReflect Uses

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

func (*ListSchemasRequest) Reset Uses

func (x *ListSchemasRequest) Reset()

func (*ListSchemasRequest) String Uses

func (x *ListSchemasRequest) String() string

type ListSchemasResponse Uses

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 Uses

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

Deprecated: Use ListSchemasResponse.ProtoReflect.Descriptor instead.

func (*ListSchemasResponse) GetNextPageToken Uses

func (x *ListSchemasResponse) GetNextPageToken() string

func (*ListSchemasResponse) GetSchemas Uses

func (x *ListSchemasResponse) GetSchemas() []*Schema

func (*ListSchemasResponse) ProtoMessage Uses

func (*ListSchemasResponse) ProtoMessage()

func (*ListSchemasResponse) ProtoReflect Uses

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

func (*ListSchemasResponse) Reset Uses

func (x *ListSchemasResponse) Reset()

func (*ListSchemasResponse) String Uses

func (x *ListSchemasResponse) String() string

type ListSnapshotsRequest Uses

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"`
    // Maximum number of snapshots to return.
    PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
    // 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 Uses

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

Deprecated: Use ListSnapshotsRequest.ProtoReflect.Descriptor instead.

func (*ListSnapshotsRequest) GetPageSize Uses

func (x *ListSnapshotsRequest) GetPageSize() int32

func (*ListSnapshotsRequest) GetPageToken Uses

func (x *ListSnapshotsRequest) GetPageToken() string

func (*ListSnapshotsRequest) GetProject Uses

func (x *ListSnapshotsRequest) GetProject() string

func (*ListSnapshotsRequest) ProtoMessage Uses

func (*ListSnapshotsRequest) ProtoMessage()

func (*ListSnapshotsRequest) ProtoReflect Uses

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

func (*ListSnapshotsRequest) Reset Uses

func (x *ListSnapshotsRequest) Reset()

func (*ListSnapshotsRequest) String Uses

func (x *ListSnapshotsRequest) String() string

type ListSnapshotsResponse Uses

type ListSnapshotsResponse struct {

    // The resulting snapshots.
    Snapshots []*Snapshot `protobuf:"bytes,1,rep,name=snapshots,proto3" json:"snapshots,omitempty"`
    // 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 Uses

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

Deprecated: Use ListSnapshotsResponse.ProtoReflect.Descriptor instead.

func (*ListSnapshotsResponse) GetNextPageToken Uses

func (x *ListSnapshotsResponse) GetNextPageToken() string

func (*ListSnapshotsResponse) GetSnapshots Uses

func (x *ListSnapshotsResponse) GetSnapshots() []*Snapshot

func (*ListSnapshotsResponse) ProtoMessage Uses

func (*ListSnapshotsResponse) ProtoMessage()

func (*ListSnapshotsResponse) ProtoReflect Uses

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

func (*ListSnapshotsResponse) Reset Uses

func (x *ListSnapshotsResponse) Reset()

func (*ListSnapshotsResponse) String Uses

func (x *ListSnapshotsResponse) String() string

type ListSubscriptionsRequest Uses

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"`
    // Maximum number of subscriptions to return.
    PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
    // 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 Uses

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

Deprecated: Use ListSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListSubscriptionsRequest) GetPageSize Uses

func (x *ListSubscriptionsRequest) GetPageSize() int32

func (*ListSubscriptionsRequest) GetPageToken Uses

func (x *ListSubscriptionsRequest) GetPageToken() string

func (*ListSubscriptionsRequest) GetProject Uses

func (x *ListSubscriptionsRequest) GetProject() string

func (*ListSubscriptionsRequest) ProtoMessage Uses

func (*ListSubscriptionsRequest) ProtoMessage()

func (*ListSubscriptionsRequest) ProtoReflect Uses

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

func (*ListSubscriptionsRequest) Reset Uses

func (x *ListSubscriptionsRequest) Reset()

func (*ListSubscriptionsRequest) String Uses

func (x *ListSubscriptionsRequest) String() string

type ListSubscriptionsResponse Uses

type ListSubscriptionsResponse struct {

    // The subscriptions that match the request.
    Subscriptions []*Subscription `protobuf:"bytes,1,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
    // 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 Uses

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

Deprecated: Use ListSubscriptionsResponse.ProtoReflect.Descriptor instead.

func (*ListSubscriptionsResponse) GetNextPageToken Uses

func (x *ListSubscriptionsResponse) GetNextPageToken() string

func (*ListSubscriptionsResponse) GetSubscriptions Uses

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

func (*ListSubscriptionsResponse) ProtoMessage Uses

func (*ListSubscriptionsResponse) ProtoMessage()

func (*ListSubscriptionsResponse) ProtoReflect Uses

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

func (*ListSubscriptionsResponse) Reset Uses

func (x *ListSubscriptionsResponse) Reset()

func (*ListSubscriptionsResponse) String Uses

func (x *ListSubscriptionsResponse) String() string

type ListTopicSnapshotsRequest Uses

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"`
    // Maximum number of snapshot names to return.
    PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
    // 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 Uses

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

Deprecated: Use ListTopicSnapshotsRequest.ProtoReflect.Descriptor instead.

func (*ListTopicSnapshotsRequest) GetPageSize Uses

func (x *ListTopicSnapshotsRequest) GetPageSize() int32

func (*ListTopicSnapshotsRequest) GetPageToken Uses

func (x *ListTopicSnapshotsRequest) GetPageToken() string

func (*ListTopicSnapshotsRequest) GetTopic Uses

func (x *ListTopicSnapshotsRequest) GetTopic() string

func (*ListTopicSnapshotsRequest) ProtoMessage Uses

func (*ListTopicSnapshotsRequest) ProtoMessage()

func (*ListTopicSnapshotsRequest) ProtoReflect Uses

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

func (*ListTopicSnapshotsRequest) Reset Uses

func (x *ListTopicSnapshotsRequest) Reset()

func (*ListTopicSnapshotsRequest) String Uses

func (x *ListTopicSnapshotsRequest) String() string

type ListTopicSnapshotsResponse Uses

type ListTopicSnapshotsResponse struct {

    // The names of the snapshots that match the request.
    Snapshots []string `protobuf:"bytes,1,rep,name=snapshots,proto3" json:"snapshots,omitempty"`
    // 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 Uses

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

Deprecated: Use ListTopicSnapshotsResponse.ProtoReflect.Descriptor instead.

func (*ListTopicSnapshotsResponse) GetNextPageToken Uses

func (x *ListTopicSnapshotsResponse) GetNextPageToken() string

func (*ListTopicSnapshotsResponse) GetSnapshots Uses

func (x *ListTopicSnapshotsResponse) GetSnapshots() []string

func (*ListTopicSnapshotsResponse) ProtoMessage Uses

func (*ListTopicSnapshotsResponse) ProtoMessage()

func (*ListTopicSnapshotsResponse) ProtoReflect Uses

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

func (*ListTopicSnapshotsResponse) Reset Uses

func (x *ListTopicSnapshotsResponse) Reset()

func (*ListTopicSnapshotsResponse) String Uses

func (x *ListTopicSnapshotsResponse) String() string

type ListTopicSubscriptionsRequest Uses

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"`
    // Maximum number of subscription names to return.
    PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
    // 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 Uses

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

Deprecated: Use ListTopicSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListTopicSubscriptionsRequest) GetPageSize Uses

func (x *ListTopicSubscriptionsRequest) GetPageSize() int32

func (*ListTopicSubscriptionsRequest) GetPageToken Uses

func (x *ListTopicSubscriptionsRequest) GetPageToken() string

func (*ListTopicSubscriptionsRequest) GetTopic Uses

func (x *ListTopicSubscriptionsRequest) GetTopic() string

func (*ListTopicSubscriptionsRequest) ProtoMessage Uses

func (*ListTopicSubscriptionsRequest) ProtoMessage()

func (*ListTopicSubscriptionsRequest) ProtoReflect Uses

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

func (*ListTopicSubscriptionsRequest) Reset Uses

func (x *ListTopicSubscriptionsRequest) Reset()

func (*ListTopicSubscriptionsRequest) String Uses

func (x *ListTopicSubscriptionsRequest) String() string

type ListTopicSubscriptionsResponse Uses

type ListTopicSubscriptionsResponse struct {

    // The names of subscriptions attached to the topic specified in the request.
    Subscriptions []string `protobuf:"bytes,1,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
    // 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 Uses

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

Deprecated: Use ListTopicSubscriptionsResponse.ProtoReflect.Descriptor instead.

func (*ListTopicSubscriptionsResponse) GetNextPageToken Uses

func (x *ListTopicSubscriptionsResponse) GetNextPageToken() string

func (*ListTopicSubscriptionsResponse) GetSubscriptions Uses

func (x *ListTopicSubscriptionsResponse) GetSubscriptions() []string

func (*ListTopicSubscriptionsResponse) ProtoMessage Uses

func (*ListTopicSubscriptionsResponse) ProtoMessage()

func (*ListTopicSubscriptionsResponse) ProtoReflect Uses

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

func (*ListTopicSubscriptionsResponse) Reset Uses

func (x *ListTopicSubscriptionsResponse) Reset()

func (*ListTopicSubscriptionsResponse) String Uses

func (x *ListTopicSubscriptionsResponse) String() string

type ListTopicsRequest Uses

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"`
    // Maximum number of topics to return.
    PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
    // 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 Uses

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

Deprecated: Use ListTopicsRequest.ProtoReflect.Descriptor instead.

func (*ListTopicsRequest) GetPageSize Uses

func (x *ListTopicsRequest) GetPageSize() int32

func (*ListTopicsRequest) GetPageToken Uses

func (x *ListTopicsRequest) GetPageToken() string

func (*ListTopicsRequest) GetProject Uses

func (x *ListTopicsRequest) GetProject() string

func (*ListTopicsRequest) ProtoMessage Uses

func (*ListTopicsRequest) ProtoMessage()

func (*ListTopicsRequest) ProtoReflect Uses

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

func (*ListTopicsRequest) Reset Uses

func (x *ListTopicsRequest) Reset()

func (*ListTopicsRequest) String Uses

func (x *ListTopicsRequest) String() string

type ListTopicsResponse Uses

type ListTopicsResponse struct {

    // The resulting topics.
    Topics []*Topic `protobuf:"bytes,1,rep,name=topics,proto3" json:"topics,omitempty"`
    // 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 Uses

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

Deprecated: Use ListTopicsResponse.ProtoReflect.Descriptor instead.

func (*ListTopicsResponse) GetNextPageToken Uses

func (x *ListTopicsResponse) GetNextPageToken() string

func (*ListTopicsResponse) GetTopics Uses

func (x *ListTopicsResponse) GetTopics() []*Topic

func (*ListTopicsResponse) ProtoMessage Uses

func (*ListTopicsResponse) ProtoMessage()

func (*ListTopicsResponse) ProtoReflect Uses

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

func (*ListTopicsResponse) Reset Uses

func (x *ListTopicsResponse) Reset()

func (*ListTopicsResponse) String Uses

func (x *ListTopicsResponse) String() string

type MessageStoragePolicy Uses

type MessageStoragePolicy struct {

    // A list of IDs of GCP regions where messages that are published to the topic
    // may be persisted in storage. Messages published by publishers running in
    // non-allowed GCP regions (or running outside of GCP altogether) will be
    // 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"`
    // contains filtered or unexported fields
}

A policy constraining the storage of messages published to the topic.

func (*MessageStoragePolicy) Descriptor Uses

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

Deprecated: Use MessageStoragePolicy.ProtoReflect.Descriptor instead.

func (*MessageStoragePolicy) GetAllowedPersistenceRegions Uses

func (x *MessageStoragePolicy) GetAllowedPersistenceRegions() []string

func (*MessageStoragePolicy) ProtoMessage Uses

func (*MessageStoragePolicy) ProtoMessage()

func (*MessageStoragePolicy) ProtoReflect Uses

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

func (*MessageStoragePolicy) Reset Uses

func (x *MessageStoragePolicy) Reset()

func (*MessageStoragePolicy) String Uses

func (x *MessageStoragePolicy) String() string

type ModifyAckDeadlineRequest Uses

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 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 Uses

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

Deprecated: Use ModifyAckDeadlineRequest.ProtoReflect.Descriptor instead.

func (*ModifyAckDeadlineRequest) GetAckDeadlineSeconds Uses

func (x *ModifyAckDeadlineRequest) GetAckDeadlineSeconds() int32

func (*ModifyAckDeadlineRequest) GetAckIds Uses

func (x *ModifyAckDeadlineRequest) GetAckIds() []string

func (*ModifyAckDeadlineRequest) GetSubscription Uses

func (x *ModifyAckDeadlineRequest) GetSubscription() string

func (*ModifyAckDeadlineRequest) ProtoMessage Uses

func (*ModifyAckDeadlineRequest) ProtoMessage()

func (*ModifyAckDeadlineRequest) ProtoReflect Uses

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

func (*ModifyAckDeadlineRequest) Reset Uses

func (x *ModifyAckDeadlineRequest) Reset()

func (*ModifyAckDeadlineRequest) String Uses

func (x *ModifyAckDeadlineRequest) String() string

type ModifyPushConfigRequest Uses

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 Uses

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

Deprecated: Use ModifyPushConfigRequest.ProtoReflect.Descriptor instead.

func (*ModifyPushConfigRequest) GetPushConfig Uses

func (x *ModifyPushConfigRequest) GetPushConfig() *PushConfig

func (*ModifyPushConfigRequest) GetSubscription Uses

func (x *ModifyPushConfigRequest) GetSubscription() string

func (*ModifyPushConfigRequest) ProtoMessage Uses

func (*ModifyPushConfigRequest) ProtoMessage()

func (*ModifyPushConfigRequest) ProtoReflect Uses

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

func (*ModifyPushConfigRequest) Reset Uses

func (x *ModifyPushConfigRequest) Reset()

func (*ModifyPushConfigRequest) String Uses

func (x *ModifyPushConfigRequest) String() string

type PublishRequest Uses

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 Uses

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

Deprecated: Use PublishRequest.ProtoReflect.Descriptor instead.

func (*PublishRequest) GetMessages Uses

func (x *PublishRequest) GetMessages() []*PubsubMessage

func (*PublishRequest) GetTopic Uses

func (x *PublishRequest) GetTopic() string

func (*PublishRequest) ProtoMessage Uses

func (*PublishRequest) ProtoMessage()

func (*PublishRequest) ProtoReflect Uses

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

func (*PublishRequest) Reset Uses

func (x *PublishRequest) Reset()

func (*PublishRequest) String Uses

func (x *PublishRequest) String() string

type PublishResponse Uses

type PublishResponse struct {

    // 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 Uses

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

Deprecated: Use PublishResponse.ProtoReflect.Descriptor instead.

func (*PublishResponse) GetMessageIds Uses

func (x *PublishResponse) GetMessageIds() []string

func (*PublishResponse) ProtoMessage Uses

func (*PublishResponse) ProtoMessage()

func (*PublishResponse) ProtoReflect Uses

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

func (*PublishResponse) Reset Uses

func (x *PublishResponse) Reset()

func (*PublishResponse) String Uses

func (x *PublishResponse) String() string

type PublisherClient Uses

type PublisherClient interface {
    // Creates the given topic with the given name. See the [resource name rules]
    // (https://cloud.google.com/pubsub/docs/admin#resource_names).
    CreateTopic(ctx context.Context, in *Topic, opts ...grpc.CallOption) (*Topic, error)
    // Updates an existing topic. 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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewPublisherClient Uses

func NewPublisherClient(cc grpc.ClientConnInterface) PublisherClient

type PublisherServer Uses

type PublisherServer interface {
    // Creates the given topic with the given name. See the [resource name rules]
    // (https://cloud.google.com/pubsub/docs/admin#resource_names).
    CreateTopic(context.Context, *Topic) (*Topic, error)
    // Updates an existing topic. 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.

type PubsubMessage Uses

type PubsubMessage struct {

    // 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"`
    // 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,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // 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"`
    // 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.
    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](https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.

func (*PubsubMessage) Descriptor Uses

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

Deprecated: Use PubsubMessage.ProtoReflect.Descriptor instead.

func (*PubsubMessage) GetAttributes Uses

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

func (*PubsubMessage) GetData Uses

func (x *PubsubMessage) GetData() []byte

func (*PubsubMessage) GetMessageId Uses

func (x *PubsubMessage) GetMessageId() string

func (*PubsubMessage) GetOrderingKey Uses

func (x *PubsubMessage) GetOrderingKey() string

func (*PubsubMessage) GetPublishTime Uses

func (x *PubsubMessage) GetPublishTime() *timestamppb.Timestamp

func (*PubsubMessage) ProtoMessage Uses

func (*PubsubMessage) ProtoMessage()

func (*PubsubMessage) ProtoReflect Uses

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

func (*PubsubMessage) Reset Uses

func (x *PubsubMessage) Reset()

func (*PubsubMessage) String Uses

func (x *PubsubMessage) String() string

type PullRequest Uses

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: Do not use.
    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 Uses

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

Deprecated: Use PullRequest.ProtoReflect.Descriptor instead.

func (*PullRequest) GetMaxMessages Uses

func (x *PullRequest) GetMaxMessages() int32

func (*PullRequest) GetReturnImmediately Uses

func (x *PullRequest) GetReturnImmediately() bool

Deprecated: Do not use.

func (*PullRequest) GetSubscription Uses

func (x *PullRequest) GetSubscription() string

func (*PullRequest) ProtoMessage Uses

func (*PullRequest) ProtoMessage()

func (*PullRequest) ProtoReflect Uses

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

func (*PullRequest) Reset Uses

func (x *PullRequest) Reset()

func (*PullRequest) String Uses

func (x *PullRequest) String() string

type PullResponse Uses

type PullResponse struct {

    // Received Pub/Sub messages. The list will be empty if there are no more
    // messages available in the backlog. 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 Uses

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

Deprecated: Use PullResponse.ProtoReflect.Descriptor instead.

func (*PullResponse) GetReceivedMessages Uses

func (x *PullResponse) GetReceivedMessages() []*ReceivedMessage

func (*PullResponse) ProtoMessage Uses

func (*PullResponse) ProtoMessage()

func (*PullResponse) ProtoReflect Uses

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

func (*PullResponse) Reset Uses

func (x *PullResponse) Reset()

func (*PullResponse) String Uses

func (x *PullResponse) String() string

type PushConfig Uses

type PushConfig struct {

    // 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"`
    // 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:
    // <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
    Attributes map[string]string `protobuf:"bytes,2,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // 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 Cloud Pub/Sub system, for example.
    // This field is optional and should be set only by users interested in
    // authenticated push.
    //
    // Types that are assignable to AuthenticationMethod:
    //	*PushConfig_OidcToken_
    AuthenticationMethod isPushConfig_AuthenticationMethod `protobuf_oneof:"authentication_method"`
    // contains filtered or unexported fields
}

Configuration for a push delivery endpoint.

func (*PushConfig) Descriptor Uses

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

Deprecated: Use PushConfig.ProtoReflect.Descriptor instead.

func (*PushConfig) GetAttributes Uses

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

func (*PushConfig) GetAuthenticationMethod Uses

func (m *PushConfig) GetAuthenticationMethod() isPushConfig_AuthenticationMethod

func (*PushConfig) GetOidcToken Uses

func (x *PushConfig) GetOidcToken() *PushConfig_OidcToken

func (*PushConfig) GetPushEndpoint Uses

func (x *PushConfig) GetPushEndpoint() string

func (*PushConfig) ProtoMessage Uses

func (*PushConfig) ProtoMessage()

func (*PushConfig) ProtoReflect Uses

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

func (*PushConfig) Reset Uses

func (x *PushConfig) Reset()

func (*PushConfig) String Uses

func (x *PushConfig) String() string

type PushConfig_OidcToken Uses

type PushConfig_OidcToken struct {

    // [Service account
    // email](https://cloud.google.com/iam/docs/service-accounts)
    // to be used for generating the OIDC token. The caller (for
    // CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
    // have the iam.serviceAccounts.actAs permission for the service account.
    ServiceAccountEmail string `protobuf:"bytes,1,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
    // Audience to be used when generating OIDC token. The audience claim
    // identifies the recipients that the JWT is intended for. The audience
    // value is a single case-sensitive string. Having multiple values (array)
    // for the audience field is not supported. More info about the OIDC JWT
    // token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
    // Note: if not specified, the Push endpoint URL will be used.
    Audience string `protobuf:"bytes,2,opt,name=audience,proto3" json:"audience,omitempty"`
    // contains filtered or unexported fields
}

Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).

func (*PushConfig_OidcToken) Descriptor Uses

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

Deprecated: Use PushConfig_OidcToken.ProtoReflect.Descriptor instead.

func (*PushConfig_OidcToken) GetAudience Uses

func (x *PushConfig_OidcToken) GetAudience() string

func (*PushConfig_OidcToken) GetServiceAccountEmail Uses

func (x *PushConfig_OidcToken) GetServiceAccountEmail() string

func (*PushConfig_OidcToken) ProtoMessage Uses

func (*PushConfig_OidcToken) ProtoMessage()

func (*PushConfig_OidcToken) ProtoReflect Uses

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

func (*PushConfig_OidcToken) Reset Uses

func (x *PushConfig_OidcToken) Reset()

func (*PushConfig_OidcToken) String Uses

func (x *PushConfig_OidcToken) String() string

type PushConfig_OidcToken_ Uses

type PushConfig_OidcToken_ struct {
    // If specified, Pub/Sub will generate and attach an OIDC JWT token as an
    // `Authorization` header in the HTTP request for every pushed message.
    OidcToken *PushConfig_OidcToken `protobuf:"bytes,3,opt,name=oidc_token,json=oidcToken,proto3,oneof"`
}

type ReceivedMessage Uses

type ReceivedMessage struct {

    // 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"`
    // The message.
    Message *PubsubMessage `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
    // The approximate number of times that Cloud 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 Uses

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

Deprecated: Use ReceivedMessage.ProtoReflect.Descriptor instead.

func (*ReceivedMessage) GetAckId Uses

func (x *ReceivedMessage) GetAckId() string

func (*ReceivedMessage) GetDeliveryAttempt Uses

func (x *ReceivedMessage) GetDeliveryAttempt() int32

func (*ReceivedMessage) GetMessage Uses

func (x *ReceivedMessage) GetMessage() *PubsubMessage

func (*ReceivedMessage) ProtoMessage Uses

func (*ReceivedMessage) ProtoMessage()

func (*ReceivedMessage) ProtoReflect Uses

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

func (*ReceivedMessage) Reset Uses

func (x *ReceivedMessage) Reset()

func (*ReceivedMessage) String Uses

func (x *ReceivedMessage) String() string

type RetryPolicy Uses

type RetryPolicy struct {

    // 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"`
    // 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 Cloud Pub/Sub retries message delivery.

Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.

RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.

Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.

func (*RetryPolicy) Descriptor Uses

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

Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.

func (*RetryPolicy) GetMaximumBackoff Uses

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

func (*RetryPolicy) GetMinimumBackoff Uses

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

func (*RetryPolicy) ProtoMessage Uses

func (*RetryPolicy) ProtoMessage()

func (*RetryPolicy) ProtoReflect Uses

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

func (*RetryPolicy) Reset Uses

func (x *RetryPolicy) Reset()

func (*RetryPolicy) String Uses

func (x *RetryPolicy) String() string

type Schema Uses

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"`
    // contains filtered or unexported fields
}

A schema resource.

func (*Schema) Descriptor Uses

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

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetDefinition Uses

func (x *Schema) GetDefinition() string

func (*Schema) GetName Uses

func (x *Schema) GetName() string

func (*Schema) GetType Uses

func (x *Schema) GetType() Schema_Type

func (*Schema) ProtoMessage Uses

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect Uses

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

func (*Schema) Reset Uses

func (x *Schema) Reset()

func (*Schema) String Uses

func (x *Schema) String() string

type SchemaServiceClient Uses

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)
    // 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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewSchemaServiceClient Uses

func NewSchemaServiceClient(cc grpc.ClientConnInterface) SchemaServiceClient

type SchemaServiceServer Uses

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)
    // 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.

type SchemaSettings Uses

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"`
    // The encoding of messages validated against `schema`.
    Encoding Encoding `protobuf:"varint,2,opt,name=encoding,proto3,enum=google.pubsub.v1.Encoding" json:"encoding,omitempty"`
    // contains filtered or unexported fields
}

Settings for validating messages published against a schema.

func (*SchemaSettings) Descriptor Uses

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

Deprecated: Use SchemaSettings.ProtoReflect.Descriptor instead.

func (*SchemaSettings) GetEncoding Uses

func (x *SchemaSettings) GetEncoding() Encoding

func (*SchemaSettings) GetSchema Uses

func (x *SchemaSettings) GetSchema() string

func (*SchemaSettings) ProtoMessage Uses

func (*SchemaSettings) ProtoMessage()

func (*SchemaSettings) ProtoReflect Uses

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

func (*SchemaSettings) Reset Uses

func (x *SchemaSettings) Reset()

func (*SchemaSettings) String Uses

func (x *SchemaSettings) String() string

type SchemaView Uses

type SchemaView int32

View of Schema object fields to be returned by GetSchema and ListSchemas.

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 Uses

func (SchemaView) Descriptor() protoreflect.EnumDescriptor

func (SchemaView) Enum Uses

func (x SchemaView) Enum() *SchemaView

func (SchemaView) EnumDescriptor Uses

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

Deprecated: Use SchemaView.Descriptor instead.

func (SchemaView) Number Uses

func (x SchemaView) Number() protoreflect.EnumNumber

func (SchemaView) String Uses

func (x SchemaView) String() string

func (SchemaView) Type Uses

func (SchemaView) Type() protoreflect.EnumType

type Schema_Type Uses

type Schema_Type int32

Possible schema definition types.

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 Uses

func (Schema_Type) Descriptor() protoreflect.EnumDescriptor

func (Schema_Type) Enum Uses

func (x Schema_Type) Enum() *Schema_Type

func (Schema_Type) EnumDescriptor Uses

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

Deprecated: Use Schema_Type.Descriptor instead.

func (Schema_Type) Number Uses

func (x Schema_Type) Number() protoreflect.EnumNumber

func (Schema_Type) String Uses

func (x Schema_Type) String() string

func (Schema_Type) Type Uses

func (Schema_Type) Type() protoreflect.EnumType

type SeekRequest Uses

type SeekRequest struct {

    // Required. The subscription to affect.
    Subscription string `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
    // Types that are assignable 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 Uses

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

Deprecated: Use SeekRequest.ProtoReflect.Descriptor instead.

func (*SeekRequest) GetSnapshot Uses

func (x *SeekRequest) GetSnapshot() string

func (*SeekRequest) GetSubscription Uses

func (x *SeekRequest) GetSubscription() string

func (*SeekRequest) GetTarget Uses

func (m *SeekRequest) GetTarget() isSeekRequest_Target

func (*SeekRequest) GetTime Uses

func (x *SeekRequest) GetTime() *timestamppb.Timestamp

func (*SeekRequest) ProtoMessage Uses

func (*SeekRequest) ProtoMessage()

func (*SeekRequest) ProtoReflect Uses

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

func (*SeekRequest) Reset Uses

func (x *SeekRequest) Reset()

func (*SeekRequest) String Uses

func (x *SeekRequest) String() string

type SeekRequest_Snapshot Uses

type SeekRequest_Snapshot struct {
    // 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"`
}

type SeekRequest_Time Uses

type SeekRequest_Time struct {
    // 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"`
}

type SeekResponse Uses

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

Response for the `Seek` method (this response is empty).

func (*SeekResponse) Descriptor Uses

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

Deprecated: Use SeekResponse.ProtoReflect.Descriptor instead.

func (*SeekResponse) ProtoMessage Uses

func (*SeekResponse) ProtoMessage()

func (*SeekResponse) ProtoReflect Uses

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

func (*SeekResponse) Reset Uses

func (x *SeekResponse) Reset()

func (*SeekResponse) String Uses

func (x *SeekResponse) String() string

type Snapshot Uses

type Snapshot struct {

    // The name of the snapshot.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // The name of the topic from which this snapshot is retaining messages.
    Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
    // 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"`
    // 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,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // contains filtered or unexported fields
}

A snapshot resource. 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.

func (*Snapshot) Descriptor Uses

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

Deprecated: Use Snapshot.ProtoReflect.Descriptor instead.

func (*Snapshot) GetExpireTime Uses

func (x *Snapshot) GetExpireTime() *timestamppb.Timestamp

func (*Snapshot) GetLabels Uses

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

func (*Snapshot) GetName Uses

func (x *Snapshot) GetName() string

func (*Snapshot) GetTopic Uses

func (x *Snapshot) GetTopic() string

func (*Snapshot) ProtoMessage Uses

func (*Snapshot) ProtoMessage()

func (*Snapshot) ProtoReflect Uses

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

func (*Snapshot) Reset Uses

func (x *Snapshot) Reset()

func (*Snapshot) String Uses

func (x *Snapshot) String() string

type StreamingPullRequest Uses

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"`
    // List of acknowledgement 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 acknowledgement 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"`
    // 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"`
    // List of acknowledgement 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"`
    // 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"`
    // Flow control settings for the maximum number of outstanding messages. When
    // there are `max_outstanding_messages` or more 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"`
    // 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"`
    // 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 acknowledgements and ack deadline modifications from the client to the server.

func (*StreamingPullRequest) Descriptor Uses

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

Deprecated: Use StreamingPullRequest.ProtoReflect.Descriptor instead.

func (*StreamingPullRequest) GetAckIds Uses

func (x *StreamingPullRequest) GetAckIds() []string

func (*StreamingPullRequest) GetClientId Uses

func (x *StreamingPullRequest) GetClientId() string

func (*StreamingPullRequest) GetMaxOutstandingBytes Uses

func (x *StreamingPullRequest) GetMaxOutstandingBytes() int64

func (*StreamingPullRequest) GetMaxOutstandingMessages Uses

func (x *StreamingPullRequest) GetMaxOutstandingMessages() int64

func (*StreamingPullRequest) GetModifyDeadlineAckIds Uses

func (x *StreamingPullRequest) GetModifyDeadlineAckIds() []string

func (*StreamingPullRequest) GetModifyDeadlineSeconds Uses

func (x *StreamingPullRequest) GetModifyDeadlineSeconds() []int32

func (*StreamingPullRequest) GetStreamAckDeadlineSeconds Uses

func (x *StreamingPullRequest) GetStreamAckDeadlineSeconds() int32

func (*StreamingPullRequest) GetSubscription Uses

func (x *StreamingPullRequest) GetSubscription() string

func (*StreamingPullRequest) ProtoMessage Uses

func (*StreamingPullRequest) ProtoMessage()

func (*StreamingPullRequest) ProtoReflect Uses

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

func (*StreamingPullRequest) Reset Uses

func (x *StreamingPullRequest) Reset()

func (*StreamingPullRequest) String Uses

func (x *StreamingPullRequest) String() string

type StreamingPullResponse Uses

type StreamingPullResponse struct {

    // Received Pub/Sub messages. This will not be empty.
    ReceivedMessages []*ReceivedMessage `protobuf:"bytes,1,rep,name=received_messages,json=receivedMessages,proto3" json:"received_messages,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 Uses

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

Deprecated: Use StreamingPullResponse.ProtoReflect.Descriptor instead.

func (*StreamingPullResponse) GetReceivedMessages Uses

func (x *StreamingPullResponse) GetReceivedMessages() []*ReceivedMessage

func (*StreamingPullResponse) ProtoMessage Uses

func (*StreamingPullResponse) ProtoMessage()

func (*StreamingPullResponse) ProtoReflect Uses

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

func (*StreamingPullResponse) Reset Uses

func (x *StreamingPullResponse) Reset()

func (*StreamingPullResponse) String Uses

func (x *StreamingPullResponse) String() string

type SubscriberClient Uses

type SubscriberClient interface {
    // Creates a subscription to a given topic. See the [resource name rules]
    // (https://cloud.google.com/pubsub/docs/admin#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/admin#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. 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. The server may return `UNAVAILABLE` if
    // there are too many concurrent pull requests pending for the given
    // subscription.
    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 acknowledgements 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
    // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
    // 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/admin#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. Snapshots are used in
    // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
    // 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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewSubscriberClient Uses

func NewSubscriberClient(cc grpc.ClientConnInterface) SubscriberClient

type SubscriberServer Uses

type SubscriberServer interface {
    // Creates a subscription to a given topic. See the [resource name rules]
    // (https://cloud.google.com/pubsub/docs/admin#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/admin#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. 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. The server may return `UNAVAILABLE` if
    // there are too many concurrent pull requests pending for the given
    // subscription.
    Pull(context.Context, *PullRequest) (*PullResponse, error)
    // Establishes a stream with the server, which sends messages down to the
    // client. The client streams acknowledgements 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
    // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
    // 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/admin#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. Snapshots are used in
    // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
    // 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.

type Subscriber_StreamingPullClient Uses

type Subscriber_StreamingPullClient interface {
    Send(*StreamingPullRequest) error
    Recv() (*StreamingPullResponse, error)
    grpc.ClientStream
}

type Subscriber_StreamingPullServer Uses

type Subscriber_StreamingPullServer interface {
    Send(*StreamingPullResponse) error
    Recv() (*StreamingPullRequest, error)
    grpc.ServerStream
}

type Subscription Uses

type Subscription struct {

    // Required. 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"`
    // If push delivery is used with this subscription, this field is
    // used to configure it. An empty `pushConfig` signifies that the subscriber
    // will pull and ack messages using API methods.
    PushConfig *PushConfig `protobuf:"bytes,4,opt,name=push_config,json=pushConfig,proto3" json:"push_config,omitempty"`
    // 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 <i>outstanding</i>. 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"`
    // 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).
    RetainAckedMessages bool `protobuf:"varint,7,opt,name=retain_acked_messages,json=retainAckedMessages,proto3" json:"retain_acked_messages,omitempty"`
    // 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 7 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"`
    // See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
    // managing labels</a>.
    Labels map[string]string `protobuf:"bytes,9,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // 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"`
    // 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.
    ExpirationPolicy *ExpirationPolicy `protobuf:"bytes,11,opt,name=expiration_policy,json=expirationPolicy,proto3" json:"expiration_policy,omitempty"`
    // 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"`
    // 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 Cloud 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"`
    // A policy that specifies how Pub/Sub retries message delivery for this
    // subscription.
    //
    // If not set, the default retry policy is applied. This generally implies
    // that messages will be retried as soon as possible for healthy subscribers.
    // RetryPolicy will be triggered on NACKs or acknowledgement deadline
    // exceeded events for a given message.
    RetryPolicy *RetryPolicy `protobuf:"bytes,14,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
    // 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"`
    // contains filtered or unexported fields
}

A subscription resource.

func (*Subscription) Descriptor Uses

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

Deprecated: Use Subscription.ProtoReflect.Descriptor instead.

func (*Subscription) GetAckDeadlineSeconds Uses

func (x *Subscription) GetAckDeadlineSeconds() int32

func (*Subscription) GetDeadLetterPolicy Uses

func (x *Subscription) GetDeadLetterPolicy() *DeadLetterPolicy

func (*Subscription) GetDetached Uses

func (x *Subscription) GetDetached() bool

func (*Subscription) GetEnableMessageOrdering Uses

func (x *Subscription) GetEnableMessageOrdering() bool

func (*Subscription) GetExpirationPolicy Uses

func (x *Subscription) GetExpirationPolicy() *ExpirationPolicy

func (*Subscription) GetFilter Uses

func (x *Subscription) GetFilter() string

func (*Subscription) GetLabels Uses

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

func (*Subscription) GetMessageRetentionDuration Uses

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

func (*Subscription) GetName Uses

func (x *Subscription) GetName() string

func (*Subscription) GetPushConfig Uses

func (x *Subscription) GetPushConfig() *PushConfig

func (*Subscription) GetRetainAckedMessages Uses

func (x *Subscription) GetRetainAckedMessages() bool

func (*Subscription) GetRetryPolicy Uses

func (x *Subscription) GetRetryPolicy() *RetryPolicy

func (*Subscription) GetTopic Uses

func (x *Subscription) GetTopic() string

func (*Subscription) ProtoMessage Uses

func (*Subscription) ProtoMessage()

func (*Subscription) ProtoReflect Uses

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

func (*Subscription) Reset Uses

func (x *Subscription) Reset()

func (*Subscription) String Uses

func (x *Subscription) String() string

type Topic Uses

type Topic struct {

    // Required. 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"`
    // 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,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // 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"`
    // 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"`
    // Settings for validating messages published against a schema.
    //
    // EXPERIMENTAL: Schema support is in development and may not work yet.
    SchemaSettings *SchemaSettings `protobuf:"bytes,6,opt,name=schema_settings,json=schemaSettings,proto3" json:"schema_settings,omitempty"`
    // 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"`
    // contains filtered or unexported fields
}

A topic resource.

func (*Topic) Descriptor Uses

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

Deprecated: Use Topic.ProtoReflect.Descriptor instead.

func (*Topic) GetKmsKeyName Uses

func (x *Topic) GetKmsKeyName() string

func (*Topic) GetLabels Uses

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

func (*Topic) GetMessageStoragePolicy Uses

func (x *Topic) GetMessageStoragePolicy() *MessageStoragePolicy

func (*Topic) GetName Uses

func (x *Topic) GetName() string

func (*Topic) GetSatisfiesPzs Uses

func (x *Topic) GetSatisfiesPzs() bool

func (*Topic) GetSchemaSettings Uses

func (x *Topic) GetSchemaSettings() *SchemaSettings

func (*Topic) ProtoMessage Uses

func (*Topic) ProtoMessage()

func (*Topic) ProtoReflect Uses

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

func (*Topic) Reset Uses

func (x *Topic) Reset()

func (*Topic) String Uses

func (x *Topic) String() string

type UnimplementedPublisherServer Uses

type UnimplementedPublisherServer struct {
}

UnimplementedPublisherServer can be embedded to have forward compatible implementations.

func (*UnimplementedPublisherServer) CreateTopic Uses

func (*UnimplementedPublisherServer) CreateTopic(context.Context, *Topic) (*Topic, error)

func (*UnimplementedPublisherServer) DeleteTopic Uses

func (*UnimplementedPublisherServer) DeleteTopic(context.Context, *DeleteTopicRequest) (*emptypb.Empty, error)

func (*UnimplementedPublisherServer) DetachSubscription Uses

func (*UnimplementedPublisherServer) DetachSubscription(context.Context, *DetachSubscriptionRequest) (*DetachSubscriptionResponse, error)

func (*UnimplementedPublisherServer) GetTopic Uses

func (*UnimplementedPublisherServer) GetTopic(context.Context, *GetTopicRequest) (*Topic, error)

func (*UnimplementedPublisherServer) ListTopicSnapshots Uses

func (*UnimplementedPublisherServer) ListTopicSnapshots(context.Context, *ListTopicSnapshotsRequest) (*ListTopicSnapshotsResponse, error)

func (*UnimplementedPublisherServer) ListTopicSubscriptions Uses

func (*UnimplementedPublisherServer) ListTopicSubscriptions(context.Context, *ListTopicSubscriptionsRequest) (*ListTopicSubscriptionsResponse, error)

func (*UnimplementedPublisherServer) ListTopics Uses

func (*UnimplementedPublisherServer) ListTopics(context.Context, *ListTopicsRequest) (*ListTopicsResponse, error)

func (*UnimplementedPublisherServer) Publish Uses

func (*UnimplementedPublisherServer) Publish(context.Context, *PublishRequest) (*PublishResponse, error)

func (*UnimplementedPublisherServer) UpdateTopic Uses

func (*UnimplementedPublisherServer) UpdateTopic(context.Context, *UpdateTopicRequest) (*Topic, error)

type UnimplementedSchemaServiceServer Uses

type UnimplementedSchemaServiceServer struct {
}

UnimplementedSchemaServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSchemaServiceServer) CreateSchema Uses

func (*UnimplementedSchemaServiceServer) CreateSchema(context.Context, *CreateSchemaRequest) (*Schema, error)

func (*UnimplementedSchemaServiceServer) DeleteSchema Uses

func (*UnimplementedSchemaServiceServer) DeleteSchema(context.Context, *DeleteSchemaRequest) (*emptypb.Empty, error)

func (*UnimplementedSchemaServiceServer) GetSchema Uses

func (*UnimplementedSchemaServiceServer) GetSchema(context.Context, *GetSchemaRequest) (*Schema, error)

func (*UnimplementedSchemaServiceServer) ListSchemas Uses

func (*UnimplementedSchemaServiceServer) ListSchemas(context.Context, *ListSchemasRequest) (*ListSchemasResponse, error)

func (*UnimplementedSchemaServiceServer) ValidateMessage Uses

func (*UnimplementedSchemaServiceServer) ValidateMessage(context.Context, *ValidateMessageRequest) (*ValidateMessageResponse, error)

func (*UnimplementedSchemaServiceServer) ValidateSchema Uses

func (*UnimplementedSchemaServiceServer) ValidateSchema(context.Context, *ValidateSchemaRequest) (*ValidateSchemaResponse, error)

type UnimplementedSubscriberServer Uses

type UnimplementedSubscriberServer struct {
}

UnimplementedSubscriberServer can be embedded to have forward compatible implementations.

func (*UnimplementedSubscriberServer) Acknowledge Uses

func (*UnimplementedSubscriberServer) Acknowledge(context.Context, *AcknowledgeRequest) (*emptypb.Empty, error)

func (*UnimplementedSubscriberServer) CreateSnapshot Uses

func (*UnimplementedSubscriberServer) CreateSnapshot(context.Context, *CreateSnapshotRequest) (*Snapshot, error)

func (*UnimplementedSubscriberServer) CreateSubscription Uses

func (*UnimplementedSubscriberServer) CreateSubscription(context.Context, *Subscription) (*Subscription, error)

func (*UnimplementedSubscriberServer) DeleteSnapshot Uses

func (*UnimplementedSubscriberServer) DeleteSnapshot(context.Context, *DeleteSnapshotRequest) (*emptypb.Empty, error)

func (*UnimplementedSubscriberServer) DeleteSubscription Uses

func (*UnimplementedSubscriberServer) DeleteSubscription(context.Context, *DeleteSubscriptionRequest) (*emptypb.Empty, error)

func (*UnimplementedSubscriberServer) GetSnapshot Uses

func (*UnimplementedSubscriberServer) GetSnapshot(context.Context, *GetSnapshotRequest) (*Snapshot, error)

func (*UnimplementedSubscriberServer) GetSubscription Uses

func (*UnimplementedSubscriberServer) GetSubscription(context.Context, *GetSubscriptionRequest) (*Subscription, error)

func (*UnimplementedSubscriberServer) ListSnapshots Uses

func (*UnimplementedSubscriberServer) ListSnapshots(context.Context, *ListSnapshotsRequest) (*ListSnapshotsResponse, error)

func (*UnimplementedSubscriberServer) ListSubscriptions Uses

func (*UnimplementedSubscriberServer) ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*ListSubscriptionsResponse, error)

func (*UnimplementedSubscriberServer) ModifyAckDeadline Uses

func (*UnimplementedSubscriberServer) ModifyAckDeadline(context.Context, *ModifyAckDeadlineRequest) (*emptypb.Empty, error)

func (*UnimplementedSubscriberServer) ModifyPushConfig Uses

func (*UnimplementedSubscriberServer) ModifyPushConfig(context.Context, *ModifyPushConfigRequest) (*emptypb.Empty, error)

func (*UnimplementedSubscriberServer) Pull Uses

func (*UnimplementedSubscriberServer) Pull(context.Context, *PullRequest) (*PullResponse, error)

func (*UnimplementedSubscriberServer) Seek Uses

func (*UnimplementedSubscriberServer) Seek(context.Context, *SeekRequest) (*SeekResponse, error)

func (*UnimplementedSubscriberServer) StreamingPull Uses

func (*UnimplementedSubscriberServer) StreamingPull(Subscriber_StreamingPullServer) error

func (*UnimplementedSubscriberServer) UpdateSnapshot Uses

func (*UnimplementedSubscriberServer) UpdateSnapshot(context.Context, *UpdateSnapshotRequest) (*Snapshot, error)

func (*UnimplementedSubscriberServer) UpdateSubscription Uses

func (*UnimplementedSubscriberServer) UpdateSubscription(context.Context, *UpdateSubscriptionRequest) (*Subscription, error)

type UpdateSnapshotRequest Uses

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 Uses

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

Deprecated: Use UpdateSnapshotRequest.ProtoReflect.Descriptor instead.

func (*UpdateSnapshotRequest) GetSnapshot Uses

func (x *UpdateSnapshotRequest) GetSnapshot() *Snapshot

func (*UpdateSnapshotRequest) GetUpdateMask Uses

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

func (*UpdateSnapshotRequest) ProtoMessage Uses

func (*UpdateSnapshotRequest) ProtoMessage()

func (*UpdateSnapshotRequest) ProtoReflect Uses

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

func (*UpdateSnapshotRequest) Reset Uses

func (x *UpdateSnapshotRequest) Reset()

func (*UpdateSnapshotRequest) String Uses

func (x *UpdateSnapshotRequest) String() string

type UpdateSubscriptionRequest Uses

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 Uses

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

Deprecated: Use UpdateSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*UpdateSubscriptionRequest) GetSubscription Uses

func (x *UpdateSubscriptionRequest) GetSubscription() *Subscription

func (*UpdateSubscriptionRequest) GetUpdateMask Uses

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

func (*UpdateSubscriptionRequest) ProtoMessage Uses

func (*UpdateSubscriptionRequest) ProtoMessage()

func (*UpdateSubscriptionRequest) ProtoReflect Uses

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

func (*UpdateSubscriptionRequest) Reset Uses

func (x *UpdateSubscriptionRequest) Reset()

func (*UpdateSubscriptionRequest) String Uses

func (x *UpdateSubscriptionRequest) String() string

type UpdateTopicRequest Uses

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 Uses

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

Deprecated: Use UpdateTopicRequest.ProtoReflect.Descriptor instead.

func (*UpdateTopicRequest) GetTopic Uses

func (x *UpdateTopicRequest) GetTopic() *Topic

func (*UpdateTopicRequest) GetUpdateMask Uses

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

func (*UpdateTopicRequest) ProtoMessage Uses

func (*UpdateTopicRequest) ProtoMessage()

func (*UpdateTopicRequest) ProtoReflect Uses

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

func (*UpdateTopicRequest) Reset Uses

func (x *UpdateTopicRequest) Reset()

func (*UpdateTopicRequest) String Uses

func (x *UpdateTopicRequest) String() string

type ValidateMessageRequest Uses

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 assignable 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 Uses

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

Deprecated: Use ValidateMessageRequest.ProtoReflect.Descriptor instead.

func (*ValidateMessageRequest) GetEncoding Uses

func (x *ValidateMessageRequest) GetEncoding() Encoding

func (*ValidateMessageRequest) GetMessage Uses

func (x *ValidateMessageRequest) GetMessage() []byte

func (*ValidateMessageRequest) GetName Uses

func (x *ValidateMessageRequest) GetName() string

func (*ValidateMessageRequest) GetParent Uses

func (x *ValidateMessageRequest) GetParent() string

func (*ValidateMessageRequest) GetSchema Uses

func (x *ValidateMessageRequest) GetSchema() *Schema

func (*ValidateMessageRequest) GetSchemaSpec Uses

func (m *ValidateMessageRequest) GetSchemaSpec() isValidateMessageRequest_SchemaSpec

func (*ValidateMessageRequest) ProtoMessage Uses

func (*ValidateMessageRequest) ProtoMessage()

func (*ValidateMessageRequest) ProtoReflect Uses

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

func (*ValidateMessageRequest) Reset Uses

func (x *ValidateMessageRequest) Reset()

func (*ValidateMessageRequest) String Uses

func (x *ValidateMessageRequest) String() string

type ValidateMessageRequest_Name Uses

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

type ValidateMessageRequest_Schema Uses

type ValidateMessageRequest_Schema struct {
    // Ad-hoc schema against which to validate
    Schema *Schema `protobuf:"bytes,3,opt,name=schema,proto3,oneof"`
}

type ValidateMessageResponse Uses

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

Response for the `ValidateMessage` method.

func (*ValidateMessageResponse) Descriptor Uses

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

Deprecated: Use ValidateMessageResponse.ProtoReflect.Descriptor instead.

func (*ValidateMessageResponse) ProtoMessage Uses

func (*ValidateMessageResponse) ProtoMessage()

func (*ValidateMessageResponse) ProtoReflect Uses

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

func (*ValidateMessageResponse) Reset Uses

func (x *ValidateMessageResponse) Reset()

func (*ValidateMessageResponse) String Uses

func (x *ValidateMessageResponse) String() string

type ValidateSchemaRequest Uses

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 Uses

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

Deprecated: Use ValidateSchemaRequest.ProtoReflect.Descriptor instead.

func (*ValidateSchemaRequest) GetParent Uses

func (x *ValidateSchemaRequest) GetParent() string

func (*ValidateSchemaRequest) GetSchema Uses

func (x *ValidateSchemaRequest) GetSchema() *Schema

func (*ValidateSchemaRequest) ProtoMessage Uses

func (*ValidateSchemaRequest) ProtoMessage()

func (*ValidateSchemaRequest) ProtoReflect Uses

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

func (*ValidateSchemaRequest) Reset Uses

func (x *ValidateSchemaRequest) Reset()

func (*ValidateSchemaRequest) String Uses

func (x *ValidateSchemaRequest) String() string

type ValidateSchemaResponse Uses

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

Response for the `ValidateSchema` method.

func (*ValidateSchemaResponse) Descriptor Uses

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

Deprecated: Use ValidateSchemaResponse.ProtoReflect.Descriptor instead.

func (*ValidateSchemaResponse) ProtoMessage Uses

func (*ValidateSchemaResponse) ProtoMessage()

func (*ValidateSchemaResponse) ProtoReflect Uses

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

func (*ValidateSchemaResponse) Reset Uses

func (x *ValidateSchemaResponse) Reset()

func (*ValidateSchemaResponse) String Uses

func (x *ValidateSchemaResponse) String() string

Package pubsub imports 14 packages (graph) and is imported by 34 packages. Updated 2021-01-06. Refresh now. Tools for package owners.