v1beta1

package
v1.125.0 Latest Latest
Warning

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

 Go to latest Published: Nov 12, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1beta1 contains API Schema definitions for the pubsub v1beta1 API group. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/pkg/apis/pubsub +k8s:defaulter-gen=TypeMeta +groupName=pubsub.cnrm.cloud.google.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "pubsub.cnrm.cloud.google.com", Version: "v1beta1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme

	PubSubSchemaGVK = schema.GroupVersionKind{
		Group:   SchemeGroupVersion.Group,
		Version: SchemeGroupVersion.Version,
		Kind:    reflect.TypeOf(PubSubSchema{}).Name(),
	}

	PubSubSubscriptionGVK = schema.GroupVersionKind{
		Group:   SchemeGroupVersion.Group,
		Version: SchemeGroupVersion.Version,
		Kind:    reflect.TypeOf(PubSubSubscription{}).Name(),
	}

	PubSubTopicGVK = schema.GroupVersionKind{
		Group:   SchemeGroupVersion.Group,
		Version: SchemeGroupVersion.Version,
		Kind:    reflect.TypeOf(PubSubTopic{}).Name(),
	}
)

Functions

This section is empty.

Types

type PubSubSchema added in v1.89.0 

type PubSubSchema struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PubSubSchemaSpec   `json:"spec,omitempty"`
	Status PubSubSchemaStatus `json:"status,omitempty"`
}

PubSubSchema is the Schema for the pubsub API +k8s:openapi-gen=true

func (*PubSubSchema) DeepCopy added in v1.89.0 

func (in *PubSubSchema) DeepCopy() *PubSubSchema

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubSchema.

func (*PubSubSchema) DeepCopyInto added in v1.89.0 

func (in *PubSubSchema) DeepCopyInto(out *PubSubSchema)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PubSubSchema) DeepCopyObject added in v1.89.0 

func (in *PubSubSchema) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PubSubSchemaList added in v1.89.0 

type PubSubSchemaList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PubSubSchema `json:"items"`
}

PubSubSchemaList contains a list of PubSubSchema

func (*PubSubSchemaList) DeepCopy added in v1.89.0 

func (in *PubSubSchemaList) DeepCopy() *PubSubSchemaList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubSchemaList.

func (*PubSubSchemaList) DeepCopyInto added in v1.89.0 

func (in *PubSubSchemaList) DeepCopyInto(out *PubSubSchemaList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PubSubSchemaList) DeepCopyObject added in v1.89.0 

