subscriptionspb

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

type CreateSubscriptionRequest struct {

	// Required. The subscription resource to create.
	Subscription *Subscription `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
	// Optional. If set to `true`, validates and previews the request, but doesn't
	// create the subscription.
	ValidateOnly bool `protobuf:"varint,2,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

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

type DeleteSubscriptionRequest struct {

	// Required. Resource name of the subscription to delete.
	//
	// Format: `subscriptions/{subscription}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. If set to `true`, validates and previews the request, but doesn't
	// delete the subscription.
	ValidateOnly bool `protobuf:"varint,2,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// Optional. If set to `true` and the subscription isn't found, the request
	// succeeds but doesn't delete the subscription.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// Optional. Etag of the subscription.
	//
	// If present, it must match with the server's etag. Otherwise, request
	// fails with the status `ABORTED`.
	Etag string `protobuf:"bytes,4,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

type GetSubscriptionRequest struct {

	// Required. Resource name of the subscription.
	//
	// Format: `subscriptions/{subscription}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type ListSubscriptionsRequest struct {

	// Optional. The maximum number of subscriptions to return. The service might
	// return fewer than this value.
	//
	// If unspecified or set to `0`, up to 50 subscriptions are returned.
	//
	// The maximum value is 100. If you specify a value more than 100, the system
	// only returns 100 subscriptions.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous list subscriptions call.
	// Provide this parameter to retrieve the subsequent page.
	//
	// When paginating, the filter value should match the call that provided the
	// page token. Passing a different value might lead to unexpected results.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Required. A query filter.
	//
	// You can filter subscriptions by event type (`event_types`)
	// and target resource (`target_resource`).
	//
	// You must specify at least one event type in your query. To filter for
	// multiple event types, use the `OR` operator.
	//
	// To filter by both event type and target resource, use the `AND` operator
	// and specify the full resource name, such as
	// `//chat.googleapis.com/spaces/{space}`.
	//
	// For example, the following queries are valid:
	//
	// “`
	// event_types:"google.workspace.chat.membership.v1.updated" OR
	//
	//	event_types:"google.workspace.chat.message.v1.created"
	//
	// event_types:"google.workspace.chat.message.v1.created" AND
	//
	//	target_resource="//chat.googleapis.com/spaces/{space}"
	//
	// ( event_types:"google.workspace.chat.membership.v1.updated" OR
	//
	//	event_types:"google.workspace.chat.message.v1.created" ) AND
	//	target_resource="//chat.googleapis.com/spaces/{space}"
	//
	// “`
	//
	// The server rejects invalid queries with an `INVALID_ARGUMENT`
	// error.
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

type ListSubscriptionsResponse struct {

	// List of subscriptions.
	Subscriptions []*Subscription `protobuf:"bytes,1,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

type NotificationEndpoint struct {

	// Types that are assignable to Endpoint:
	//
	//	*NotificationEndpoint_PubsubTopic
	Endpoint isNotificationEndpoint_Endpoint `protobuf_oneof:"endpoint"`
	// contains filtered or unexported fields
}

type NotificationEndpoint_PubsubTopic struct {
	// Immutable. The Cloud Pub/Sub topic that receives events for the
	// subscription.
	//
	// Format: `projects/{project}/topics/{topic}`
	//
	// You must create the topic in the same Google Cloud project where
	// you create this subscription.
	//
	// When the topic receives events, the events are encoded as Cloud Pub/Sub
	// messages. For details, see the [Google Cloud Pub/Sub Protocol Binding for
	// CloudEvents](https://github.com/googleapis/google-cloudevents/blob/main/docs/spec/pubsub.md).
	PubsubTopic string `protobuf:"bytes,1,opt,name=pubsub_topic,json=pubsubTopic,proto3,oneof"`
}

type PayloadOptions struct {

	// Optional. Whether the event payload includes data about the resource that
	// changed. For example, for an event where a Google Chat message was created,
	// whether the payload contains data about the
	// [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages)
	// resource. If false, the event payload only includes the name of the changed
	// resource.
	IncludeResource bool `protobuf:"varint,1,opt,name=include_resource,json=includeResource,proto3" json:"include_resource,omitempty"`
	// Optional. If `include_resource` is set to `true`, the list of fields to
	// include in the event payload. Separate fields with a comma. For example, to
	// include a Google Chat message's sender and create time, enter
	// `message.sender,message.createTime`. If omitted, the payload includes all
	// fields for the resource.
	//
	// If you specify a field that doesn't exist for the resource, the system
	// ignores the field.
	FieldMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// contains filtered or unexported fields
}

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

type ReactivateSubscriptionRequest struct {

	// Required. Resource name of the subscription.
	//
	// Format: `subscriptions/{subscription}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type Subscription struct {

	// The time when the subscription expires.
	//
	// The maximum expiration time depends on whether your subscription includes
	// resource data in event payloads (specified in the
	// [PayloadOptions][google.apps.events.subscriptions.v1.PayloadOptions]
	// field):
	//
	// * If payloads omit resource data, up to 7 days.
	// * If payloads include resource data, up to 4 hours. If your Google
	// Workspace organization grants access to the resource through [domain-wide
	// delegation](https://support.google.com/a/answer/162106), you can extend the
	// subscription's expiration time to up to 24 hours.
	//
	// After a subscription expires, it's deleted automatically. You receive
	// lifecycle events to the
	// [notification_endpoint][google.apps.events.subscriptions.v1.Subscription.notification_endpoint]
	// 12 hours and one hour before the subscription expires. For details, see
	// [Receive and respond to lifecycle
	// events](https://developers.google.com/workspace/events/guides/events-lifecycle).
	//
	// To prevent a subscription from expiring, you can use the
	// [`UpdateSubscription`][google.apps.events.subscriptions.v1.SubscriptionsService.UpdateSubscription]
	// method to extend its expiration date. For details, see [Update or renew a
	// subscription](https://developers.google.com/workspace/events/guides/update-subscription).
	//
	// Types that are assignable to Expiration:
	//
	//	*Subscription_ExpireTime
	//	*Subscription_Ttl
	Expiration isSubscription_Expiration `protobuf_oneof:"expiration"`
	// Optional. Immutable. Identifier. Resource name of the subscription.
	//
	// Format: `subscriptions/{subscription}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. System-assigned unique identifier for the subscription.
	Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"`
	// Required. Immutable. The Google Workspace resource that's monitored for
	// events, formatted as the [full resource
	// name](https://google.aip.dev/122#full-resource-names). To learn about
	// target resources and the events that they support, see [Supported Google
	// Workspace
	// events](https://developers.google.com/workspace/events#supported-events).
	//
	// A user can only authorize your app to create one subscription for a given
	// target resource. If your app tries to create another subscription with the
	// same user credentials, the request returns an `ALREADY_EXISTS` error.
	TargetResource string `protobuf:"bytes,4,opt,name=target_resource,json=targetResource,proto3" json:"target_resource,omitempty"`
	// Required. Immutable. Unordered list. Input for creating a subscription.
	// Otherwise, output only. One or more types of events to receive about the
	// target resource. Formatted according to the CloudEvents specification.
	//
	// The supported event types depend on the target resource of your
	// subscription. For details, see [Supported Google Workspace
	// events](https://developers.google.com/workspace/events/guides#supported-events).
	//
	// By default, you also receive events about the [lifecycle of your
	// subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
	// You don't need to specify lifecycle events for this field.
	//
	// If you specify an event type that doesn't exist for the target resource,
	// the request returns an HTTP `400 Bad Request` status code.
	EventTypes []string `protobuf:"bytes,5,rep,name=event_types,json=eventTypes,proto3" json:"event_types,omitempty"`
	// Optional. Options about what data to include in the event payload. Only
	// supported for Google Chat events.
	PayloadOptions *PayloadOptions `protobuf:"bytes,6,opt,name=payload_options,json=payloadOptions,proto3" json:"payload_options,omitempty"`
	// Required. Immutable. The endpoint where the subscription delivers events,
	// such as a Pub/Sub topic.
	NotificationEndpoint *NotificationEndpoint `protobuf:"bytes,7,opt,name=notification_endpoint,json=notificationEndpoint,proto3" json:"notification_endpoint,omitempty"`
	// Output only. The state of the subscription. Determines whether the
	// subscription can receive events and deliver them to the notification
	// endpoint.
	State Subscription_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.apps.events.subscriptions.v1.Subscription_State" json:"state,omitempty"`
	// Output only. The error that suspended the subscription.
	//
	// To reactivate the subscription, resolve the error and call the
	// [`ReactivateSubscription`][google.apps.events.subscriptions.v1.SubscriptionsService.ReactivateSubscription]
	// method.
	SuspensionReason Subscription_ErrorType `` /* 175-byte string literal not displayed */
	// Output only. The user who authorized the creation of the
	// subscription.
	//
	// Format: `users/{user}`
	//
	// For Google Workspace users, the `{user}` value is the
	// [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids)
	// field from the Directory API.
	Authority string `protobuf:"bytes,10,opt,name=authority,proto3" json:"authority,omitempty"`
	// Output only. The time when the subscription is created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The last time that the subscription is updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. If `true`, the subscription is in the process of being
	// updated.
	Reconciling bool `protobuf:"varint,15,opt,name=reconciling,proto3" json:"reconciling,omitempty"`
	// Optional. This checksum is computed by the server based on the value of
	// other fields, and might be sent on update requests to ensure the client has
	// an up-to-date value before proceeding.
	Etag string `protobuf:"bytes,17,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

type Subscription_ErrorType int32

type Subscription_ExpireTime struct {
	// Non-empty default. The timestamp in UTC when the subscription expires.
	// Always displayed on output, regardless of what was used on input.
	ExpireTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=expire_time,json=expireTime,proto3,oneof"`
}

type Subscription_State int32

type Subscription_Ttl struct {
	// Input only. The time-to-live (TTL) or duration for the subscription. If
	// unspecified or set to `0`, uses the maximum possible duration.
	Ttl *durationpb.Duration `protobuf:"bytes,14,opt,name=ttl,proto3,oneof"`
}

type SubscriptionsServiceClient interface {
	// Creates a Google Workspace subscription. To learn how to use this
	// method, see [Create a Google Workspace
	// subscription](https://developers.google.com/workspace/events/guides/create-subscription).
	CreateSubscription(ctx context.Context, in *CreateSubscriptionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a Google Workspace subscription.
	// To learn how to use this method, see [Delete a Google Workspace
	// subscription](https://developers.google.com/workspace/events/guides/delete-subscription).
	DeleteSubscription(ctx context.Context, in *DeleteSubscriptionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets details about a Google Workspace subscription. To learn how to use
	// this method, see [Get details about a Google Workspace
	// subscription](https://developers.google.com/workspace/events/guides/get-subscription).
	GetSubscription(ctx context.Context, in *GetSubscriptionRequest, opts ...grpc.CallOption) (*Subscription, error)
	// Lists Google Workspace subscriptions. To learn how to use this method, see
	// [List Google Workspace
	// subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions).
	ListSubscriptions(ctx context.Context, in *ListSubscriptionsRequest, opts ...grpc.CallOption) (*ListSubscriptionsResponse, error)
	// Updates or renews a Google Workspace subscription. To learn how to use this
	// method, see [Update or renew a Google Workspace
	// subscription](https://developers.google.com/workspace/events/guides/update-subscription).
	UpdateSubscription(ctx context.Context, in *UpdateSubscriptionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Reactivates a suspended Google Workspace subscription.
	//
	// This method resets your subscription's `State` field to `ACTIVE`. Before
	// you use this method, you must fix the error that suspended the
	// subscription. To learn how to use this method, see [Reactivate a Google
	// Workspace
	// subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription).
	ReactivateSubscription(ctx context.Context, in *ReactivateSubscriptionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

type SubscriptionsServiceServer interface {
	// Creates a Google Workspace subscription. To learn how to use this
	// method, see [Create a Google Workspace
	// subscription](https://developers.google.com/workspace/events/guides/create-subscription).
	CreateSubscription(context.Context, *CreateSubscriptionRequest) (*longrunningpb.Operation, error)
	// Deletes a Google Workspace subscription.
	// To learn how to use this method, see [Delete a Google Workspace
	// subscription](https://developers.google.com/workspace/events/guides/delete-subscription).
	DeleteSubscription(context.Context, *DeleteSubscriptionRequest) (*longrunningpb.Operation, error)
	// Gets details about a Google Workspace subscription. To learn how to use
	// this method, see [Get details about a Google Workspace
	// subscription](https://developers.google.com/workspace/events/guides/get-subscription).
	GetSubscription(context.Context, *GetSubscriptionRequest) (*Subscription, error)
	// Lists Google Workspace subscriptions. To learn how to use this method, see
	// [List Google Workspace
	// subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions).
	ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*ListSubscriptionsResponse, error)
	// Updates or renews a Google Workspace subscription. To learn how to use this
	// method, see [Update or renew a Google Workspace
	// subscription](https://developers.google.com/workspace/events/guides/update-subscription).
	UpdateSubscription(context.Context, *UpdateSubscriptionRequest) (*longrunningpb.Operation, error)
	// Reactivates a suspended Google Workspace subscription.
	//
	// This method resets your subscription's `State` field to `ACTIVE`. Before
	// you use this method, you must fix the error that suspended the
	// subscription. To learn how to use this method, see [Reactivate a Google
	// Workspace
	// subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription).
	ReactivateSubscription(context.Context, *ReactivateSubscriptionRequest) (*longrunningpb.Operation, error)
}

type UnimplementedSubscriptionsServiceServer struct {
}

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

type UpdateSubscriptionRequest struct {

	// Required. The subscription to update.
	//
	// The subscription's `name` field is used to identify the subscription to
	// update.
	Subscription *Subscription `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
	// Optional. Required. The field to update.
	//
	// You can update one of the following fields in a subscription:
	//
	//   - [`expire_time`][google.apps.events.subscriptions.v1.Subscription.expire_time]: The timestamp when the
	//     subscription expires.
	//   - [`ttl`][google.apps.events.subscriptions.v1.Subscription.ttl]: The
	//
	// time-to-live (TTL) or duration of the
	//
	//	subscription.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Optional. If set to `true`, validates and previews the request, but doesn't
	// update the subscription.
	ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}