PubSubSnapshot

Property	Value
Google Cloud Service Name	Cloud Pub/Sub
Google Cloud Service Documentation	/pubsub/docs/
Google Cloud REST Resource Name	projects.snapshots
Google Cloud REST Resource Documentation	/pubsub/docs/reference/rest/v1/projects.snapshots
Config Connector Resource Short Names	gcppubsubsnapshot gcppubsubsnapshots pubsubsnapshot
Config Connector Service Name	pubsub.googleapis.com
Config Connector Resource Fully Qualified Name	pubsubsnapshots.pubsub.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	No
Config Connector Default Average Reconcile Interval In Seconds	600

Custom Resource Definition Properties

Spec

Schema

labels:
  string: string
projectRef:
  external: string
  kind: string
  name: string
  namespace: string
pubSubSubscriptionRef:
  external: string
  name: string
  namespace: string
resourceID: string
topicRef:
  external: string
  name: string
  namespace: string

Fields

Fields
`labels` Optional	`map (key: string, value: string)` Optional. For information about creating and managing labels, see https://cloud.google.com/pubsub/docs/labels.
`projectRef` Required	`object` The Project that this resource belongs to.
`projectRef.external` Optional	`string` The `projectID` field of a project, when not managed by Config Connector.
`projectRef.kind` Optional	`string` The kind of the Project resource; optional but must be `Project` if provided.
`projectRef.name` Optional	`string` The `name` field of a `Project` resource.
`projectRef.namespace` Optional	`string` The `namespace` field of a `Project` resource.
`pubSubSubscriptionRef` Required	`object` 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 snapshots.create request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the snapshots.create request. Format is projects/{project}/subscriptions/{sub}.
`pubSubSubscriptionRef.external` Optional	`string` A reference to an externally managed PubSubSubscription resource. Should be in the format "projects/{{projectID}}/subscriptions/{{subscriptionID}}".
`pubSubSubscriptionRef.name` Optional	`string` The name of a PubSubSubscription resource.
`pubSubSubscriptionRef.namespace` Optional	`string` The namespace of a PubSubSubscription resource.
`resourceID` Optional	`string` The PubSubSnapshot name. If not given, the metadata.name will be used.
`topicRef` Optional	`object` Optional. The name of the topic from which this snapshot is retaining messages.
`topicRef.external` Optional	`string` A reference to an externally managed PubSubTopic resource. Should be in the format "projects/{{projectID}}/topics/{{topicID}}".
`topicRef.name` Optional	`string` The name of a PubSubTopic resource.
`topicRef.namespace` Optional	`string` The namespace of a PubSubTopic resource.

labels

Optional

map (key: string, value: string)

Optional. For information about creating and managing labels, see https://cloud.google.com/pubsub/docs/labels.

projectRef

Required

object

The Project that this resource belongs to.

projectRef.external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

projectRef.kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

projectRef.name

Optional

string

The `name` field of a `Project` resource.

projectRef.namespace

Optional

string

The `namespace` field of a `Project` resource.

pubSubSubscriptionRef

Required

object

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 snapshots.create request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the snapshots.create request. Format is projects/{project}/subscriptions/{sub}.

pubSubSubscriptionRef.external

Optional

string

A reference to an externally managed PubSubSubscription resource. Should be in the format "projects/{{projectID}}/subscriptions/{{subscriptionID}}".

pubSubSubscriptionRef.name

Optional

string

The name of a PubSubSubscription resource.

pubSubSubscriptionRef.namespace

Optional

string

The namespace of a PubSubSubscription resource.

resourceID

Optional

string

The PubSubSnapshot name. If not given, the metadata.name will be used.

topicRef

Optional

object

Optional. The name of the topic from which this snapshot is retaining messages.

topicRef.external

Optional

string

A reference to an externally managed PubSubTopic resource. Should be in the format "projects/{{projectID}}/topics/{{topicID}}".

topicRef.name

Optional

string

The name of a PubSubTopic resource.

topicRef.namespace

Optional

string

The namespace of a PubSubTopic resource.

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
externalRef: string
observedGeneration: integer
observedState:
  expireTime: string

Fields
`conditions`	`list (object)` Conditions represent the latest available observations of the object's current state.
`conditions[]`	`object`
`conditions[].lastTransitionTime`	`string` Last time the condition transitioned from one status to another.
`conditions[].message`	`string` Human-readable message indicating details about last transition.
`conditions[].reason`	`string` Unique, one-word, CamelCase reason for the condition's last transition.
`conditions[].status`	`string` Status is the status of the condition. Can be True, False, Unknown.
`conditions[].type`	`string` Type is the type of the condition.
`externalRef`	`string` A unique specifier for the PubSubSnapshot resource in Google Cloud.
`observedGeneration`	`integer` 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.
`observedState`	`object` ObservedState is the state of the resource as most recently observed in Google Cloud.
`observedState.expireTime`	`string` Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.