From ff58cdd9e18d9cbf6e6779cd9040fb794b876edd Mon Sep 17 00:00:00 2001
From: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Date: Wed, 22 Apr 2026 09:34:10 +0000
Subject: [PATCH] SDK regeneration
---
reference.md | 1700 ++++++++++++-----
.../client/mgmt/AsyncLogStreamsClient.java | 1394 ++++++++------
.../client/mgmt/AsyncOrganizationsClient.java | 8 +
.../mgmt/AsyncRawClientGrantsClient.java | 4 +
.../client/mgmt/AsyncRawLogStreamsClient.java | 1394 ++++++++------
.../auth0/client/mgmt/LogStreamsClient.java | 1394 ++++++++------
.../client/mgmt/OrganizationsClient.java | 8 +
.../client/mgmt/RawClientGrantsClient.java | 4 +
.../client/mgmt/RawLogStreamsClient.java | 1394 ++++++++------
.../AsyncDirectoryProvisioningClient.java | 51 +
.../AsyncRawDirectoryProvisioningClient.java | 246 +++
.../DirectoryProvisioningClient.java | 50 +
.../RawDirectoryProvisioningClient.java | 187 ++
...stSynchronizedGroupsRequestParameters.java | 195 ++
...placeSynchronizedGroupsRequestContent.java | 125 ++
.../organizations/AsyncConnectionsClient.java | 102 +
.../AsyncRawConnectionsClient.java | 549 ++++++
.../mgmt/organizations/ConnectionsClient.java | 100 +
.../organizations/RawConnectionsClient.java | 423 ++++
...izationAllConnectionRequestParameters.java | 395 ++++
...zationAllConnectionsRequestParameters.java | 301 +++
...ganizationConnectionRequestParameters.java | 369 ++++
...ServiceProfileSsoTicketRequestContent.java | 31 +-
.../UpdateTenantSettingsRequestContent.java | 66 +-
.../com/auth0/client/mgmt/types/Client.java | 80 +
...gy.java => ClientGrantDefaultForEnum.java} | 28 +-
.../types/ClientGrantResponseContent.java | 26 +
...ionConfigurationAllowedStrategiesEnum.java | 141 ++
...entMyOrganizationDeletionBehaviorEnum.java | 86 +
...lientMyOrganizationPatchConfiguration.java | 287 +++
...ClientMyOrganizationPostConfiguration.java | 287 +++
...ntMyOrganizationResponseConfiguration.java | 287 +++
.../types/ClientRedirectionPolicyEnum.java | 86 +
.../ClientSessionTransferConfiguration.java | 61 +-
...essionTransferDelegationConfiguration.java | 140 ++
...onTransferDelegationDeviceBindingEnum.java | 86 +
.../ClientThirdPartySecurityModeEnum.java | 86 +
.../client/mgmt/types/ConnectedAccount.java | 49 +-
...java => ConnectionDpopSigningAlgEnum.java} | 38 +-
.../types/ConnectionIdentityProviderEnum.java | 11 -
.../types/ConnectionOptionsCommonOidc.java | 33 +
.../mgmt/types/ConnectionOptionsFlickr.java | 276 ---
.../mgmt/types/ConnectionOptionsOidc.java | 33 +
.../mgmt/types/ConnectionOptionsOkta.java | 33 +
.../types/ConnectionPropertiesOptions.java | 26 +
.../ConnectionResponseContentFlickr.java | 458 -----
.../mgmt/types/ConnectionStrategyEnum.java | 10 -
.../CreateClientGrantRequestContent.java | 32 +
.../CreateClientGrantResponseContent.java | 26 +
.../types/CreateClientRequestContent.java | 99 +
.../types/CreateClientResponseContent.java | 80 +
.../CreateConnectionRequestContentFlickr.java | 332 ----
...teDirectoryProvisioningRequestContent.java | 12 +-
...eDirectoryProvisioningResponseContent.java | 16 +-
...anizationAllConnectionResponseContent.java | 426 +++++
.../mgmt/types/DirectoryProvisioning.java | 16 +-
.../EventStreamDeliveryEventTypeEnum.java | 124 +-
.../mgmt/types/EventStreamEventTypeEnum.java | 122 +-
.../types/EventStreamTestEventTypeEnum.java | 123 +-
.../types/GetClientGrantResponseContent.java | 26 +
.../mgmt/types/GetClientResponseContent.java | 80 +
...tDirectoryProvisioningResponseContent.java | 16 +-
...anizationAllConnectionResponseContent.java | 426 +++++
.../GetTenantSettingsResponseContent.java | 65 +-
.../types/IConnectionOptionsCommonOidc.java | 2 +
.../mgmt/types/IdentityProviderEnum.java | 10 -
.../ListClientGrantsRequestParameters.java | 79 +-
...ectionsOffsetPaginatedResponseContent.java | 182 ++
...ListSynchronizedGroupsResponseContent.java | 153 ++
.../client/mgmt/types/NetworkAclMatch.java | 26 -
.../types/OrganizationAccessLevelEnum.java | 105 +
.../OrganizationAccessLevelEnumWithNull.java | 108 ++
.../types/OrganizationAllConnectionPost.java | 425 +++++
.../RotateClientSecretResponseContent.java | 80 +
...ceProfileSsoTicketDomainAliasesConfig.java | 52 +-
...erviceProfileSsoTicketEnabledFeatures.java | 175 ++
...EaEnum.java => SynchronizeGroupsEnum.java} | 26 +-
.../mgmt/types/SynchronizedGroupPayload.java | 129 ++
...DynamicClientRegistrationSecurityMode.java | 86 +
.../UpdateClientGrantResponseContent.java | 26 +
.../types/UpdateClientRequestContent.java | 117 +-
.../types/UpdateClientResponseContent.java | 80 +
.../mgmt/types/UpdateConnectionOptions.java | 26 +
.../UpdateConnectionRequestContentFlickr.java | 212 --
...teDirectoryProvisioningRequestContent.java | 12 +-
...eDirectoryProvisioningResponseContent.java | 16 +-
...anizationAllConnectionResponseContent.java | 426 +++++
.../UpdateTenantSettingsResponseContent.java | 65 +-
.../mgmt/types/UserIdentityProviderEnum.java | 10 -
.../client/mgmt/ClientGrantsWireTest.java | 13 +-
...nectionsDirectoryProvisioningWireTest.java | 87 +-
.../mgmt/EventStreamsDeliveriesWireTest.java | 8 +-
.../EventStreamsRedeliveriesWireTest.java | 4 +-
.../client/mgmt/EventStreamsWireTest.java | 8 +-
.../OrganizationsConnectionsWireTest.java | 358 ++++
.../mgmt/UsersConnectedAccountsWireTest.java | 2 +-
.../ClientsWireTest_testCreate_response.json | 16 +-
.../ClientsWireTest_testGet_response.json | 16 +-
.../ClientsWireTest_testList_response.json | 8 +
...ntsWireTest_testRotateSecret_response.json | 16 +-
.../ClientsWireTest_testUpdate_response.json | 16 +-
.../NetworkAclsWireTest_testGet_response.json | 6 -
.../NetworkAclsWireTest_testSet_response.json | 6 -
...tworkAclsWireTest_testUpdate_response.json | 6 -
...antsSettingsWireTest_testGet_response.json | 4 +-
...sSettingsWireTest_testUpdate_response.json | 4 +-
106 files changed, 13892 insertions(+), 4473 deletions(-)
create mode 100644 src/main/java/com/auth0/client/mgmt/connections/types/ListSynchronizedGroupsRequestParameters.java
create mode 100644 src/main/java/com/auth0/client/mgmt/connections/types/ReplaceSynchronizedGroupsRequestContent.java
create mode 100644 src/main/java/com/auth0/client/mgmt/organizations/AsyncConnectionsClient.java
create mode 100644 src/main/java/com/auth0/client/mgmt/organizations/AsyncRawConnectionsClient.java
create mode 100644 src/main/java/com/auth0/client/mgmt/organizations/ConnectionsClient.java
create mode 100644 src/main/java/com/auth0/client/mgmt/organizations/RawConnectionsClient.java
create mode 100644 src/main/java/com/auth0/client/mgmt/organizations/types/CreateOrganizationAllConnectionRequestParameters.java
create mode 100644 src/main/java/com/auth0/client/mgmt/organizations/types/ListOrganizationAllConnectionsRequestParameters.java
create mode 100644 src/main/java/com/auth0/client/mgmt/organizations/types/UpdateOrganizationConnectionRequestParameters.java
rename src/main/java/com/auth0/client/mgmt/types/{ConnectionResponseContentFlickrStrategy.java => ClientGrantDefaultForEnum.java} (58%)
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationConfigurationAllowedStrategiesEnum.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationDeletionBehaviorEnum.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationPatchConfiguration.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationPostConfiguration.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationResponseConfiguration.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ClientRedirectionPolicyEnum.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ClientSessionTransferDelegationConfiguration.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ClientSessionTransferDelegationDeviceBindingEnum.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ClientThirdPartySecurityModeEnum.java
rename src/main/java/com/auth0/client/mgmt/types/{CreateConnectionRequestContentFlickrStrategy.java => ConnectionDpopSigningAlgEnum.java} (53%)
delete mode 100644 src/main/java/com/auth0/client/mgmt/types/ConnectionOptionsFlickr.java
delete mode 100644 src/main/java/com/auth0/client/mgmt/types/ConnectionResponseContentFlickr.java
delete mode 100644 src/main/java/com/auth0/client/mgmt/types/CreateConnectionRequestContentFlickr.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/CreateOrganizationAllConnectionResponseContent.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/GetOrganizationAllConnectionResponseContent.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ListOrganizationAllConnectionsOffsetPaginatedResponseContent.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/ListSynchronizedGroupsResponseContent.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/OrganizationAccessLevelEnum.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/OrganizationAccessLevelEnumWithNull.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/OrganizationAllConnectionPost.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/SelfServiceProfileSsoTicketEnabledFeatures.java
rename src/main/java/com/auth0/client/mgmt/types/{SynchronizeGroupsEaEnum.java => SynchronizeGroupsEnum.java} (65%)
create mode 100644 src/main/java/com/auth0/client/mgmt/types/SynchronizedGroupPayload.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/TenantSettingsDynamicClientRegistrationSecurityMode.java
delete mode 100644 src/main/java/com/auth0/client/mgmt/types/UpdateConnectionRequestContentFlickr.java
create mode 100644 src/main/java/com/auth0/client/mgmt/types/UpdateOrganizationAllConnectionResponseContent.java
create mode 100644 src/test/java/com/auth0/client/mgmt/OrganizationsConnectionsWireTest.java
diff --git a/reference.md b/reference.md
index d37e177d6..5cdaa50ca 100644
--- a/reference.md
+++ b/reference.md
@@ -775,6 +775,9 @@ client.clientGrants().list(
.subjectType(
OptionalNullable.of(ClientGrantSubjectTypeEnum.CLIENT)
)
+ .defaultFor(
+ OptionalNullable.of(ClientGrantDefaultForEnum.THIRD_PARTY_CLIENTS)
+ )
.build()
);
```
@@ -833,6 +836,14 @@ client.clientGrants().list(
**subjectType:** `Optional Sample Response
+
@@ -906,6 +917,14 @@ client.clientGrants().create(
+
+
+
-#### π Usage
+**Sample responses**
-
+
+
+
+
+
+
-
-
+
+
+
@@ -7383,138 +7526,188 @@ client.logStreams().create(
>`
+
+
+
+
+>`
+
+
+
+
+
@@ -5405,7 +5472,7 @@ client.eventStreams().test(
"id",
CreateEventStreamTestEventRequestContent
.builder()
- .eventType(EventStreamTestEventTypeEnum.USER_CREATED)
+ .eventType(EventStreamTestEventTypeEnum.GROUP_CREATED)
.build()
);
```
@@ -7086,72 +7153,77 @@ client.jobs().get("id");
@@ -7191,131 +7263,202 @@ client.logStreams().list();
Sample Response
+ "id": "string",
+ "name": "string",
+ "type": "datadog",
+ "status": "active|paused|suspended",
+ "sink": {
+ "datadogRegion": "string",
+ "datadogApiKey": "string"
+ }
+}]
+```
[{
- "id": "string",
- "name": "string",
- "type": "eventbridge",
- "status": "active|paused|suspended",
- "sink": {
- "awsAccountId": "string",
- "awsRegion": "string",
- "awsPartnerEventSource": "string"
- }
+Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
+
+**Sample Response**
+
+```json
+[{
+ "id": "string",
+ "name": "string",
+ "type": "eventbridge",
+ "status": "active|paused|suspended",
+ "sink": {
+ "awsAccountId": "string",
+ "awsRegion": "string",
+ "awsPartnerEventSource": "string"
+ }
}, {
- "id": "string",
- "name": "string",
- "type": "http",
- "status": "active|paused|suspended",
- "sink": {
- "httpContentFormat": "JSONLINES|JSONARRAY",
- "httpContentType": "string",
- "httpEndpoint": "string",
- "httpAuthorization": "string"
- }
+ "id": "string",
+ "name": "string",
+ "type": "http",
+ "status": "active|paused|suspended",
+ "sink": {
+ "httpContentFormat": "JSONLINES|JSONARRAY",
+ "httpContentType": "string",
+ "httpEndpoint": "string",
+ "httpAuthorization": "string"
+ }
},
{
- "id": "string",
- "name": "string",
- "type": "eventgrid",
- "status": "active|paused|suspended",
- "sink": {
- "azureSubscriptionId": "string",
- "azureResourceGroup": "string",
- "azureRegion": "string",
- "azurePartnerTopic": "string"
- }
+ "id": "string",
+ "name": "string",
+ "type": "eventgrid",
+ "status": "active|paused|suspended",
+ "sink": {
+ "azureSubscriptionId": "string",
+ "azureResourceGroup": "string",
+ "azureRegion": "string",
+ "azurePartnerTopic": "string"
+ }
},
{
- "id": "string",
- "name": "string",
- "type": "splunk",
- "status": "active|paused|suspended",
- "sink": {
- "splunkDomain": "string",
- "splunkToken": "string",
- "splunkPort": "string",
- "splunkSecure": "boolean"
- }
+ "id": "string",
+ "name": "string",
+ "type": "splunk",
+ "status": "active|paused|suspended",
+ "sink": {
+ "splunkDomain": "string",
+ "splunkToken": "string",
+ "splunkPort": "string",
+ "splunkSecure": "boolean"
+ }
},
{
- "id": "string",
- "name": "string",
- "type": "sumo",
- "status": "active|paused|suspended",
- "sink": {
- "sumoSourceAddress": "string",
- }
+ "id": "string",
+ "name": "string",
+ "type": "sumo",
+ "status": "active|paused|suspended",
+ "sink": {
+ "sumoSourceAddress": "string"
+ }
},
{
- "id": "string",
- "name": "string",
- "type": "datadog",
- "status": "active|paused|suspended",
- "sink": {
- "datadogRegion": "string",
- "datadogApiKey": "string"
- }
-}]Log Stream Types
The type of log stream being created determines the properties required in the sink payload.
-HTTP Stream
For an http Stream, the sink properties are listed in the payload below
-Request:
-Response: {
- "name": "string",
- "type": "http",
- "sink": {
- "httpEndpoint": "string",
- "httpContentType": "string",
- "httpContentFormat": "JSONLINES|JSONARRAY",
- "httpAuthorization": "string"
- }
-}
-{
- "id": "string",
- "name": "string",
- "type": "http",
- "status": "active",
- "sink": {
- "httpEndpoint": "string",
- "httpContentType": "string",
- "httpContentFormat": "JSONLINES|JSONARRAY",
- "httpAuthorization": "string"
- }
-}Amazon EventBridge Stream
For an eventbridge Stream, the sink properties are listed in the payload below
-Request:
-The response will include an additional field {
- "name": "string",
- "type": "eventbridge",
- "sink": {
- "awsRegion": "string",
- "awsAccountId": "string"
- }
-}awsPartnerEventSource in the sink:
-{
- "id": "string",
- "name": "string",
- "type": "eventbridge",
- "status": "active",
- "sink": {
- "awsAccountId": "string",
- "awsRegion": "string",
- "awsPartnerEventSource": "string"
- }
-}Azure Event Grid Stream
For an Azure Event Grid Stream, the sink properties are listed in the payload below
-Request:
-Response: {
- "name": "string",
- "type": "eventgrid",
- "sink": {
- "azureSubscriptionId": "string",
- "azureResourceGroup": "string",
- "azureRegion": "string"
- }
-}
-{
- "id": "string",
- "name": "string",
- "type": "http",
- "status": "active",
- "sink": {
- "azureSubscriptionId": "string",
- "azureResourceGroup": "string",
- "azureRegion": "string",
- "azurePartnerTopic": "string"
- }
-}Datadog Stream
For a Datadog Stream, the sink properties are listed in the payload below
-Request:
-Response: {
- "name": "string",
- "type": "datadog",
- "sink": {
- "datadogRegion": "string",
- "datadogApiKey": "string"
- }
-}
-{
- "id": "string",
- "name": "string",
- "type": "datadog",
- "status": "active",
- "sink": {
- "datadogRegion": "string",
- "datadogApiKey": "string"
- }
-}Splunk Stream
For a Splunk Stream, the sink properties are listed in the payload below
-Request:
-Response: {
- "name": "string",
- "type": "splunk",
- "sink": {
- "splunkDomain": "string",
- "splunkToken": "string",
- "splunkPort": "string",
- "splunkSecure": "boolean"
- }
-}
-{
- "id": "string",
- "name": "string",
- "type": "splunk",
- "status": "active",
- "sink": {
- "splunkDomain": "string",
- "splunkToken": "string",
- "splunkPort": "string",
- "splunkSecure": "boolean"
- }
-}Sumo Logic Stream
For a Sumo Logic Stream, the sink properties are listed in the payload below
-Request:
-Response: {
- "name": "string",
- "type": "sumo",
- "sink": {
- "sumoSourceAddress": "string",
- }
-}
+
+**Log Stream Types**
+
+The `type` of log stream being created determines the properties required in the `sink` payload.
+
+**HTTP Stream**
+
+For an `http` Stream, the `sink` properties are listed in the payload below.
+
+**Request:**
+```json
+{
+ "name": "string",
+ "type": "http",
+ "sink": {
+ "httpEndpoint": "string",
+ "httpContentType": "string",
+ "httpContentFormat": "JSONLINES|JSONARRAY",
+ "httpAuthorization": "string"
+ }
+}
+```
+
+**Response:**
+```json
+{
+ "id": "string",
+ "name": "string",
+ "type": "http",
+ "status": "active",
+ "sink": {
+ "httpEndpoint": "string",
+ "httpContentType": "string",
+ "httpContentFormat": "JSONLINES|JSONARRAY",
+ "httpAuthorization": "string"
+ }
+}
+```
+
+**Amazon EventBridge Stream**
+
+For an `eventbridge` Stream, the `sink` properties are listed in the payload below.
+
+**Request:**
+```json
+{
+ "name": "string",
+ "type": "eventbridge",
+ "sink": {
+ "awsRegion": "string",
+ "awsAccountId": "string"
+ }
+}
+```
+
+The response will include an additional field `awsPartnerEventSource` in the `sink`:
+
+**Response:**
+```json
+{
+ "id": "string",
+ "name": "string",
+ "type": "eventbridge",
+ "status": "active",
+ "sink": {
+ "awsAccountId": "string",
+ "awsRegion": "string",
+ "awsPartnerEventSource": "string"
+ }
+}
+```
+
+**Azure Event Grid Stream**
+
+For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below.
+
+**Request:**
+```json
+{
+ "name": "string",
+ "type": "eventgrid",
+ "sink": {
+ "azureSubscriptionId": "string",
+ "azureResourceGroup": "string",
+ "azureRegion": "string"
+ }
+}
+```
+
+**Response:**
+```json
+{
+ "id": "string",
+ "name": "string",
+ "type": "http",
+ "status": "active",
+ "sink": {
+ "azureSubscriptionId": "string",
+ "azureResourceGroup": "string",
+ "azureRegion": "string",
+ "azurePartnerTopic": "string"
+ }
+}
+```
+
+**Datadog Stream**
+
+For a `Datadog` Stream, the `sink` properties are listed in the payload below.
+
+**Request:**
+```json
+{
+ "name": "string",
+ "type": "datadog",
+ "sink": {
+ "datadogRegion": "string",
+ "datadogApiKey": "string"
+ }
+}
+```
+
+**Response:**
+```json
+{
+ "id": "string",
+ "name": "string",
+ "type": "datadog",
+ "status": "active",
+ "sink": {
+ "datadogRegion": "string",
+ "datadogApiKey": "string"
+ }
+}
+```
+
+**Splunk Stream**
+
+For a `Splunk` Stream, the `sink` properties are listed in the payload below.
+
+**Request:**
+```json
+{
+ "name": "string",
+ "type": "splunk",
+ "sink": {
+ "splunkDomain": "string",
+ "splunkToken": "string",
+ "splunkPort": "string",
+ "splunkSecure": "boolean"
+ }
+}
+```
+
+**Response:**
+```json
+{
+ "id": "string",
+ "name": "string",
+ "type": "splunk",
+ "status": "active",
+ "sink": {
+ "splunkDomain": "string",
+ "splunkToken": "string",
+ "splunkPort": "string",
+ "splunkSecure": "boolean"
+ }
+}
+```
+
+**Sumo Logic Stream**
+
+For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below.
+
+**Request:**
+```json
+{
+ "name": "string",
+ "type": "sumo",
+ "sink": {
+ "sumoSourceAddress": "string"
+ }
+}
+```
+
+**Response:**
+```json
+{
+ "id": "string",
+ "name": "string",
+ "type": "sumo",
+ "status": "active",
+ "sink": {
+ "sumoSourceAddress": "string"
+ }
+}
+```
{
- "id": "string",
- "name": "string",
- "type": "sumo",
- "status": "active",
- "sink": {
- "sumoSourceAddress": "string",
- }
-}Sample responses
Amazon EventBridge Log Stream
{
- "id": "string",
- "name": "string",
- "type": "eventbridge",
- "status": "active|paused|suspended",
- "sink": {
- "awsAccountId": "string",
- "awsRegion": "string",
- "awsPartnerEventSource": "string"
- }
-}HTTP Log Stream
{
- "id": "string",
- "name": "string",
- "type": "http",
- "status": "active|paused|suspended",
- "sink": {
- "httpContentFormat": "JSONLINES|JSONARRAY",
- "httpContentType": "string",
- "httpEndpoint": "string",
- "httpAuthorization": "string"
- }
-}Datadog Log Stream
{
- "id": "string",
- "name": "string",
- "type": "datadog",
- "status": "active|paused|suspended",
- "sink": {
- "datadogRegion": "string",
- "datadogApiKey": "string"
- }
-
-}Mixpanel
-
- Request:
-
-
- Response: {
- "name": "string",
- "type": "mixpanel",
- "sink": {
- "mixpanelRegion": "string", // "us" | "eu",
- "mixpanelProjectId": "string",
- "mixpanelServiceAccountUsername": "string",
- "mixpanelServiceAccountPassword": "string"
- }
- }
-
- {
- "id": "string",
- "name": "string",
- "type": "mixpanel",
- "status": "active",
- "sink": {
- "mixpanelRegion": "string", // "us" | "eu",
- "mixpanelProjectId": "string",
- "mixpanelServiceAccountUsername": "string",
- "mixpanelServiceAccountPassword": "string" // the following is redacted on return
- }
- } Segment
-
- Request:
-
- Response: {
- "name": "string",
- "type": "segment",
- "sink": {
- "segmentWriteKey": "string"
- }
- }
-
-{
- "id": "string",
- "name": "string",
- "type": "segment",
- "status": "active",
- "sink": {
- "segmentWriteKey": "string"
- }
- } Splunk Log Stream
{
- "id": "string",
- "name": "string",
- "type": "splunk",
- "status": "active|paused|suspended",
- "sink": {
- "splunkDomain": "string",
- "splunkToken": "string",
- "splunkPort": "string",
- "splunkSecure": "boolean"
- }
-}Sumo Logic Log Stream
{
- "id": "string",
- "name": "string",
- "type": "sumo",
- "status": "active|paused|suspended",
- "sink": {
- "sumoSourceAddress": "string",
- }
-}Status
The status of a log stream maybe any of the following:
-1. active - Stream is currently enabled.
-2. paused - Stream is currently user disabled and will not attempt log delivery.
-3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
-
-
-#### βοΈ Parameters
+**Datadog Log Stream**
-
-
-
-
+
+#### π Usage
+
+
-
+
+
+
+#### βοΈ Parameters
+
+
+
+
+
@@ -18349,8 +18581,7 @@ client.connections().directoryProvisioning().getDefaultMapping("id");
-## Connections ScimConfiguration
-
+
Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation:
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
-Update the status of a log stream
-{
- "status": "active|paused"
-}Update the name of a log stream
-{
- "name": "string"
-}Update the sink properties of a stream of type
http
-{
+
+**Examples of how to use the PATCH endpoint.**
+
+The following fields may be updated in a PATCH operation:
+
+- name
+- status
+- sink
+
+Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.
+
+**Update the status of a log stream**
+
+```json
+{
+ "status": "active|paused"
+}
+```
+
+**Update the name of a log stream**
+
+```json
+{
+ "name": "string"
+}
+```
+
+**Update the sink properties of a stream of type `http`**
+
+```json
+{
"sink": {
"httpEndpoint": "string",
"httpContentType": "string",
"httpContentFormat": "JSONARRAY|JSONLINES",
"httpAuthorization": "string"
}
-}Update the sink properties of a stream of type
datadog
-{
+}
+```
+
+**Update the sink properties of a stream of type `datadog`**
+
+```json
+{
"sink": {
- "datadogRegion": "string",
- "datadogApiKey": "string"
+ "datadogRegion": "string",
+ "datadogApiKey": "string"
}
-}Update the sink properties of a stream of type
splunk
-{
+}
+```
+
+**Update the sink properties of a stream of type `splunk`**
+
+```json
+{
"sink": {
"splunkDomain": "string",
"splunkToken": "string",
"splunkPort": "string",
"splunkSecure": "boolean"
}
-}Update the sink properties of a stream of type
sumo
+}
+```
{
+}
+```
+
+**Update the sink properties of a stream of type `sumo`**
+
+```json
+{
"sink": {
"sumoSourceAddress": "string"
}
-}
+client.connections.scimConfiguration.list() -> SyncPagingIterable<ScimConfiguration>client.connections.directoryProvisioning.listSynchronizedGroups(id) -> SyncPagingIterable<SynchronizedGroupPayload>
+
+
+
+client.connections.scimConfiguration.get(id) -> GetScimConfigurationResponseContentclient.connections.directoryProvisioning.set(id, request)
@@ -18464,7 +18717,15 @@ client.connections().scimConfiguration().get("id");
connectionId.
+Create or replace the selected groups for a connection directory provisioning configuration.
connectionId.
+
+
+
@@ -18476,7 +18737,8 @@ client.connections().scimConfiguration().get("id");
+## Connections ScimConfiguration
+client.connections.scimConfiguration.create(id, request) -> CreateScimConfigurationResponseContentclient.connections.scimConfiguration.list() -> SyncPagingIterable<ScimConfiguration>
@@ -18529,7 +18798,7 @@ client.connections().scimConfiguration().create(
@@ -18541,7 +18810,7 @@ client.connections().scimConfiguration().create(
+client.connections.scimConfiguration.delete(id)client.connections.scimConfiguration.get(id) -> GetScimConfigurationResponseContent
@@ -18583,7 +18852,7 @@ client.connections().scimConfiguration().delete("id");
connectionId.
+Retrieves a scim configuration by its connectionId.
connectionId.
@@ -18595,7 +18864,7 @@ client.connections().scimConfiguration().delete("id");
+client.connections.scimConfiguration.update(id, request) -> UpdateScimConfigurationResponseContentclient.connections.scimConfiguration.create(id, request) -> CreateScimConfigurationResponseContent
connectionId.
+Create a scim configuration for a connection.
connectionId.
-
-
-
@@ -18666,7 +18917,7 @@ client.connections().scimConfiguration().update(
@@ -18678,7 +18929,7 @@ client.connections().scimConfiguration().update(
+client.connections.scimConfiguration.getDefaultMapping(id) -> GetScimConfigurationDefaultMappingResponseContentclient.connections.scimConfiguration.delete(id)
@@ -18720,7 +18971,7 @@ client.connections().scimConfiguration().getDefaultMapping("id");
connectionId.
+Deletes a scim configuration by its connectionId.
connectionId
```java
-client.connections().scimConfiguration().getDefaultMapping("id");
+client.connections().scimConfiguration().delete("id");
```
@@ -18732,8 +18983,7 @@ client.connections().scimConfiguration().getDefaultMapping("id");
+client.connections.clients.get(id) -> SyncPagingIterable<ConnectionEnabledClient>client.connections.scimConfiguration.update(id, request) -> UpdateScimConfigurationResponseContent
@@ -18796,7 +19046,7 @@ client.connections().clients().get(
from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.
+Update a scim configuration by its connectionId.
@@ -18804,7 +19054,145 @@ client.connections().clients().get(
+
+
+
+
+
+
+
+client.connections.scimConfiguration.getDefaultMapping(id) -> GetScimConfigurationDefaultMappingResponseContent
+
+
+
+
+#### π Usage
+
+
+
+connectionId.
+
+
+
+#### βοΈ Parameters
+
+
+
+
+
+
+
+
+
+
+client.connections.clients.get(id) -> SyncPagingIterable<ConnectionEnabledClient>
+
+
+
+#### π Usage
+
+
+
+from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.
+
+
+
+#### βοΈ Parameters
+
+
+
+
+
+
+
+
+
+
+
+
@@ -24164,26 +24552,11 @@ client.organizations().clientGrants().delete("id", "grant_id");
-client.organizations.discoveryDomains.list(id) -> SyncPagingIterable<OrganizationDiscoveryDomain>
-
-
-
-
#### π Usage
client.organizations.connections.list(id) -> SyncPagingIterable<OrganizationAllConnectionPost>
-
@@ -24193,16 +24566,22 @@ This endpoint is subject to eventual consistency; newly created, updated, or del
-
-
@@ -24227,7 +24606,7 @@ client.organizations().discoveryDomains().list(
@@ -24235,36 +24614,38 @@ client.organizations().discoveryDomains().list(
-client.organizations.discoveryDomains.create(id, request) -> CreateOrganizationDiscoveryDomainResponseContent
+
+
+
+
-
+client.organizations.connections.create(id, request) -> CreateOrganizationAllConnectionResponseContent
+
@@ -24274,11 +24655,11 @@ Create a new discovery domain for an organization.
+
@@ -24303,7 +24684,7 @@ client.organizations().discoveryDomains().create(
@@ -24311,7 +24692,7 @@ client.organizations().discoveryDomains().create(
@@ -24319,36 +24700,53 @@ client.organizations().discoveryDomains().create(
-
+
-client.organizations.discoveryDomains.getByName(id, discoveryDomain) -> GetOrganizationDiscoveryDomainByNameResponseContent
+
+
+
+
+client.organizations.connections.get(id, connectionId) -> GetOrganizationAllConnectionResponseContent
+
@@ -24374,7 +24772,7 @@ client.organizations().discoveryDomains().getByName("id", "discovery_domain");
@@ -24382,7 +24780,7 @@ client.organizations().discoveryDomains().getByName("id", "discovery_domain");
@@ -24394,11 +24792,11 @@ client.organizations().discoveryDomains().getByName("id", "discovery_domain");
+client.organizations.discoveryDomains.get(id, discoveryDomainId) -> GetOrganizationDiscoveryDomainResponseContentclient.organizations.connections.delete(id, connectionId)
+
-#### π Usage
+#### βοΈ Parameters
+
+
+
+
+
+
+
+client.organizations.connections.update(id, connectionId, request) -> UpdateOrganizationAllConnectionResponseContent
+
+
+
+
+#### βοΈ Parameters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+client.organizations.discoveryDomains.list(id) -> SyncPagingIterable<OrganizationDiscoveryDomain>
+
+
+
+
+#### π Usage
+
+
+
+
+
+
+#### βοΈ Parameters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+client.organizations.discoveryDomains.create(id, request) -> CreateOrganizationDiscoveryDomainResponseContent
+
+
+
+
+#### π Usage
+
+
+
+
+
+
+#### βοΈ Parameters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+client.organizations.discoveryDomains.getByName(id, discoveryDomain) -> GetOrganizationDiscoveryDomainByNameResponseContent
+
+
+
+
+#### π Usage
+
+
+
+
+
+
+#### βοΈ Parameters
+
+
+
+
+
+
+
+
+
+
+
+
+
+client.organizations.discoveryDomains.get(id, discoveryDomainId) -> GetOrganizationDiscoveryDomainResponseContent
+
+
+
+
+
+#### π Usage
+
+
+
+
+
+
+
@@ -27903,6 +28689,14 @@ See https://auth0.com/docs/secure/security-guidance/measures-against-app-imperso
+
+
+
+
+
+
diff --git a/src/main/java/com/auth0/client/mgmt/AsyncLogStreamsClient.java b/src/main/java/com/auth0/client/mgmt/AsyncLogStreamsClient.java
index d7e08394c..e9efbade2 100644
--- a/src/main/java/com/auth0/client/mgmt/AsyncLogStreamsClient.java
+++ b/src/main/java/com/auth0/client/mgmt/AsyncLogStreamsClient.java
@@ -33,71 +33,73 @@ public AsyncRawLogStreamsClient withRawResponse() {
/**
* Retrieve details on log streams.
- * Sample Response
[{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
+ * [{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
* }, {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "eventgrid",
- * "status": "active|paused|suspended",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventgrid",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }]
[{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
+ * Sample Response
+ * [{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
* }, {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "eventgrid",
- * "status": "active|paused|suspended",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventgrid",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }]
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }]
+ *
*/
public CompletableFuturetype of log stream being created determines the properties required in the sink payload.
- * http Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "http",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * eventbridge Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventbridge",
- * "sink": {
- * "awsRegion": "string",
- * "awsAccountId": "string"
- * }
- * }
- * The response will include an additional field awsPartnerEventSource in the sink: {
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * }
- * Azure Event Grid Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventgrid",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
- * }
- * Datadog Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "datadog",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Splunk Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "splunk",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Sumo Logic Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "sumo",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
+ * Log Stream Types
+ *The type of log stream being created determines the properties required in the sink payload.
HTTP Stream
+ *For an http Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "http",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Amazon EventBridge Stream
+ *For an eventbridge Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventbridge",
+ * "sink": {
+ * "awsRegion": "string",
+ * "awsAccountId": "string"
+ * }
+ * }
+ *
+ * The response will include an additional field awsPartnerEventSource in the sink:
Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * Azure Event Grid Stream
+ *For an Azure Event Grid Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventgrid",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
+ * }
+ *
+ * Datadog Stream
+ *For a Datadog Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "datadog",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Splunk Stream
+ *For a Splunk Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "splunk",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Stream
+ *For a Sumo Logic Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "sumo",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
*/
public CompletableFuturetype of log stream being created determines the properties required in the sink payload.
- * http Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "http",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * eventbridge Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventbridge",
- * "sink": {
- * "awsRegion": "string",
- * "awsAccountId": "string"
- * }
- * }
- * The response will include an additional field awsPartnerEventSource in the sink: {
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * }
- * Azure Event Grid Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventgrid",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
- * }
- * Datadog Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "datadog",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Splunk Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "splunk",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Sumo Logic Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "sumo",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
+ * Log Stream Types
+ *The type of log stream being created determines the properties required in the sink payload.
HTTP Stream
+ *For an http Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "http",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Amazon EventBridge Stream
+ *For an eventbridge Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventbridge",
+ * "sink": {
+ * "awsRegion": "string",
+ * "awsAccountId": "string"
+ * }
+ * }
+ *
+ * The response will include an additional field awsPartnerEventSource in the sink:
Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * Azure Event Grid Stream
+ *For an Azure Event Grid Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventgrid",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
+ * }
+ *
+ * Datadog Stream
+ *For a Datadog Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "datadog",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Splunk Stream
+ *For a Splunk Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "splunk",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Stream
+ *For a Sumo Logic Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "sumo",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
*/
public CompletableFuture{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
Request: {
+ * Sample responses
+ * Amazon EventBridge Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * HTTP Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Datadog Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Mixpanel
+ * Request:
+ * {
+ * "name": "string",
+ * "type": "mixpanel",
+ * "sink": {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Response:
+ * {
+ * "id": "string",
* "name": "string",
* "type": "mixpanel",
+ * "status": "active",
* "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string"
- * }
- * }
- *
- *
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "mixpanel",
- * "status": "active",
- * "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
- * }
- * }
- *
- * Segment
- *
- * Request: {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Segment
+ * Request:
+ * {
* "name": "string",
* "type": "segment",
* "sink": {
- * "segmentWriteKey": "string"
+ * "segmentWriteKey": "string"
* }
- * }
- *
- * Response: {
+ * }
+ *
+ * Response:
+ * {
* "id": "string",
* "name": "string",
* "type": "segment",
* "status": "active",
* "sink": {
- * "segmentWriteKey": "string"
- * }
- * }
- *
- * Splunk Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
Sumo Logic Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
Status
The status of a log stream maybe any of the following:
- * 1. active - Stream is currently enabled.
- * 2. paused - Stream is currently user disabled and will not attempt log delivery.
- * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
+ * "segmentWriteKey": "string"
+ * }
+ * }
+ *
+ * Splunk Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Status
+ *The status of a log stream maybe any of the following:
active - Stream is currently enabled.paused - Stream is currently user disabled and will not attempt log delivery.suspended - Stream is currently disabled because of errors and will not attempt log delivery.{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
Request: {
+ * Sample responses
+ * Amazon EventBridge Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * HTTP Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Datadog Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Mixpanel
+ * Request:
+ * {
* "name": "string",
* "type": "mixpanel",
* "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string"
- * }
- * }
- *
- *
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "mixpanel",
- * "status": "active",
- * "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
- * }
- * }
- *
- * Segment
- *
- * Request: {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Response:
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "mixpanel",
+ * "status": "active",
+ * "sink": {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Segment
+ * Request:
+ * {
* "name": "string",
* "type": "segment",
* "sink": {
- * "segmentWriteKey": "string"
+ * "segmentWriteKey": "string"
* }
- * }
- *
- * Response: {
+ * }
+ *
+ * Response:
+ * {
* "id": "string",
* "name": "string",
* "type": "segment",
* "status": "active",
* "sink": {
- * "segmentWriteKey": "string"
- * }
- * }
- *
- * Splunk Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
Sumo Logic Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
Status
The status of a log stream maybe any of the following:
- * 1. active - Stream is currently enabled.
- * 2. paused - Stream is currently user disabled and will not attempt log delivery.
- * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
+ * "segmentWriteKey": "string"
+ * }
+ * }
+ *
+ * Splunk Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Status
+ *The status of a log stream maybe any of the following:
active - Stream is currently enabled.paused - Stream is currently user disabled and will not attempt log delivery.suspended - Stream is currently disabled because of errors and will not attempt log delivery.eventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public CompletableFutureeventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public CompletableFutureeventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public CompletableFutureeventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public CompletableFuture[{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
+ * Sample Response
+ * [{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
* }, {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "eventgrid",
- * "status": "active|paused|suspended",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventgrid",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }]
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }]
+ *
*/
public CompletableFuture[{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
+ * Sample Response
+ * [{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
* }, {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "eventgrid",
- * "status": "active|paused|suspended",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventgrid",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }]
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }]
+ *
*/
public CompletableFuturetype of log stream being created determines the properties required in the sink payload.
- * http Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "http",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * eventbridge Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventbridge",
- * "sink": {
- * "awsRegion": "string",
- * "awsAccountId": "string"
- * }
- * }
- * The response will include an additional field awsPartnerEventSource in the sink: {
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * }
- * Azure Event Grid Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventgrid",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
- * }
- * Datadog Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "datadog",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Splunk Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "splunk",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Sumo Logic Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "sumo",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
+ * Log Stream Types
+ *The type of log stream being created determines the properties required in the sink payload.
HTTP Stream
+ *For an http Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "http",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Amazon EventBridge Stream
+ *For an eventbridge Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventbridge",
+ * "sink": {
+ * "awsRegion": "string",
+ * "awsAccountId": "string"
+ * }
+ * }
+ *
+ * The response will include an additional field awsPartnerEventSource in the sink:
Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * Azure Event Grid Stream
+ *For an Azure Event Grid Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventgrid",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
+ * }
+ *
+ * Datadog Stream
+ *For a Datadog Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "datadog",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Splunk Stream
+ *For a Splunk Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "splunk",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Stream
+ *For a Sumo Logic Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "sumo",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
*/
public CompletableFuturetype of log stream being created determines the properties required in the sink payload.
- * http Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "http",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * eventbridge Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventbridge",
- * "sink": {
- * "awsRegion": "string",
- * "awsAccountId": "string"
- * }
- * }
- * The response will include an additional field awsPartnerEventSource in the sink: {
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * }
- * Azure Event Grid Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventgrid",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
- * }
- * Datadog Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "datadog",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Splunk Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "splunk",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Sumo Logic Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "sumo",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
+ * Log Stream Types
+ *The type of log stream being created determines the properties required in the sink payload.
HTTP Stream
+ *For an http Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "http",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Amazon EventBridge Stream
+ *For an eventbridge Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventbridge",
+ * "sink": {
+ * "awsRegion": "string",
+ * "awsAccountId": "string"
+ * }
+ * }
+ *
+ * The response will include an additional field awsPartnerEventSource in the sink:
Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * Azure Event Grid Stream
+ *For an Azure Event Grid Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventgrid",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
+ * }
+ *
+ * Datadog Stream
+ *For a Datadog Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "datadog",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Splunk Stream
+ *For a Splunk Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "splunk",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Stream
+ *For a Sumo Logic Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "sumo",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
*/
public CompletableFuture{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
Request: {
+ * Sample responses
+ * Amazon EventBridge Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * HTTP Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Datadog Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Mixpanel
+ * Request:
+ * {
+ * "name": "string",
+ * "type": "mixpanel",
+ * "sink": {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Response:
+ * {
+ * "id": "string",
* "name": "string",
* "type": "mixpanel",
+ * "status": "active",
* "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string"
- * }
- * }
- *
- *
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "mixpanel",
- * "status": "active",
- * "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
- * }
- * }
- *
- * Segment
- *
- * Request: {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Segment
+ * Request:
+ * {
* "name": "string",
* "type": "segment",
* "sink": {
- * "segmentWriteKey": "string"
+ * "segmentWriteKey": "string"
* }
- * }
- *
- * Response: {
+ * }
+ *
+ * Response:
+ * {
* "id": "string",
* "name": "string",
* "type": "segment",
* "status": "active",
* "sink": {
- * "segmentWriteKey": "string"
- * }
- * }
- *
- * Splunk Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
Sumo Logic Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
Status
The status of a log stream maybe any of the following:
- * 1. active - Stream is currently enabled.
- * 2. paused - Stream is currently user disabled and will not attempt log delivery.
- * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
+ * "segmentWriteKey": "string"
+ * }
+ * }
+ *
+ * Splunk Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Status
+ *The status of a log stream maybe any of the following:
active - Stream is currently enabled.paused - Stream is currently user disabled and will not attempt log delivery.suspended - Stream is currently disabled because of errors and will not attempt log delivery.{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
Request: {
+ * Sample responses
+ * Amazon EventBridge Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * HTTP Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Datadog Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Mixpanel
+ * Request:
+ * {
* "name": "string",
* "type": "mixpanel",
* "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string"
- * }
- * }
- *
- *
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "mixpanel",
- * "status": "active",
- * "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
- * }
- * }
- *
- * Segment
- *
- * Request: {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Response:
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "mixpanel",
+ * "status": "active",
+ * "sink": {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Segment
+ * Request:
+ * {
* "name": "string",
* "type": "segment",
* "sink": {
- * "segmentWriteKey": "string"
+ * "segmentWriteKey": "string"
* }
- * }
- *
- * Response: {
+ * }
+ *
+ * Response:
+ * {
* "id": "string",
* "name": "string",
* "type": "segment",
* "status": "active",
* "sink": {
- * "segmentWriteKey": "string"
- * }
- * }
- *
- * Splunk Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
Sumo Logic Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
Status
The status of a log stream maybe any of the following:
- * 1. active - Stream is currently enabled.
- * 2. paused - Stream is currently user disabled and will not attempt log delivery.
- * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
+ * "segmentWriteKey": "string"
+ * }
+ * }
+ *
+ * Splunk Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Status
+ *The status of a log stream maybe any of the following:
active - Stream is currently enabled.paused - Stream is currently user disabled and will not attempt log delivery.suspended - Stream is currently disabled because of errors and will not attempt log delivery.eventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public CompletableFutureeventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public CompletableFutureeventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public CompletableFutureeventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public CompletableFuture[{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
+ * Sample Response
+ * [{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
* }, {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "eventgrid",
- * "status": "active|paused|suspended",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventgrid",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }]
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }]
+ *
*/
public List[{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
+ * Sample Response
+ * [{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
* }, {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "eventgrid",
- * "status": "active|paused|suspended",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventgrid",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }]
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }]
+ *
*/
public Listtype of log stream being created determines the properties required in the sink payload.
- * http Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "http",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * eventbridge Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventbridge",
- * "sink": {
- * "awsRegion": "string",
- * "awsAccountId": "string"
- * }
- * }
- * The response will include an additional field awsPartnerEventSource in the sink: {
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * }
- * Azure Event Grid Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventgrid",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
- * }
- * Datadog Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "datadog",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Splunk Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "splunk",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Sumo Logic Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "sumo",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
+ * Log Stream Types
+ *The type of log stream being created determines the properties required in the sink payload.
HTTP Stream
+ *For an http Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "http",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Amazon EventBridge Stream
+ *For an eventbridge Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventbridge",
+ * "sink": {
+ * "awsRegion": "string",
+ * "awsAccountId": "string"
+ * }
+ * }
+ *
+ * The response will include an additional field awsPartnerEventSource in the sink:
Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * Azure Event Grid Stream
+ *For an Azure Event Grid Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventgrid",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
+ * }
+ *
+ * Datadog Stream
+ *For a Datadog Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "datadog",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Splunk Stream
+ *For a Splunk Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "splunk",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Stream
+ *For a Sumo Logic Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "sumo",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
*/
public CreateLogStreamResponseContent create(CreateLogStreamRequestContent request) {
return this.rawClient.create(request).body();
@@ -308,131 +344,163 @@ public CreateLogStreamResponseContent create(CreateLogStreamRequestContent reque
/**
* Create a log stream.
- * type of log stream being created determines the properties required in the sink payload.
- * http Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "http",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * eventbridge Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventbridge",
- * "sink": {
- * "awsRegion": "string",
- * "awsAccountId": "string"
- * }
- * }
- * The response will include an additional field awsPartnerEventSource in the sink: {
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * }
- * Azure Event Grid Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventgrid",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
- * }
- * Datadog Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "datadog",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Splunk Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "splunk",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Sumo Logic Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "sumo",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
+ * Log Stream Types
+ *The type of log stream being created determines the properties required in the sink payload.
HTTP Stream
+ *For an http Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "http",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Amazon EventBridge Stream
+ *For an eventbridge Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventbridge",
+ * "sink": {
+ * "awsRegion": "string",
+ * "awsAccountId": "string"
+ * }
+ * }
+ *
+ * The response will include an additional field awsPartnerEventSource in the sink:
Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * Azure Event Grid Stream
+ *For an Azure Event Grid Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventgrid",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
+ * }
+ *
+ * Datadog Stream
+ *For a Datadog Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "datadog",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Splunk Stream
+ *For a Splunk Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "splunk",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Stream
+ *For a Sumo Logic Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "sumo",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
*/
public CreateLogStreamResponseContent create(CreateLogStreamRequestContent request, RequestOptions requestOptions) {
return this.rawClient.create(request, requestOptions).body();
@@ -440,105 +508,126 @@ public CreateLogStreamResponseContent create(CreateLogStreamRequestContent reque
/**
* Retrieve a log stream configuration and status.
- * {
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
Request: {
+ * Sample responses
+ * Amazon EventBridge Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * HTTP Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Datadog Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Mixpanel
+ * Request:
+ * {
+ * "name": "string",
+ * "type": "mixpanel",
+ * "sink": {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Response:
+ * {
+ * "id": "string",
* "name": "string",
* "type": "mixpanel",
+ * "status": "active",
* "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string"
- * }
- * }
- *
- *
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "mixpanel",
- * "status": "active",
- * "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
- * }
- * }
- *
- * Segment
- *
- * Request: {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Segment
+ * Request:
+ * {
* "name": "string",
* "type": "segment",
* "sink": {
- * "segmentWriteKey": "string"
+ * "segmentWriteKey": "string"
* }
- * }
- *
- * Response: {
+ * }
+ *
+ * Response:
+ * {
* "id": "string",
* "name": "string",
* "type": "segment",
* "status": "active",
* "sink": {
- * "segmentWriteKey": "string"
- * }
- * }
- *
- * Splunk Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
Sumo Logic Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
Status
The status of a log stream maybe any of the following:
- * 1. active - Stream is currently enabled.
- * 2. paused - Stream is currently user disabled and will not attempt log delivery.
- * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
+ * "segmentWriteKey": "string"
+ * }
+ * }
+ *
+ * Splunk Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Status
+ *The status of a log stream maybe any of the following:
active - Stream is currently enabled.paused - Stream is currently user disabled and will not attempt log delivery.suspended - Stream is currently disabled because of errors and will not attempt log delivery.{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
Request: {
+ * Sample responses
+ * Amazon EventBridge Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * HTTP Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Datadog Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Mixpanel
+ * Request:
+ * {
* "name": "string",
* "type": "mixpanel",
* "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string"
- * }
- * }
- *
- *
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "mixpanel",
- * "status": "active",
- * "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
- * }
- * }
- *
- * Segment
- *
- * Request: {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Response:
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "mixpanel",
+ * "status": "active",
+ * "sink": {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Segment
+ * Request:
+ * {
* "name": "string",
* "type": "segment",
* "sink": {
- * "segmentWriteKey": "string"
+ * "segmentWriteKey": "string"
* }
- * }
- *
- * Response: {
+ * }
+ *
+ * Response:
+ * {
* "id": "string",
* "name": "string",
* "type": "segment",
* "status": "active",
* "sink": {
- * "segmentWriteKey": "string"
- * }
- * }
- *
- * Splunk Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
Sumo Logic Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
Status
The status of a log stream maybe any of the following:
- * 1. active - Stream is currently enabled.
- * 2. paused - Stream is currently user disabled and will not attempt log delivery.
- * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
+ * "segmentWriteKey": "string"
+ * }
+ * }
+ *
+ * Splunk Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Status
+ *The status of a log stream maybe any of the following:
active - Stream is currently enabled.paused - Stream is currently user disabled and will not attempt log delivery.suspended - Stream is currently disabled because of errors and will not attempt log delivery.eventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public UpdateLogStreamResponseContent update(String id) {
return this.rawClient.update(id).body();
@@ -707,40 +836,59 @@ public UpdateLogStreamResponseContent update(String id) {
/**
* Update a log stream.
- * eventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public UpdateLogStreamResponseContent update(String id, RequestOptions requestOptions) {
return this.rawClient.update(id, requestOptions).body();
@@ -748,40 +896,59 @@ public UpdateLogStreamResponseContent update(String id, RequestOptions requestOp
/**
* Update a log stream.
- * eventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public UpdateLogStreamResponseContent update(String id, UpdateLogStreamRequestContent request) {
return this.rawClient.update(id, request).body();
@@ -789,40 +956,59 @@ public UpdateLogStreamResponseContent update(String id, UpdateLogStreamRequestCo
/**
* Update a log stream.
- * eventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public UpdateLogStreamResponseContent update(
String id, UpdateLogStreamRequestContent request, RequestOptions requestOptions) {
diff --git a/src/main/java/com/auth0/client/mgmt/OrganizationsClient.java b/src/main/java/com/auth0/client/mgmt/OrganizationsClient.java
index 5a1782ab5..e81225f71 100644
--- a/src/main/java/com/auth0/client/mgmt/OrganizationsClient.java
+++ b/src/main/java/com/auth0/client/mgmt/OrganizationsClient.java
@@ -8,6 +8,7 @@
import com.auth0.client.mgmt.core.Suppliers;
import com.auth0.client.mgmt.core.SyncPagingIterable;
import com.auth0.client.mgmt.organizations.ClientGrantsClient;
+import com.auth0.client.mgmt.organizations.ConnectionsClient;
import com.auth0.client.mgmt.organizations.DiscoveryDomainsClient;
import com.auth0.client.mgmt.organizations.EnabledConnectionsClient;
import com.auth0.client.mgmt.organizations.InvitationsClient;
@@ -29,6 +30,8 @@ public class OrganizationsClient {
protected final Supplier[{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
+ * Sample Response
+ * [{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
* }, {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "eventgrid",
- * "status": "active|paused|suspended",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventgrid",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }]
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }]
+ *
*/
public ManagementApiHttpResponse[{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
+ * Sample Response
+ * [{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
* }, {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "eventgrid",
- * "status": "active|paused|suspended",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventgrid",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
* },
* {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }]
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }]
+ *
*/
public ManagementApiHttpResponsetype of log stream being created determines the properties required in the sink payload.
- * http Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "http",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * eventbridge Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventbridge",
- * "sink": {
- * "awsRegion": "string",
- * "awsAccountId": "string"
- * }
- * }
- * The response will include an additional field awsPartnerEventSource in the sink: {
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * }
- * Azure Event Grid Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventgrid",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
- * }
- * Datadog Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "datadog",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Splunk Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "splunk",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Sumo Logic Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "sumo",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
+ * Log Stream Types
+ *The type of log stream being created determines the properties required in the sink payload.
HTTP Stream
+ *For an http Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "http",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Amazon EventBridge Stream
+ *For an eventbridge Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventbridge",
+ * "sink": {
+ * "awsRegion": "string",
+ * "awsAccountId": "string"
+ * }
+ * }
+ *
+ * The response will include an additional field awsPartnerEventSource in the sink:
Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * Azure Event Grid Stream
+ *For an Azure Event Grid Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventgrid",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
+ * }
+ *
+ * Datadog Stream
+ *For a Datadog Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "datadog",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Splunk Stream
+ *For a Splunk Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "splunk",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Stream
+ *For a Sumo Logic Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "sumo",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
*/
public ManagementApiHttpResponsetype of log stream being created determines the properties required in the sink payload.
- * http Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "http",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "httpEndpoint": "string",
- * "httpContentType": "string",
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpAuthorization": "string"
- * }
- * }
- * eventbridge Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventbridge",
- * "sink": {
- * "awsRegion": "string",
- * "awsAccountId": "string"
- * }
- * }
- * The response will include an additional field awsPartnerEventSource in the sink: {
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * }
- * Azure Event Grid Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "eventgrid",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active",
- * "sink": {
- * "azureSubscriptionId": "string",
- * "azureResourceGroup": "string",
- * "azureRegion": "string",
- * "azurePartnerTopic": "string"
- * }
- * }
- * Datadog Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "datadog",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
- * Splunk Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "splunk",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
- * Sumo Logic Stream, the sink properties are listed in the payload below
- * Request: {
- * "name": "string",
- * "type": "sumo",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
+ * Log Stream Types
+ *The type of log stream being created determines the properties required in the sink payload.
HTTP Stream
+ *For an http Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "http",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "httpEndpoint": "string",
+ * "httpContentType": "string",
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Amazon EventBridge Stream
+ *For an eventbridge Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventbridge",
+ * "sink": {
+ * "awsRegion": "string",
+ * "awsAccountId": "string"
+ * }
+ * }
+ *
+ * The response will include an additional field awsPartnerEventSource in the sink:
Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * Azure Event Grid Stream
+ *For an Azure Event Grid Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "eventgrid",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active",
+ * "sink": {
+ * "azureSubscriptionId": "string",
+ * "azureResourceGroup": "string",
+ * "azureRegion": "string",
+ * "azurePartnerTopic": "string"
+ * }
+ * }
+ *
+ * Datadog Stream
+ *For a Datadog Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "datadog",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Splunk Stream
+ *For a Splunk Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "splunk",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Stream
+ *For a Sumo Logic Stream, the sink properties are listed in the payload below.
Request:
+ *{
+ * "name": "string",
+ * "type": "sumo",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Response:
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
*/
public ManagementApiHttpResponse{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
Request: {
+ * Sample responses
+ * Amazon EventBridge Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * HTTP Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Datadog Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Mixpanel
+ * Request:
+ * {
+ * "name": "string",
+ * "type": "mixpanel",
+ * "sink": {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Response:
+ * {
+ * "id": "string",
* "name": "string",
* "type": "mixpanel",
+ * "status": "active",
* "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string"
- * }
- * }
- *
- *
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "mixpanel",
- * "status": "active",
- * "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
- * }
- * }
- *
- * Segment
- *
- * Request: {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Segment
+ * Request:
+ * {
* "name": "string",
* "type": "segment",
* "sink": {
- * "segmentWriteKey": "string"
+ * "segmentWriteKey": "string"
* }
- * }
- *
- * Response: {
+ * }
+ *
+ * Response:
+ * {
* "id": "string",
* "name": "string",
* "type": "segment",
* "status": "active",
* "sink": {
- * "segmentWriteKey": "string"
- * }
- * }
- *
- * Splunk Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
Sumo Logic Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
Status
The status of a log stream maybe any of the following:
- * 1. active - Stream is currently enabled.
- * 2. paused - Stream is currently user disabled and will not attempt log delivery.
- * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
+ * "segmentWriteKey": "string"
+ * }
+ * }
+ *
+ * Splunk Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Status
+ *The status of a log stream maybe any of the following:
active - Stream is currently enabled.paused - Stream is currently user disabled and will not attempt log delivery.suspended - Stream is currently disabled because of errors and will not attempt log delivery.{
- * "id": "string",
- * "name": "string",
- * "type": "eventbridge",
- * "status": "active|paused|suspended",
- * "sink": {
- * "awsAccountId": "string",
- * "awsRegion": "string",
- * "awsPartnerEventSource": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "http",
- * "status": "active|paused|suspended",
- * "sink": {
- * "httpContentFormat": "JSONLINES|JSONARRAY",
- * "httpContentType": "string",
- * "httpEndpoint": "string",
- * "httpAuthorization": "string"
- * }
- * } {
- * "id": "string",
- * "name": "string",
- * "type": "datadog",
- * "status": "active|paused|suspended",
- * "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
- * }
- * }
Request: {
+ * Sample responses
+ * Amazon EventBridge Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "eventbridge",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "awsAccountId": "string",
+ * "awsRegion": "string",
+ * "awsPartnerEventSource": "string"
+ * }
+ * }
+ *
+ * HTTP Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "http",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
+ * "httpContentType": "string",
+ * "httpEndpoint": "string",
+ * "httpAuthorization": "string"
+ * }
+ * }
+ *
+ * Datadog Log Stream
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "datadog",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
+ * }
+ * }
+ *
+ * Mixpanel
+ * Request:
+ * {
* "name": "string",
* "type": "mixpanel",
* "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string"
- * }
- * }
- *
- *
- * Response: {
- * "id": "string",
- * "name": "string",
- * "type": "mixpanel",
- * "status": "active",
- * "sink": {
- * "mixpanelRegion": "string", // "us" | "eu",
- * "mixpanelProjectId": "string",
- * "mixpanelServiceAccountUsername": "string",
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
- * }
- * }
- *
- * Segment
- *
- * Request: {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Response:
+ * {
+ * "id": "string",
+ * "name": "string",
+ * "type": "mixpanel",
+ * "status": "active",
+ * "sink": {
+ * "mixpanelRegion": "string",
+ * "mixpanelProjectId": "string",
+ * "mixpanelServiceAccountUsername": "string",
+ * "mixpanelServiceAccountPassword": "string"
+ * }
+ * }
+ *
+ * Segment
+ * Request:
+ * {
* "name": "string",
* "type": "segment",
* "sink": {
- * "segmentWriteKey": "string"
+ * "segmentWriteKey": "string"
* }
- * }
- *
- * Response: {
+ * }
+ *
+ * Response:
+ * {
* "id": "string",
* "name": "string",
* "type": "segment",
* "status": "active",
* "sink": {
- * "segmentWriteKey": "string"
- * }
- * }
- *
- * Splunk Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "splunk",
- * "status": "active|paused|suspended",
- * "sink": {
- * "splunkDomain": "string",
- * "splunkToken": "string",
- * "splunkPort": "string",
- * "splunkSecure": "boolean"
- * }
- * }
Sumo Logic Log Stream
{
- * "id": "string",
- * "name": "string",
- * "type": "sumo",
- * "status": "active|paused|suspended",
- * "sink": {
- * "sumoSourceAddress": "string",
- * }
- * }
Status
The status of a log stream maybe any of the following:
- * 1. active - Stream is currently enabled.
- * 2. paused - Stream is currently user disabled and will not attempt log delivery.
- * 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
+ * "segmentWriteKey": "string"
+ * }
+ * }
+ *
+ * Splunk Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "splunk",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "splunkDomain": "string",
+ * "splunkToken": "string",
+ * "splunkPort": "string",
+ * "splunkSecure": "boolean"
+ * }
+ * }
+ *
+ * Sumo Logic Log Stream
+ *{
+ * "id": "string",
+ * "name": "string",
+ * "type": "sumo",
+ * "status": "active|paused|suspended",
+ * "sink": {
+ * "sumoSourceAddress": "string"
+ * }
+ * }
+ *
+ * Status
+ *The status of a log stream maybe any of the following:
active - Stream is currently enabled.paused - Stream is currently user disabled and will not attempt log delivery.suspended - Stream is currently disabled because of errors and will not attempt log delivery.eventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public ManagementApiHttpResponseeventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public ManagementApiHttpResponseeventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public ManagementApiHttpResponseeventbridge and eventgrid, updating the sink is not permitted.
- * {
- * "status": "active|paused"
- * }
- * {
- * "name": "string"
- * }
- * http{
+ * Examples of how to use the PATCH endpoint.
+ * The following fields may be updated in a PATCH operation:
+ *
+ * - name
+ * - status
+ * - sink
+ *
+ * Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
+ * Update the status of a log stream
+ * {
+ * "status": "active|paused"
+ * }
+ *
+ * Update the name of a log stream
+ * {
+ * "name": "string"
+ * }
+ *
+ * Update the sink properties of a stream of type http
+ * {
* "sink": {
* "httpEndpoint": "string",
* "httpContentType": "string",
* "httpContentFormat": "JSONARRAY|JSONLINES",
* "httpAuthorization": "string"
* }
- * }
- * Update the sink properties of a stream of type datadog
{
+ * }
+ *
+ * Update the sink properties of a stream of type datadog
+ * {
* "sink": {
- * "datadogRegion": "string",
- * "datadogApiKey": "string"
+ * "datadogRegion": "string",
+ * "datadogApiKey": "string"
* }
- * }
- * Update the sink properties of a stream of type splunk
{
+ * }
+ *
+ * Update the sink properties of a stream of type splunk
+ * {
* "sink": {
* "splunkDomain": "string",
* "splunkToken": "string",
* "splunkPort": "string",
* "splunkSecure": "boolean"
* }
- * }
- * Update the sink properties of a stream of type sumo
{
+ * }
+ *
+ * Update the sink properties of a stream of type sumo
+ * {
* "sink": {
* "sumoSourceAddress": "string"
* }
- * }
+ * }
+ *
*/
public ManagementApiHttpResponseOptional Id from which to start selection.
+ */ + @JsonSetter(value = "from", nulls = Nulls.SKIP) + public Builder from(@Nullable OptionalNullableNumber of results per page. Defaults to 50.
+ */ + @JsonSetter(value = "take", nulls = Nulls.SKIP) + public Builder take(OptionalNullableArray of Google Workspace Directory group objects to synchronize.
+ */ + @JsonSetter(value = "groups", nulls = Nulls.SKIP) + public Builder groups(ListConnection identifier.
+ */ + _FinalStage connectionId(@NotNull String connectionId); + + Builder from(CreateOrganizationAllConnectionRequestParameters other); + } + + public interface _FinalStage { + CreateOrganizationAllConnectionRequestParameters build(); + + _FinalStage additionalProperty(String key, Object value); + + _FinalStage additionalProperties(MapName of the connection in the scope of this organization.
+ */ + _FinalStage organizationConnectionName(OptionalWhen true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection.
+ */ + _FinalStage assignMembershipOnLogin(OptionalDetermines whether a connection should be displayed on this organizationβs login prompt. Only applicable for enterprise connections. Default: true.
+ */ + _FinalStage showAsButton(OptionalDetermines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false.
+ */ + _FinalStage isSignupEnabled(OptionalWhether the connection is enabled for the organization.
+ */ + _FinalStage isEnabled(OptionalConnection identifier.
+ *Connection identifier.
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("connection_id") + public _FinalStage connectionId(@NotNull String connectionId) { + this.connectionId = Objects.requireNonNull(connectionId, "connectionId must not be null"); + return this; + } + + /** + *Whether the connection is enabled for the organization.
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage isEnabled(Boolean isEnabled) { + this.isEnabled = Optional.ofNullable(isEnabled); + return this; + } + + /** + *Whether the connection is enabled for the organization.
+ */ + @java.lang.Override + @JsonSetter(value = "is_enabled", nulls = Nulls.SKIP) + public _FinalStage isEnabled(OptionalDetermines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false.
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage isSignupEnabled(Boolean isSignupEnabled) { + this.isSignupEnabled = Optional.ofNullable(isSignupEnabled); + return this; + } + + /** + *Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false.
+ */ + @java.lang.Override + @JsonSetter(value = "is_signup_enabled", nulls = Nulls.SKIP) + public _FinalStage isSignupEnabled(OptionalDetermines whether a connection should be displayed on this organizationβs login prompt. Only applicable for enterprise connections. Default: true.
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage showAsButton(Boolean showAsButton) { + this.showAsButton = Optional.ofNullable(showAsButton); + return this; + } + + /** + *Determines whether a connection should be displayed on this organizationβs login prompt. Only applicable for enterprise connections. Default: true.
+ */ + @java.lang.Override + @JsonSetter(value = "show_as_button", nulls = Nulls.SKIP) + public _FinalStage showAsButton(OptionalWhen true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection.
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage assignMembershipOnLogin(Boolean assignMembershipOnLogin) { + this.assignMembershipOnLogin = Optional.ofNullable(assignMembershipOnLogin); + return this; + } + + /** + *When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection.
+ */ + @java.lang.Override + @JsonSetter(value = "assign_membership_on_login", nulls = Nulls.SKIP) + public _FinalStage assignMembershipOnLogin(OptionalName of the connection in the scope of this organization.
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage organizationConnectionName(String organizationConnectionName) { + this.organizationConnectionName = Optional.ofNullable(organizationConnectionName); + return this; + } + + /** + *Name of the connection in the scope of this organization.
+ */ + @java.lang.Override + @JsonSetter(value = "organization_connection_name", nulls = Nulls.SKIP) + public _FinalStage organizationConnectionName(OptionalPage index of the results to return. First page is 0.
+ */ + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public Builder page(OptionalNullableNumber of results per page. Defaults to 50.
+ */ + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public Builder perPage(OptionalNullableReturn results inside an object that contains the total result count (true) or as a direct array of results (false, default).
+ */ + @JsonSetter(value = "include_totals", nulls = Nulls.SKIP) + public Builder includeTotals(OptionalNullable