- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
ack_deadline_secondsType: INT32
Provider name: ackDeadlineSeconds
Description: Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.
analytics_hub_subscription_infoType: STRUCT
Provider name: analyticsHubSubscriptionInfo
Description: Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.
listingSTRINGlistingsubscriptionSTRINGsubscriptionancestorsType: UNORDERED_LIST_STRING
bigquery_configType: STRUCT
Provider name: bigqueryConfig
Description: Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
drop_unknown_fieldsBOOLEANdropUnknownFieldsservice_account_emailSTRINGserviceAccountEmailiam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.stateSTRINGstateSTATE_UNSPECIFIED - Default value. This value is unused.ACTIVE - The subscription can actively send messages to BigQueryPERMISSION_DENIED - Cannot write to the BigQuery table because of permission denied errors. This can happen if - Pub/Sub SA has not been granted the appropriate BigQuery IAM permissions - bigquery.googleapis.com API is not enabled for the project (instructions)NOT_FOUND - Cannot write to the BigQuery table because it does not exist.SCHEMA_MISMATCH - Cannot write to the BigQuery table due to a schema mismatch.IN_TRANSIT_LOCATION_RESTRICTION - Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions.tableSTRINGtableuse_table_schemaBOOLEANuseTableSchemause_table_schema and use_topic_schema cannot be enabled at the same time.use_topic_schemaBOOLEANuseTopicSchemause_topic_schema and use_table_schema cannot be enabled at the same time.write_metadataBOOLEANwriteMetadatacloud_storage_configType: STRUCT
Provider name: cloudStorageConfig
Description: Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
avro_configSTRUCTavroConfiguse_topic_schemaBOOLEANuseTopicSchemawrite_metadataBOOLEANwriteMetadatabucketSTRINGbucketfilename_datetime_formatSTRINGfilenameDatetimeFormatfilename_prefixSTRINGfilenamePrefixfilename_suffixSTRINGfilenameSuffixmax_bytesINT64maxBytesmax_durationSTRINGmaxDurationmax_messagesINT64maxMessagesservice_account_emailSTRINGserviceAccountEmailiam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.stateSTRINGstateSTATE_UNSPECIFIED - Default value. This value is unused.ACTIVE - The subscription can actively send messages to Cloud Storage.PERMISSION_DENIED - Cannot write to the Cloud Storage bucket because of permission denied errors.NOT_FOUND - Cannot write to the Cloud Storage bucket because it does not exist.IN_TRANSIT_LOCATION_RESTRICTION - Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions.SCHEMA_MISMATCH - Cannot write to the Cloud Storage bucket due to an incompatibility between the topic schema and subscription settings.text_configSTRUCTtextConfigdead_letter_policyType: STRUCT
Provider name: deadLetterPolicy
Description: Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions’s parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
dead_letter_topicSTRINGdeadLetterTopicprojects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription’s parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.max_delivery_attemptsINT32maxDeliveryAttemptsdetachedType: BOOLEAN
Provider name: detached
Description: Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don’t receive messages from their topic and don’t retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
enable_exactly_once_deliveryType: BOOLEAN
Provider name: enableExactlyOnceDelivery
Description: Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of message_id on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message’s acknowledgment deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when enable_exactly_once_delivery is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct message_id values.
enable_message_orderingType: BOOLEAN
Provider name: enableMessageOrdering
Description: Optional. If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.
expiration_policyType: STRUCT
Provider name: expirationPolicy
Description: Optional. A policy that specifies the conditions for this subscription’s expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.
ttlSTRINGttlttl. 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.filterType: STRING
Provider name: filter
Description: Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
labelsType: UNORDERED_LIST_STRING
message_retention_durationType: STRING
Provider name: messageRetentionDuration
Description: Optional. How long to retain unacknowledged messages in the subscription’s backlog, from the moment a message is published. If retain_acked_messages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes.
message_transformsType: UNORDERED_LIST_STRUCT
Provider name: messageTransforms
Description: Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
enabledBOOLEANenabledtrue.javascript_udfSTRUCTjavascriptUdffunction_name.codeSTRINGcodefunction_name with the below signature: /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { }function_nameSTRINGfunctionNamenameType: STRING
Provider name: name
Description: 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".
organization_idType: STRING
parentType: STRING
project_idType: STRING
project_numberType: STRING
push_configType: STRUCT
Provider name: pushConfig
Description: Optional. If push delivery is used with this subscription, this field is used to configure it.
no_wrapper
Type: STRUCT
Provider name: noWrapper
Description: Optional. When set, the payload to the push endpoint is not wrapped.
write_metadataBOOLEANwriteMetadatax-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.oidc_token
Type: STRUCT
Provider name: oidcToken
Description: Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
audienceSTRINGaudienceservice_account_emailSTRINGserviceAccountEmailpubsub_wrapper
Type: STRUCT
Provider name: pubsubWrapper
Description: Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
push_endpoint
Type: STRING
Provider name: pushEndpoint
Description: Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
resource_nameType: STRING
retain_acked_messagesType: BOOLEAN
Provider name: retainAckedMessages
Description: Optional. Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription’s backlog, even if they are acknowledged, until they fall out of the message_retention_duration window. This must be true if you would like to [Seek to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
retry_policyType: STRUCT
Provider name: retryPolicy
Description: Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message.
maximum_backoffSTRINGmaximumBackoffminimum_backoffSTRINGminimumBackoffstateType: STRING
Provider name: state
Description: Output only. An output-only field indicating whether or not the subscription can receive messages.
Possible values:
STATE_UNSPECIFIED - Default value. This value is unused.ACTIVE - The subscription can actively receive messagesRESOURCE_ERROR - The subscription cannot receive messages because of an error with the resource to which it pushes messages. See the more detailed error state in the corresponding configuration.tagsType: UNORDERED_LIST_STRING
topicType: STRING
Provider name: topic
Description: 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_message_retention_durationType: STRING
Provider name: topicMessageRetentionDuration
Description: Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription’s topic. If this field is set, messages published to the subscription’s topic in the last topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.
| |