ManagedEventSubscription (Beta)

Represents a managed event subscription in Pub/Sub API. Use a managed event subscription to track the events that a subscriber client consumed and resume a subscription where it left off. This object is available in API version 60.0 and later.

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Note

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

To retrieve or query this object, you must have the View Setup and Configuration permission.
To create, update, or delete this object, you must have the Customize Application permission.

Fields

Field	Details
DeveloperName	Type string Properties Filter, Group, Sort Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Note
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated ManagedEventSubscription in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Language	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of ManagedEventSubscription. Possible values are: `da`—Danish `de`—German `en_US`—English `es`—Spanish `es_MX`—Spanish (Mexico) `fi`—Finnish `fr`—French `it`—Italian `ja`—Japanese `ko`—Korean `nl_NL`—Dutch `no`—Norwegian `pt_BR`—Portuguese (Brazil) `ru`—Russian `sv`—Swedish `th`—Thai `zh_CN`—Chinese (Simplified) `zh_TW`—Chinese (Traditional)
ManageableState	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package. Possible values are: `beta`—Managed-Beta `deleted`—Managed-Proposed-Deleted `deprecated`—Managed-Proposed-Deprecated `deprecatedEditable`—SecondGen-Installed-Deprecated `installed`—Managed-Installed `installedEditable`—SecondGen-Installed-Editable `released`—Managed-Released `unmanaged`—Unmanaged
MasterLabel	Type string Properties Filter, Group, Sort Description The label for the managed event subscription, which corresponds to the label of the ManagedEventSubscription metadata type. The label is displayed in the user interface. If the label isn't provided in the metadata type, MasterLabel is the DeveloperName value.
Metadata	Type ManagedEventSubscription Properties Create, Nillable, Update Description The metadata for the managed event subscription.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
Version	Type string Properties Filter, Group, Sort Description Reserved for future use.

Usage

This JSON example is the body of a REST API POST request that creates a managed event subscription named My_Managed_Subscription. The corresponding REST endpoint is /services/data/v66.0/tooling/sobjects/ManagedEventSubscription.

1{
2  "FullName": "My_Managed_Subscription",
3  "Metadata": 
4  {
5      "label" : "My Managed Subscription",
6      "topicName" : "/event/Order_Event__e",
7      "defaultReplay": "LATEST",
8      "state" : "RUN",
9      "errorRecoveryReplay" : "LATEST"
10  }
11}