SrSSKJr SSKJr SSKJr SSKJr SSK J r Sr Sr S r S rS rS rS rS rS rS rS r/r"S S \ R.5rSSjrSSjr"SS\5r"SS\5rg)z.Utilities for Cloud Pub/Sub Subscriptions API.) list_pager)utils)apis)iam_util) exceptions20zX-Server-Timeoutdefaultneverclearc\rSrSrSrSrg)NoFieldsSpecifiedError'z:Error when no fields were specified for a Patch operation.N)__name__ __module__ __qualname____firstlineno____doc____static_attributes__r2lib/googlecloudsdk/api_lib/pubsub/subscriptions.pyr r 'sBrr c.[R"SSUS9$)Npubsubv1no_http)rGetClientInstancers rrr+s  $ @@rNc@U=(d [5nUR$N)rMESSAGES_MODULE)clients rGetMessagesModuler"/s  (&(&   rc\rSrSrSrSrSrg)_SubscriptionUpdateSetting4z1Data container class for updating a subscription.cXlX lgr field_namevalue)selfr(r)s r__init__#_SubscriptionUpdateSetting.__init__7s  OJrr'N)rrrrrr+rrrrr$r$4s 9rr$c\rSrSrSrS#SjrSrSrS$SjrSr S%S jr S r S r S&S jr S#S jrSrSrSrSrSrSrSrSrSrSrSrSrSrSrSrS'SjrSrSr S r!S!r"S"r#g)(SubscriptionsClient<z:Client for subscriptions service in the Cloud Pub/Sub API.NcU=(d [5UlU=(d [U5UlURRUlgr)rr!r"messagesprojects_subscriptions_service)r*r!r1s rr+SubscriptionsClient.__init__?s5/-/DK9 1& 9DMKK66DMrcURRURRUS9UR5S9nURR U5$)zAcknowledges one or messages for a Subscription. Args: ack_ids (list[str]): List of ack ids for the messages being ack'd. subscription_ref (Resource): Relative name of the subscription for which to ack messages for. Returns: None: )ackIds)acknowledgeRequest subscription)r1-PubsubProjectsSubscriptionsAcknowledgeRequestAcknowledgeRequest RelativeNamer3 Acknowledge)r*ack_idssubscription_refack_reqs rAckSubscriptionsClient.AckDsVmmII==;;7;K%224JG == $ $W --rcURRUR5S9nURR U5$)zGets a Subscription from the API. Args: subscription_ref (Resource): Relative name of the subscription to get. Returns: Subscription: the subscription. r8)r1%PubsubProjectsSubscriptionsGetRequestr;r3Get)r*r>get_reqs rrESubscriptionsClient.GetVsAmmAA%224BG ==  W %%rc*URRUR5UR5UUUUUURX5U U UR X5UR X5UUR UUUUUU5URUUUUUUUUUU U!5 URU"U#5URU$U%U&5S9n*U'(a2[R"URRU'U)5U*l U((aU(U*lUR(R+U*5$![R[R[R 4a"n+[R""U+54U+leSn+A+ff=f)aCreates a Subscription. Args: subscription_ref (Resource): Resource reference for subscription to be created. topic_ref (Resource): Resource reference for the associated topic for the subscriptions. ack_deadline (int): Number of seconds the system will wait for a subscriber to ack a message. push_config (Message): Message containing the push endpoint for the subscription. retain_acked_messages (bool): Whether or not to retain acked messages. message_retention_duration (int): How long to retained unacked messages. labels (Subscriptions.LabelsValue): The labels for the request. no_expiration (bool): Whether or not to set no expiration on subscription. expiration_period (str): TTL on expiration_policy. enable_message_ordering (bool): Whether or not to deliver messages with the same ordering key in order. filter_string (str): filter string in the Cloud Pub/Sub filter language. dead_letter_topic (str): Topic for publishing dead messages. max_delivery_attempts (int): Threshold of failed deliveries before sending message to the dead letter topic. min_retry_delay (str): The minimum delay between consecutive deliveries of a given message. max_retry_delay (str): The maximum delay between consecutive deliveries of a given message. enable_exactly_once_delivery (bool): Whether or not to set exactly once delivery on the subscription. bigquery_table (str): BigQuery table to which to write use_topic_schema (bool): Whether or not to use the topic schema when writing to BigQuery use_table_schema (bool): Whether or not to use the table schema when writing to BigQuery write_metadata (bool): Whether or not to write metadata fields when writing to BigQuery drop_unknown_fields (bool): Whether or not to drop fields that are only in the topic schema when writing to BigQuery bigquery_service_account_email (str): The service account to use when writing to BigQuery cloud_storage_bucket (str): The name for the Cloud Storage bucket. cloud_storage_file_prefix (str): The prefix for Cloud Storage filename. cloud_storage_file_suffix (str): The suffix for Cloud Storage filename. cloud_storage_file_datetime_format (str): The custom datetime format string for Cloud Storage filename. cloud_storage_max_bytes (int): The maximum bytes that can be written to a Cloud Storage file before a new file is created. cloud_storage_max_duration (str): The maximum duration that can elapse before a new Cloud Storage file is created. cloud_storage_max_messages (int): The maximum number of messages that can be written to a Cloud Storage file before a new file is created. cloud_storage_output_format (str): The output format for data written to Cloud Storage. cloud_storage_use_topic_schema (bool): Whether or not to use the topic schema when writing to Cloud Storage. cloud_storage_write_metadata (bool): Whether or not to write the subscription name and other metadata in the output. cloud_storage_service_account_email (str): The service account to use when writing to Cloud Storage pubsub_export_topic (str): The Pubsub topic to which to publish messages. pubsub_export_topic_region (str): The Cloud region to which to publish messages. bigtable_table (str): Bigtable table to which to write. bigtable_app_profile_id (str): The app profile to use when writing to Bigtable. bigtable_service_account_email (str): The service account to use when writing to Bigtable. message_transforms_file (str): The file path to the JSON or YAML file containing the message transforms. tags (TagsValue): The tags Keys/Values to be bound to the subscription. enable_vertex_ai_smt (bool): Whether or not to enable Vertex AI message transforms. Returns: Subscription: the created subscription )nametopicackDeadlineSeconds pushConfigretainAckedMessageslabelsmessageRetentionDurationexpirationPolicyenableMessageOrderingfilterdeadLetterPolicy retryPolicyenableExactlyOnceDeliverybigqueryConfigcloudStorageConfigpubsubExportConfigbigtableConfigN)r1 Subscriptionr;_ExpirationPolicy_DeadLetterPolicy _RetryPolicy_BigQueryConfig_CloudStorageConfig_PubsubExportConfig_BigtableConfigrGetMessageTransformsFromFileMessageTransformmessageTransforms#MessageTransformsInvalidFormatErrorMessageTransformsEmptyFileError!MessageTransformsMissingFileErrorGetErrorMessageargstagsr3Create),r*r> topic_ref ack_deadline push_configretain_acked_messagesmessage_retention_durationrN no_expirationexpiration_periodenable_message_ordering filter_stringdead_letter_topicmax_delivery_attemptsmin_retry_delaymax_retry_delayenable_exactly_once_deliverybigquery_tableuse_topic_schemause_table_schemawrite_metadatadrop_unknown_fieldsbigquery_service_account_emailcloud_storage_bucketcloud_storage_file_prefixcloud_storage_file_suffix"cloud_storage_file_datetime_formatcloud_storage_max_bytescloud_storage_max_durationcloud_storage_max_messagescloud_storage_output_formatcloud_storage_use_topic_schemacloud_storage_write_metadata#cloud_storage_service_account_emailpubsub_export_topicpubsub_export_topic_regionbigtable_tablebigtable_app_profile_idbigtable_service_account_emailmessage_transforms_filerjenable_vertex_ai_smtr8es, rrkSubscriptionsClient.Createesn==--  * * ,$$&'1!;//  6//  %%oG">++      *   33 % % . # & & ' * ( /   33 !; ++  # * U./L` ).)K)K MM * * # * & l ==   --  3 3  / /  1 1 ''*, s 1D##3E8E33E8cURRUR5S9nURR U5$)zDeletes a Subscription. Args: subscription_ref (Resource): Resource reference for subscription to be deleted. Returns: None: rC)r1(PubsubProjectsSubscriptionsDeleteRequestr;r3Delete)r*r> delete_reqs rrSubscriptionsClient.Delete sAGG%224HJ ==   ++rcURRUR5US9n[R"UR UUSSS9$)a2Lists Subscriptions for a given project. Args: project_ref (Resource): Resource reference to Project to list subscriptions from. page_size (int): the number of entries in each batch (affects requests made, but not the yielded results). Returns: A generator of subscriptions in the project. )projectpageSize subscriptionsr) batch_sizefieldbatch_size_attribute)r1&PubsubProjectsSubscriptionsListRequestr;r YieldFromListr3)r* project_ref page_sizelist_reqs rListSubscriptionsClient.List/sT}}CC((*YDH  # # '  rcURRURRX2S9UR5S9nURR U5$)aModifies the ack deadline for messages for a Subscription. Args: subscription_ref (Resource): Resource reference for subscription to be modified. ack_ids (list[str]): List of ack ids to modify. ack_deadline (int): The new ack deadline for the messages. Returns: None: )rKr6)modifyAckDeadlineRequestr8)r13PubsubProjectsSubscriptionsModifyAckDeadlineRequestModifyAckDeadlineRequestr;r3ModifyAckDeadline)r*r>r=rmmod_reqs rr%SubscriptionsClient.ModifyAckDeadlineFs^mmOO!%!G!G+"H" &224 PG == * *7 33rcURRURRUS9UR5S9nURR U5$)zModifies the push endpoint for a Subscription. Args: subscription_ref (Resource): Resource reference for subscription to be modified. push_config (Message): The new push endpoint for the Subscription. Returns: None: )rL)modifyPushConfigRequestr8)r12PubsubProjectsSubscriptionsModifyPushConfigRequestModifyPushConfigRequestr;r3ModifyPushConfig)r*r>rnrs rr$SubscriptionsClient.ModifyPushConfig[s^mmNN $ E E"!F! &224 OG == ) )' 22rc2URRURRX#S9UR5S9n[UR R ['URRU5nUR R [ U$)aPulls one or more messages from a Subscription. Args: subscription_ref (Resource): Resource reference for subscription to be pulled from. max_messages (int): The maximum number of messages to retrieve. return_immediately (bool): Whether or not to return immediately without waiting for a new message for a bounded amount of time if there is nothing to pull right now. Returns: PullResponse: proto containing the received messages. ) maxMessagesreturnImmediately) pullRequestr8) r1&PubsubProjectsSubscriptionsPullRequest PullRequestr;PULL_RPC_DEADLINE_SECONDSr!additional_http_headersSERVER_TIMEOUT_HEADERr3Pull)r*r> max_messagesreturn_immediatelypull_req pull_resps rrSubscriptionsClient.Pullns}}CCMM--$. &224 DH " KK''(=> ""8,I ++,AB rcU=(a UR5nURRURRXBS9UR5S9nURR U5$)aReset a Subscription's backlog to point to a given time or snapshot. Args: subscription_ref (Resource): Resource reference for subscription to be seeked on. time (str): The time to reset to. snapshot_ref (Resource): Resource reference to a snapshot.. Returns: None: )snapshottime) seekRequestr8)r;r1&PubsubProjectsSubscriptionsSeekRequest SeekRequestr3Seek)r*r>r snapshot_refrseek_reqs rrSubscriptionsClient.Seeksi; 9 9 ;H}}CCMM--x-K%224DH ==  h ''rcU(aURRSS9$U(aURRUS9$g)zBuild ExpirationPolicy message from argument values. Args: no_expiration (bool): Whether or not to set no expiration on subscription. expiration_period (str): TTL on expiration_policy. Returns: ExpirationPolicy message or None. N)ttl)r1ExpirationPolicy)r*rqrrs rr[%SubscriptionsClient._ExpirationPolicys> ]] + + + 55 ]] + +0A + BB rcFU(aURRUUS9$g)aBuilds DeadLetterPolicy message from argument values. Args: dead_letter_topic (str): Topic for publishing dead messages. max_delivery_attempts (int): Threshold of failed deliveries before sending message to the dead letter topic. Returns: DeadLetterPolicy message or None. )deadLetterTopicmaxDeliveryAttemptsN)r1DeadLetterPolicy)r*rurvs rr\%SubscriptionsClient._DeadLetterPolicys. ]] + ++3, rcRU(dU(aURRXS9$g)a*Builds RetryPolicy message from argument values. Args: min_retry_delay (str): The minimum delay between consecutive deliveries of a given message. max_retry_delay (str): The maximum delay between consecutive deliveries of a given message. Returns: DeadLetterPolicy message or None. )minimumBackoffmaximumBackoffN)r1 RetryPolicy)r*rwrxs rr] SubscriptionsClient._RetryPolicys-/ ]] & &(' rc NU(aURRUUUUUUS9$g)aBuilds BigQueryConfig message from argument values. Args: table (str): The name of the table use_topic_schema (bool): Whether or not to use the topic schema use_table_schema (bool): Whether or not to use the table schema write_metadata (bool): Whether or not to write metadata fields drop_unknown_fields (bool): Whether or not to drop fields that are only in the topic schema service_account_email(str): The service account to use Returns: BigQueryConfig message or None )tableuseTopicSchemauseTableSchema writeMetadatadropUnknownFieldsserviceAccountEmailN)r1BigQueryConfig)r*rr{r|r}r~service_account_emails rr^#SubscriptionsClient._BigQueryConfigs:. ]] ) )))&/3 * rc U(aURRUUUUUUUU S9n US:Xa!URR5U lU $US:Xa1URR U (aU OSU (aU OSS9U lU $g)a5Builds CloudStorageConfig message from argument values. Args: bucket (str): The name for the Cloud Storage bucket. file_prefix (str): The prefix for Cloud Storage filename. file_suffix (str): The suffix for Cloud Storage filename. file_datetime_format (str): The custom datetime format string for Cloud Storage filename. max_bytes (int): The maximum bytes that can be written to a Cloud Storage file before a new file is created. max_duration (str): The maximum duration that can elapse before a new Cloud Storage file is created. max_messages (int): The maximum number of messages that can be written to a Cloud Storage file before a new file is created. output_format (str): The output format for data written to Cloud Storage. use_topic_schema (bool): Whether or not to use the topic schema when writing to Cloud Storage. write_metadata (bool): Whether or not to write the subscription name and other metadata in the output. service_account_email(str): The service account to use Returns: CloudStorageConfig message or None )bucketfilenamePrefixfilenameSuffixfilenameDatetimeFormatmaxBytes maxDurationrrtextavroFN)rr)r1CloudStorageConfig TextConfig textConfig AvroConfig avroConfig) r*r file_prefix file_suffixfile_datetime_format max_bytes max_durationr output_formatr{r}rcloud_storage_configs rr_'SubscriptionsClient._CloudStorageConfigsL!]]==$$!5""3>  & *.--*B*B*D'"! F "*.--*B*B,:.0@+T +C+ ' "! rcDU(aURRXS9$g)zBuilds PubsubExportConfig message from argument values. Args: topic (str): The Pubsub topic to which to publish messages. region (str): The Cloud region to which to publish messages. Returns: PubsubExportConfig message or None )rJregionN)r1PubSubExportConfig)r*rJrs rr`'SubscriptionsClient._PubsubExportConfig0s" ]] - -E - II rcHU(aURRUUUS9$g)aBuilds BigtableConfig message from argument values. Args: table (str): The name of the Bigtable table. app_profile_id (str): The app profile to use. service_account_email (str): The service account to use. Returns: BigtableConfig message or None )r appProfileIdrN)r1BigtableConfig)r*rapp_profile_idrs rra#SubscriptionsClient._BigtableConfig>s1 ]] ) )%3* rc<UR[:XaSUlggr)r)DEFAULT_MESSAGE_RETENTION_VALUEr*update_settings r_HandleMessageRetentionUpdate1SubscriptionsClient._HandleMessageRetentionUpdateQs>>!n?rc<UR[:XaSUlggr)r)CLEAR_DEAD_LETTER_VALUErs r_HandleDeadLetterPolicyUpdate1SubscriptionsClient._HandleDeadLetterPolicyUpdateUs66!n7rc<UR[:XaSUlggr)r)CLEAR_RETRY_VALUErs r_HandleRetryPolicyUpdate,SubscriptionsClient._HandleRetryPolicyUpdateYs00!n1rc<UR[:XaSUlggr)r)CLEAR_BIGQUERY_CONFIG_VALUErs r_HandleBigQueryConfigUpdate/SubscriptionsClient._HandleBigQueryConfigUpdate]::!n;rc<UR[:XaSUlggr)r) CLEAR_CLOUD_STORAGE_CONFIG_VALUErs r_HandleCloudStorageConfigUpdate3SubscriptionsClient._HandleCloudStorageConfigUpdatea??!n@rc<UR[:XaSUlggr)r)"CLEAR_PUSH_NO_WRAPPER_CONFIG_VALUErs r_HandlePushNoWrapperUpdate.SubscriptionsClient._HandlePushNoWrapperUpdateesAA!nBrc<UR[:XaSUlggr)r) CLEAR_PUBSUB_EXPORT_CONFIG_VALUErs r_HandlePubsubExportConfigUpdate3SubscriptionsClient._HandlePubsubExportConfigUpdateirrc<UR[:XaSUlggr)r)CLEAR_BIGTABLE_CONFIG_VALUErs r_HandleBigtableConfigUpdate/SubscriptionsClient._HandleBigtableConfigUpdatemrrc.U"(a[n.OURUUUUUUUUUU U!5 n.U (a[n/OURX5n/U(a[n0OUR X5n0U(a[ n1OURUUUUUU5n1U&(a[n2OURU$U%5n2U*(a[n3OURU'U(U)5n3U#(a[n4OSn4U+(a.[R"URR U+U-5n5OSn5U,(a[,n7OSn7[/SU5[/SU5[/SU5[/SU5[/SU5[/SU5[/SUR1Xx55[/S U/5[/S U05[/S U15[/S U.5[/S U45[/SU25[/SU35[/SU55[/SU75/n8URR3UR55S9n9/n:U8GHxn;U;R6cMU;R8S:XaUR;U;5 U;R8S :XaUR=U;5 U;R8S :XaUR?U;5 U;R8S :XaURAU;5 U;R8S :XaURCU;5 U;R8S:XaUREU;5 U;R8S:XaURGU;5 U;R8S :Xa2URIU;5 UcU:RKU;R85 GM<[MU9U;R8U;R65 U:RKU;R85 GM{ U:(d [OS5eURRQURRSU9SRUU:5S9UR55S9nrmrnrorprNrqrrrurvclear_dead_letter_policyrwrxclear_retry_policyryrzr{r|r}r~rclear_bigquery_configrrrrrrrrrrrclear_cloud_storage_configclear_push_no_wrapper_configrrclear_pubsub_export_configrrrclear_bigtable_configrclear_message_transformsrcloud_storage_config_settingsdead_letter_policy retry_policybigquery_configpubsub_export_configbigtable_configpush_config_no_wrappermessage_transformsrclear_messagesupdate_settingsr8 update_maskr patch_reqs= rr2SubscriptionsClient.PatchqsPL"&F#&*&>&>  # # , ! $ $ % ( & - '# 211 &l&&Hl3o,,      ( o"=!55 93o,,  ! (o $A# "?? MM * * #   :nn ##7F"<=" !#8  # ')E  # &(B  #8V4"   " "= D  ##57IJ"=,?"#3_E" "?  # "$:  ##79MN"#3_E"#68JK"#6G;O>==--  * * ,.LK)    )  $ $(B B  , ,^ <  $ $(: :  , ,^ <  $ $ 5  ' ' 7  $ $(8 8  * *> :  $ $(< <  . .~ >  $ $(< <  . .~ >  $ $(8 8  * *> :  $ $(> >  ) ). 9    ~88 9  n779M9MN>445-*.  "#O PP EE"&--"I"I%#((;2G#J#  * * , FI ==  y ))c  3 3  / /  1 1 ''*, s%,P 3Q<QQcURRUR5URRUS9S9nURR U5$)zSets an IAM policy on a Subscription. Args: subscription_ref (Resource): Resource reference for subscription to set IAM policy on. policy (Policy): The policy to be added to the Subscription. Returns: Policy: the policy which was set. )policy)resourcesetIamPolicyRequest)r1.PubsubProjectsSubscriptionsSetIamPolicyRequestr;SetIamPolicyRequestr3 SetIamPolicy)r*r>rIrequests rrN SubscriptionsClient.SetIamPolicysVmmJJ!..0 MM==V=LKG == % %g ..rcURRUR5S9nURR U5$)zGets the IAM policy for a Subscription. Args: subscription_ref (Resource): Resource reference for subscription to get the IAM policy of. Returns: Policy: the policy for the Subscription. )rJ)r1.PubsubProjectsSubscriptionsGetIamPolicyRequestr;r3 GetIamPolicy)r*r>rOs rrS SubscriptionsClient.GetIamPolicysAmmJJ!..0KG == % %g ..rcURU5n[R"URRXBU5 UR X5$)a^Adds an IAM Policy binding to a Subscription. Args: subscription_ref (Resource): Resource reference for subscription to add IAM policy binding to. member (str): The member to add. role (str): The role to assign to the member. Returns: Policy: the updated policy. Raises: api_exception.HttpException: If either of the requests failed. )rSrAddBindingToIamPolicyr1BindingrNr*r>memberrolerIs rAddIamPolicyBinding'SubscriptionsClient.AddIamPolicyBindingsC  / 0F ""4==#8#8&$O   - 66rctURU5n[R"XBU5 URX5$)ahRemoves an IAM Policy binding from a Subscription. Args: subscription_ref (Resource): Resource reference for subscription to remove IAM policy binding from. member (str): The member to add. role (str): The role to assign to the member. Returns: Policy: the updated policy. Raises: api_exception.HttpException: If either of the requests failed. )rSrRemoveBindingFromIamPolicyrNrXs rRemoveIamPolicyBinding*SubscriptionsClient.RemoveIamPolicyBindings7  / 0F ''=   - 66r)r3r!r1)NN)&NNNNFNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNF)d)T),NNNNNFNNNFNNFNNNNNNNFNNNNNNNNNNNFFNNFNNNFNFF)$rrrrrr+r@rErkrrrrrrr[r\r]r^r_r`rarr rrrrr"r&r2rNrSr[r_rrrrr.r.<sB7 .$ &( !% " #'%) $ $)-"!%!%"&%)#'*.!%"%)"  Uy.v ,.4*3&6(& $$ D<| &"""""""" !%  $#'%)! $ $)-"!%!%"&%)#'*.!&#(!%!&"%)!"$ ]]*~/" /7$7rr.)Fr)rapitools.base.pyrgooglecloudsdk.api_lib.pubsubrgooglecloudsdk.api_lib.utilrgooglecloudsdk.command_lib.iamrgooglecloudsdk.corerrrrNEVER_EXPIRATION_PERIOD_VALUEr rrrrr!r%r,Errorr rr"objectr$r.rrrrjs 5(/,3*!*"+ '!%#* %,"#* %&(#CZ--CA V7&V7r