Newer Version Available

This content describes an older version of this product. View Latest

InboundNetworkConnection

Represents the a private connection between a third-party data service and a Salesforce org. The connection is inbound because the callouts are coming into Salesforce.. Available in API version 49.0 and later.

Supported SOAP Calls

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

Supported REST HTTP Methods

DELETEGETPATCHPOST

Fields

Field Details
ConnectionType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Required. Specifies the Cloud provider of the connection. The only valid value is AwsPrivateLink.
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Required. A description of the connection. Maximum of 255 characters.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The developer’s internal name for the inbound network connection used in the API.
FullName
Type
string
Properties
Create, Group, Nillable
Description
The full name of the associated type in Metadata API.

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.

isActive
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Required. Specifies whether the connection is active (true) or not(false). The default value is false
Language
Type
string
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The language of the connection. The value for this field is the language value of the org.
ManageableState
Type
ManageableState enumerated list
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package:
  • beta
  • deleted
  • deprecated
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The internal label for the connection.
Metadata
Type
mns:InboundNetworkConnection
Properties
Create, Nillable, Update
Description
Provides access to the associated type and related fields in Metadata API.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace of the connection. An inbound network connection can be in an extension namespace different than the object.
Status
Type
picklist
Properties
Filter, Group, Restricted Picklist, Sort
Description
Required. Connection status. The connection is initially Unprovisioned and moves through the other states automatically after an admin performs a provision, sync, or teardown action. The valid values are:
  • Unprovisioned
  • Allocating
  • PendingAcceptance
  • PendingActivation
  • RejectedRemotely
  • DeletedRemotely
  • TeardownInProgress
  • Ready