func (in *PubSubSchemaList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PubSubSchemaSpec added in v1.89.0 

type PubSubSchemaSpec struct {
	/* 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. */
	// +optional
	Definition *string `json:"definition,omitempty"`

	/* The project that this resource belongs to. */
	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`

	/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* The type of the schema definition Default value: "TYPE_UNSPECIFIED" Possible values: ["TYPE_UNSPECIFIED", "PROTOCOL_BUFFER", "AVRO"]. */
	// +optional
	Type *string `json:"type,omitempty"`
}

func (*PubSubSchemaSpec) DeepCopy added in v1.89.0 

func (in *PubSubSchemaSpec) DeepCopy() *PubSubSchemaSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubSchemaSpec.

func (*PubSubSchemaSpec) DeepCopyInto added in v1.89.0 

func (in *PubSubSchemaSpec) DeepCopyInto(out *PubSubSchemaSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PubSubSchemaStatus added in v1.89.0 

type PubSubSchemaStatus struct {
	/* Conditions represent the latest available observations of the
	   PubSubSchema's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	// +optional
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
}

func (*PubSubSchemaStatus) DeepCopy added in v1.89.0 

func (in *PubSubSchemaStatus) DeepCopy() *PubSubSchemaStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubSchemaStatus.

func (*PubSubSchemaStatus) DeepCopyInto added in v1.89.0 

func (in *PubSubSchemaStatus) DeepCopyInto(out *PubSubSchemaStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PubSubSubscription 

type PubSubSubscription struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PubSubSubscriptionSpec   `json:"spec,omitempty"`
	Status PubSubSubscriptionStatus `json:"status,omitempty"`
}

PubSubSubscription is the Schema for the pubsub API +k8s:openapi-gen=true

func (*PubSubSubscription) DeepCopy 

func (in *PubSubSubscription) DeepCopy() *PubSubSubscription

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubSubscription.

func (*PubSubSubscription) DeepCopyInto 

func (in *PubSubSubscription) DeepCopyInto(out *PubSubSubscription)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PubSubSubscription) DeepCopyObject 

func (in *PubSubSubscription) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PubSubSubscriptionList 

type PubSubSubscriptionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PubSubSubscription `json:"items"`
}

PubSubSubscriptionList contains a list of PubSubSubscription

func (*PubSubSubscriptionList) DeepCopy 

func (in *PubSubSubscriptionList) DeepCopy() *PubSubSubscriptionList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubSubscriptionList.

func (*PubSubSubscriptionList) DeepCopyInto 

func (in *PubSubSubscriptionList) DeepCopyInto(out *PubSubSubscriptionList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PubSubSubscriptionList) DeepCopyObject 

func (in *PubSubSubscriptionList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PubSubSubscriptionSpec 

type PubSubSubscriptionSpec struct {
	/* This value is the maximum time after a subscriber receives a message
	before the subscriber should acknowledge the message. After message
	delivery but before the ack deadline expires and before the message is
	acknowledged, it is an outstanding message and will not be delivered
	again during that time (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
	subscriptions.modifyAckDeadline with the corresponding ackId if using
	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. */
	// +optional
	AckDeadlineSeconds *int64 `json:"ackDeadlineSeconds,omitempty"`

	/* If delivery to BigQuery is used with this subscription, this field is used to configure it.
	Either pushConfig, bigQueryConfig or cloudStorageConfig can be set, but not combined.
	If all three are empty, then the subscriber will pull and ack messages using API methods. */
	// +optional
	BigqueryConfig *SubscriptionBigqueryConfig `json:"bigqueryConfig,omitempty"`

	/* If delivery to Cloud Storage is used with this subscription, this field is used to configure it.
	Either pushConfig, bigQueryConfig or cloudStorageConfig can be set, but not combined.
	If all three are empty, then the subscriber will pull and ack messages using API methods. */
	// +optional
	CloudStorageConfig *SubscriptionCloudStorageConfig `json:"cloudStorageConfig,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 subscription's
	parent project (i.e.,
	service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
	permission to Acknowledge() messages on this subscription. */
	// +optional
	DeadLetterPolicy *SubscriptionDeadLetterPolicy `json:"deadLetterPolicy,omitempty"`

	/* If 'true', Pub/Sub provides the following guarantees for the delivery
	of a message with a given value of messageId on this Subscriptions':

	- The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.

	- An acknowledged message will not be resent to a subscriber.

	Note that subscribers may still receive multiple copies of a message when 'enable_exactly_once_delivery'
	is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct messageId values. */
	// +optional
	EnableExactlyOnceDelivery *bool `json:"enableExactlyOnceDelivery,omitempty"`

	/* Immutable. If 'true', messages published with the same orderingKey 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. */
	// +optional
	EnableMessageOrdering *bool `json:"enableMessageOrdering,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 expirationPolicy is not set, a default
	policy with ttl of 31 days will be used.  If it is set but ttl is "", the
	resource never expires.  The minimum allowed value for expirationPolicy.ttl
	is 1 day. */
	// +optional
	ExpirationPolicy *SubscriptionExpirationPolicy `json:"expirationPolicy,omitempty"`

	/* Immutable. The subscription only delivers the messages that match the filter.
	Pub/Sub automatically acknowledges the messages that don't match the filter. You can filter messages
	by their attributes. The maximum length of a filter is 256 bytes. After creating the subscription,
	you can't modify the filter. */
	// +optional
	Filter *string `json:"filter,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
	subscriptions.seek can be done. Defaults to 7 days. Cannot be more
	than 7 days ('"604800s"') or less than 10 minutes ('"600s"').

	A duration in seconds with up to nine fractional digits, terminated
	by 's'. Example: '"600.5s"'. */
	// +optional
	MessageRetentionDuration *string `json:"messageRetentionDuration,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. */
	// +optional
	PushConfig *SubscriptionPushConfig `json:"pushConfig,omitempty"`

	/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
	// +optional
	ResourceID *string `json:"resourceID,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
	messageRetentionDuration window. */
	// +optional
	RetainAckedMessages *bool `json:"retainAckedMessages,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. */
	// +optional
	RetryPolicy *SubscriptionRetryPolicy `json:"retryPolicy,omitempty"`

	/* Reference to a PubSubTopic. */
	TopicRef v1alpha1.ResourceRef `json:"topicRef"`
}

func (*PubSubSubscriptionSpec) DeepCopy 

func (in *PubSubSubscriptionSpec) DeepCopy() *PubSubSubscriptionSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubSubscriptionSpec.

func (*PubSubSubscriptionSpec) DeepCopyInto 

func (in *PubSubSubscriptionSpec) DeepCopyInto(out *PubSubSubscriptionSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PubSubSubscriptionStatus 

type PubSubSubscriptionStatus struct {
	/* Conditions represent the latest available observations of the
	   PubSubSubscription's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	// +optional
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
}

func (*PubSubSubscriptionStatus) DeepCopy 

func (in *PubSubSubscriptionStatus) DeepCopy() *PubSubSubscriptionStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubSubscriptionStatus.

func (*PubSubSubscriptionStatus) DeepCopyInto 

func (in *PubSubSubscriptionStatus) DeepCopyInto(out *PubSubSubscriptionStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PubSubTopic 

type PubSubTopic struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PubSubTopicSpec   `json:"spec,omitempty"`
	Status PubSubTopicStatus `json:"status,omitempty"`
}

PubSubTopic is the Schema for the pubsub API +k8s:openapi-gen=true

func (*PubSubTopic) DeepCopy 

func (in *PubSubTopic) DeepCopy() *PubSubTopic

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubTopic.

func (*PubSubTopic) DeepCopyInto 

func (in *PubSubTopic) DeepCopyInto(out *PubSubTopic)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PubSubTopic) DeepCopyObject 

func (in *PubSubTopic) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PubSubTopicList 

type PubSubTopicList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PubSubTopic `json:"items"`
}

PubSubTopicList contains a list of PubSubTopic

func (*PubSubTopicList) DeepCopy 

func (in *PubSubTopicList) DeepCopy() *PubSubTopicList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubTopicList.

func (*PubSubTopicList) DeepCopyInto 

func (in *PubSubTopicList) DeepCopyInto(out *PubSubTopicList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PubSubTopicList) DeepCopyObject 

func (in *PubSubTopicList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PubSubTopicSpec 

type PubSubTopicSpec struct {
	/* The KMSCryptoKey to be used to protect access to messages published
	on this topic. Your project's Pub/Sub service account
	('service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com')
	must have 'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this
	feature. */
	// +optional
	KmsKeyRef *v1alpha1.ResourceRef `json:"kmsKeyRef,omitempty"`

	/* Indicates the minimum duration to retain a message after it is published
	to the topic. If this field is set, messages published to the topic in
	the last messageRetentionDuration are always available to subscribers.
	For instance, it allows any attached subscription to seek to a timestamp
	that is up to messageRetentionDuration in the past. If this field is not
	set, message retention is controlled by settings on individual subscriptions.
	Cannot be more than 31 days or less than 10 minutes. */
	// +optional
	MessageRetentionDuration *string `json:"messageRetentionDuration,omitempty"`

	/* 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. */
	// +optional
	MessageStoragePolicy *TopicMessageStoragePolicy `json:"messageStoragePolicy,omitempty"`

	/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* Settings for validating messages published against a schema. */
	// +optional
	SchemaSettings *TopicSchemaSettings `json:"schemaSettings,omitempty"`
}

func (*PubSubTopicSpec) DeepCopy 

func (in *PubSubTopicSpec) DeepCopy() *PubSubTopicSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubTopicSpec.

func (*PubSubTopicSpec) DeepCopyInto 

func (in *PubSubTopicSpec) DeepCopyInto(out *PubSubTopicSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PubSubTopicStatus 

type PubSubTopicStatus struct {
	/* Conditions represent the latest available observations of the
	   PubSubTopic's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	// +optional
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
}

func (*PubSubTopicStatus) DeepCopy 

func (in *PubSubTopicStatus) DeepCopy() *PubSubTopicStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubSubTopicStatus.

func (*PubSubTopicStatus) DeepCopyInto 

func (in *PubSubTopicStatus) DeepCopyInto(out *PubSubTopicStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SubscriptionAvroConfig added in v1.109.0 

type SubscriptionAvroConfig struct {
	/* When true, write the subscription name, messageId, publishTime, attributes, and orderingKey as additional fields in the output. */
	// +optional
	WriteMetadata *bool `json:"writeMetadata,omitempty"`
}

func (*SubscriptionAvroConfig) DeepCopy added in v1.109.0 

func (in *SubscriptionAvroConfig) DeepCopy() *SubscriptionAvroConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionAvroConfig.

func (*SubscriptionAvroConfig) DeepCopyInto added in v1.109.0 

func (in *SubscriptionAvroConfig) DeepCopyInto(out *SubscriptionAvroConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SubscriptionBigqueryConfig added in v1.93.0 

type SubscriptionBigqueryConfig struct {
	/* When true and useTopicSchema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery.
	Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. */
	// +optional
	DropUnknownFields *bool `json:"dropUnknownFields,omitempty"`

	/* The name of the table to which to write data. */
	TableRef v1alpha1.ResourceRef `json:"tableRef"`

	/* When true, use the topic's schema as the columns to write to in BigQuery, if it exists. */
	// +optional
	UseTopicSchema *bool `json:"useTopicSchema,omitempty"`

	/* When true, write the subscription name, messageId, publishTime, attributes, and orderingKey to additional columns in the table.
	The subscription name, messageId, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. */
	// +optional
	WriteMetadata *bool `json:"writeMetadata,omitempty"`
}

func (*SubscriptionBigqueryConfig) DeepCopy added in v1.93.0 

func (in *SubscriptionBigqueryConfig) DeepCopy() *SubscriptionBigqueryConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionBigqueryConfig.

func (*SubscriptionBigqueryConfig) DeepCopyInto added in v1.93.0 

func (in *SubscriptionBigqueryConfig) DeepCopyInto(out *SubscriptionBigqueryConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SubscriptionCloudStorageConfig added in v1.109.0 

type SubscriptionCloudStorageConfig struct {
	/* If set, message data will be written to Cloud Storage in Avro format. */
	// +optional
	AvroConfig *SubscriptionAvroConfig `json:"avroConfig,omitempty"`

	/* User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". */
	BucketRef v1alpha1.ResourceRef `json:"bucketRef"`

	/* User-provided prefix for Cloud Storage filename. */
	// +optional
	FilenamePrefix *string `json:"filenamePrefix,omitempty"`

	/* User-provided suffix for Cloud Storage filename. Must not end in "/". */
	// +optional
	FilenameSuffix *string `json:"filenameSuffix,omitempty"`

	/* The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB.
	The maxBytes limit may be exceeded in cases where messages are larger than the limit. */
	// +optional
	MaxBytes *int64 `json:"maxBytes,omitempty"`

	/* The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes.
	May not exceed the subscription's acknowledgement deadline.
	A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". */
	// +optional
	MaxDuration *string `json:"maxDuration,omitempty"`

	/* An output-only field that indicates whether or not the subscription can receive messages. */
	// +optional
	State *string `json:"state,omitempty"`
}

func (*SubscriptionCloudStorageConfig) DeepCopy added in v1.109.0 

func (in *SubscriptionCloudStorageConfig) DeepCopy() *SubscriptionCloudStorageConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionCloudStorageConfig.

func (*SubscriptionCloudStorageConfig) DeepCopyInto added in v1.109.0 

func (in *SubscriptionCloudStorageConfig) DeepCopyInto(out *SubscriptionCloudStorageConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SubscriptionDeadLetterPolicy 

type SubscriptionDeadLetterPolicy struct {
	// +optional
	DeadLetterTopicRef *v1alpha1.ResourceRef `json:"deadLetterTopicRef,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. */
	// +optional
	MaxDeliveryAttempts *int64 `json:"maxDeliveryAttempts,omitempty"`
}

func (*SubscriptionDeadLetterPolicy) DeepCopy 

func (in *SubscriptionDeadLetterPolicy) DeepCopy() *SubscriptionDeadLetterPolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionDeadLetterPolicy.

func (*SubscriptionDeadLetterPolicy) DeepCopyInto 

func (in *SubscriptionDeadLetterPolicy) DeepCopyInto(out *SubscriptionDeadLetterPolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SubscriptionExpirationPolicy 

type SubscriptionExpirationPolicy struct {
	/* Specifies the "time-to-live" duration for an associated resource. The
	resource expires if it is not active for a period of ttl.
	If ttl is set to "", the associated resource never expires.
	A duration in seconds with up to nine fractional digits, terminated by 's'.
	Example - "3.5s". */
	Ttl string `json:"ttl"`
}

func (*SubscriptionExpirationPolicy) DeepCopy 

func (in *SubscriptionExpirationPolicy) DeepCopy() *SubscriptionExpirationPolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionExpirationPolicy.

func (*SubscriptionExpirationPolicy) DeepCopyInto 

func (in *SubscriptionExpirationPolicy) DeepCopyInto(out *SubscriptionExpirationPolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SubscriptionNoWrapper added in v1.109.0 

type SubscriptionNoWrapper struct {
	/* When true, writes the Pub/Sub message metadata to
	'x-goog-pubsub-<KEY>:<VAL>' headers of the HTTP request. Writes the
	Pub/Sub message attributes to '<KEY>:<VAL>' headers of the HTTP request. */
	WriteMetadata bool `json:"writeMetadata"`
}

func (*SubscriptionNoWrapper) DeepCopy added in v1.109.0 

func (in *SubscriptionNoWrapper) DeepCopy() *SubscriptionNoWrapper

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionNoWrapper.

func (*SubscriptionNoWrapper) DeepCopyInto added in v1.109.0 

func (in *SubscriptionNoWrapper) DeepCopyInto(out *SubscriptionNoWrapper)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SubscriptionOidcToken 

type SubscriptionOidcToken struct {
	/* 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. */
	// +optional
	Audience *string `json:"audience,omitempty"`

	/* Service account email to be used for generating the OIDC token.
	The caller (for subscriptions.create, subscriptions.patch, and
	subscriptions.modifyPushConfig RPCs) must have the
	iam.serviceAccounts.actAs permission for the service account. */
	ServiceAccountEmail string `json:"serviceAccountEmail"`
}

func (*SubscriptionOidcToken) DeepCopy 

func (in *SubscriptionOidcToken) DeepCopy() *SubscriptionOidcToken

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionOidcToken.

func (*SubscriptionOidcToken) DeepCopyInto 

func (in *SubscriptionOidcToken) DeepCopyInto(out *SubscriptionOidcToken)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SubscriptionPushConfig 

type SubscriptionPushConfig struct {
	/* Endpoint configuration attributes.

	Every endpoint has a set of API supported attributes that can
	be used to control different aspects of the message delivery.

	The 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). The endpoint version is
	based on the version of the Pub/Sub API.

	If not present during the subscriptions.create call,
	it will default to the version of the API used to make
	such call. If not present during a subscriptions.modifyPushConfig
	call, its value will not be changed. subscriptions.get
	calls will always return a valid version, even if the
	subscription was created without this attribute.

	The possible values for this 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. */
	// +optional
	Attributes map[string]string `json:"attributes,omitempty"`

	/* When set, the payload to the push endpoint is not wrapped.Sets the
	'data' field as the HTTP body for delivery. */
	// +optional
	NoWrapper *SubscriptionNoWrapper `json:"noWrapper,omitempty"`

	/* If specified, Pub/Sub will generate and attach an OIDC JWT token as
	an Authorization header in the HTTP request for every pushed message. */
	// +optional
	OidcToken *SubscriptionOidcToken `json:"oidcToken,omitempty"`

	/* A URL locating the endpoint to which messages should be pushed.
	For example, a Webhook endpoint might use
	"https://example.com/push". */
	PushEndpoint string `json:"pushEndpoint"`
}

func (*SubscriptionPushConfig) DeepCopy 

func (in *SubscriptionPushConfig) DeepCopy() *SubscriptionPushConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionPushConfig.

func (*SubscriptionPushConfig) DeepCopyInto 

func (in *SubscriptionPushConfig) DeepCopyInto(out *SubscriptionPushConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SubscriptionRetryPolicy 

type SubscriptionRetryPolicy struct {
	/* The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
	A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". */
	// +optional
	MaximumBackoff *string `json:"maximumBackoff,omitempty"`

	/* The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
	A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". */
	// +optional
	MinimumBackoff *string `json:"minimumBackoff,omitempty"`
}

func (*SubscriptionRetryPolicy) DeepCopy 

func (in *SubscriptionRetryPolicy) DeepCopy() *SubscriptionRetryPolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubscriptionRetryPolicy.

func (*SubscriptionRetryPolicy) DeepCopyInto 

func (in *SubscriptionRetryPolicy) DeepCopyInto(out *SubscriptionRetryPolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TopicMessageStoragePolicy 

type TopicMessageStoragePolicy 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 `json:"allowedPersistenceRegions"`
}

func (*TopicMessageStoragePolicy) DeepCopy 

func (in *TopicMessageStoragePolicy) DeepCopy() *TopicMessageStoragePolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TopicMessageStoragePolicy.

func (*TopicMessageStoragePolicy) DeepCopyInto 

func (in *TopicMessageStoragePolicy) DeepCopyInto(out *TopicMessageStoragePolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TopicSchemaSettings added in v1.90.0 

type TopicSchemaSettings struct {
	/* The encoding of messages validated against schema. Default value: "ENCODING_UNSPECIFIED" Possible values: ["ENCODING_UNSPECIFIED", "JSON", "BINARY"]. */
	// +optional
	Encoding *string `json:"encoding,omitempty"`

	SchemaRef v1alpha1.ResourceRef `json:"schemaRef"`
}

func (*TopicSchemaSettings) DeepCopy added in v1.90.0 

func (in *TopicSchemaSettings) DeepCopy() *TopicSchemaSettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TopicSchemaSettings.

func (*TopicSchemaSettings) DeepCopyInto added in v1.90.0 

func (in *TopicSchemaSettings) DeepCopyInto(out *TopicSchemaSettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.