Skip to content

Add experiment protocol lifecycle operations #4454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dd-octo-sts wants to merge 1 commit into
base: master
Choose a base branch
from
+12,072 −346
Open

Add experiment protocol lifecycle operations #4454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,443 changes: 1,437 additions & 6 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

41 changes: 41 additions & 0 deletions examples/v2/experiments/ArchiveExperimentProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// Archive experiment protocol returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ExperimentsApi;
import com.datadog.api.client.v2.api.ExperimentsApi.ArchiveExperimentProtocolOptionalParameters;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolResponse;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

// there is a valid "experiment_protocol" in the system
String EXPERIMENT_PROTOCOL_DATA_ATTRIBUTES_UPDATED_AT =
System.getenv("EXPERIMENT_PROTOCOL_DATA_ATTRIBUTES_UPDATED_AT");
UUID EXPERIMENT_PROTOCOL_DATA_ID = null;
try {
EXPERIMENT_PROTOCOL_DATA_ID = UUID.fromString(System.getenv("EXPERIMENT_PROTOCOL_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

try {
ExperimentsPublicProtocolResponse result =
apiInstance.archiveExperimentProtocol(
EXPERIMENT_PROTOCOL_DATA_ID,
new ArchiveExperimentProtocolOptionalParameters()
.expectedUpdatedAt(EXPERIMENT_PROTOCOL_DATA_ATTRIBUTES_UPDATED_AT));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ExperimentsApi#archiveExperimentProtocol");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
39 changes: 39 additions & 0 deletions examples/v2/experiments/CreateExperimentProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Create experiment protocol returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ExperimentsApi;
import com.datadog.api.client.v2.model.ExperimentsCreateExperimentProtocolRequest;
import com.datadog.api.client.v2.model.ExperimentsCreateExperimentProtocolRequestData;
import com.datadog.api.client.v2.model.ExperimentsCreateExperimentProtocolRequestDataAttributes;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolResponse;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolResponseDataType;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

ExperimentsCreateExperimentProtocolRequest body =
new ExperimentsCreateExperimentProtocolRequest()
.data(
new ExperimentsCreateExperimentProtocolRequestData()
.type(ExperimentsPublicProtocolResponseDataType.PROTOCOLS)
.attributes(
new ExperimentsCreateExperimentProtocolRequestDataAttributes()
.name("ex-protocol-14bb9543f523edde")
.description("Protocol created by the API test.")));

try {
ExperimentsPublicProtocolResponse result = apiInstance.createExperimentProtocol(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ExperimentsApi#createExperimentProtocol");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
38 changes: 38 additions & 0 deletions examples/v2/experiments/DeleteExperimentProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Delete experiment protocol returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ExperimentsApi;
import com.datadog.api.client.v2.api.ExperimentsApi.DeleteExperimentProtocolOptionalParameters;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

// there is a valid "experiment_protocol" in the system
String EXPERIMENT_PROTOCOL_DATA_ATTRIBUTES_UPDATED_AT =
System.getenv("EXPERIMENT_PROTOCOL_DATA_ATTRIBUTES_UPDATED_AT");
UUID EXPERIMENT_PROTOCOL_DATA_ID = null;
try {
EXPERIMENT_PROTOCOL_DATA_ID = UUID.fromString(System.getenv("EXPERIMENT_PROTOCOL_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

try {
apiInstance.deleteExperimentProtocol(
EXPERIMENT_PROTOCOL_DATA_ID,
new DeleteExperimentProtocolOptionalParameters()
.expectedUpdatedAt(EXPERIMENT_PROTOCOL_DATA_ATTRIBUTES_UPDATED_AT));
} catch (ApiException e) {
System.err.println("Exception when calling ExperimentsApi#deleteExperimentProtocol");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
11 changes: 9 additions & 2 deletions examples/v2/experiments/GetExperimentProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,17 @@ public static void main(String[] args) {
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

// there is a valid "experiment_protocol" in the system
UUID EXPERIMENT_PROTOCOL_DATA_ID = null;
try {
EXPERIMENT_PROTOCOL_DATA_ID = UUID.fromString(System.getenv("EXPERIMENT_PROTOCOL_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

try {
ExperimentsPublicProtocolResponse result =
apiInstance.getExperimentProtocol(
UUID.fromString("550e8400-e29b-41d4-a716-446655440000"));
apiInstance.getExperimentProtocol(EXPERIMENT_PROTOCOL_DATA_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ExperimentsApi#getExperimentProtocol");
Expand Down
15 changes: 14 additions & 1 deletion examples/v2/experiments/ListExperimentProtocols.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,29 @@
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ExperimentsApi;
import com.datadog.api.client.v2.api.ExperimentsApi.ListExperimentProtocolsOptionalParameters;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolListResponseArray;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolResponseDataAttributesStatus;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

// there is a valid "experiment_protocol" in the system
String EXPERIMENT_PROTOCOL_DATA_ATTRIBUTES_NAME =
System.getenv("EXPERIMENT_PROTOCOL_DATA_ATTRIBUTES_NAME");

try {
ExperimentsPublicProtocolListResponseArray result = apiInstance.listExperimentProtocols();
ExperimentsPublicProtocolListResponseArray result =
apiInstance.listExperimentProtocols(
new ListExperimentProtocolsOptionalParameters()
.filterStatus(
Collections.singletonList(
ExperimentsPublicProtocolResponseDataAttributesStatus.DRAFT))
.filterQuery(EXPERIMENT_PROTOCOL_DATA_ATTRIBUTES_NAME));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ExperimentsApi#listExperimentProtocols");
Expand Down
49 changes: 49 additions & 0 deletions examples/v2/experiments/PatchExperimentProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// Update experiment protocol returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ExperimentsApi;
import com.datadog.api.client.v2.model.ExperimentsPatchExperimentProtocolRequest;
import com.datadog.api.client.v2.model.ExperimentsPatchExperimentProtocolRequestData;
import com.datadog.api.client.v2.model.ExperimentsPatchExperimentProtocolRequestDataAttributes;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolResponse;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolResponseDataType;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

// there is a valid "experiment_protocol" in the system
UUID EXPERIMENT_PROTOCOL_DATA_ID = null;
try {
EXPERIMENT_PROTOCOL_DATA_ID = UUID.fromString(System.getenv("EXPERIMENT_PROTOCOL_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

ExperimentsPatchExperimentProtocolRequest body =
new ExperimentsPatchExperimentProtocolRequest()
.data(
new ExperimentsPatchExperimentProtocolRequestData()
.type(ExperimentsPublicProtocolResponseDataType.PROTOCOLS)
.id(EXPERIMENT_PROTOCOL_DATA_ID)
.attributes(
new ExperimentsPatchExperimentProtocolRequestDataAttributes()
.description("Updated protocol description.")));

try {
ExperimentsPublicProtocolResponse result =
apiInstance.patchExperimentProtocol(EXPERIMENT_PROTOCOL_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ExperimentsApi#patchExperimentProtocol");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
36 changes: 36 additions & 0 deletions examples/v2/experiments/PublishExperimentProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Publish experiment protocol returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ExperimentsApi;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolResponse;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

// there is a valid "configured_experiment_protocol" in the system
UUID CONFIGURED_EXPERIMENT_PROTOCOL_DATA_ID = null;
try {
CONFIGURED_EXPERIMENT_PROTOCOL_DATA_ID =
UUID.fromString(System.getenv("CONFIGURED_EXPERIMENT_PROTOCOL_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

try {
ExperimentsPublicProtocolResponse result =
apiInstance.publishExperimentProtocol(CONFIGURED_EXPERIMENT_PROTOCOL_DATA_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ExperimentsApi#publishExperimentProtocol");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
70 changes: 70 additions & 0 deletions examples/v2/experiments/ReplaceExperimentProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
// Replace experiment protocol returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ExperimentsApi;
import com.datadog.api.client.v2.api.ExperimentsApi.ReplaceExperimentProtocolOptionalParameters;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolResponse;
import com.datadog.api.client.v2.model.ExperimentsPublicProtocolResponseDataType;
import com.datadog.api.client.v2.model.ExperimentsReplaceExperimentProtocolRequest;
import com.datadog.api.client.v2.model.ExperimentsReplaceExperimentProtocolRequestData;
import com.datadog.api.client.v2.model.ExperimentsReplaceExperimentProtocolRequestDataAttributes;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

// there is a valid "published_protocol" in the system
String PUBLISHED_PROTOCOL_DATA_ATTRIBUTES_UPDATED_AT =
System.getenv("PUBLISHED_PROTOCOL_DATA_ATTRIBUTES_UPDATED_AT");
UUID PUBLISHED_PROTOCOL_DATA_ID = null;
try {
PUBLISHED_PROTOCOL_DATA_ID = UUID.fromString(System.getenv("PUBLISHED_PROTOCOL_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

// there is a valid "experiment_subject_type" in the system
UUID EXPERIMENT_SUBJECT_TYPE_DATA_ID = null;
try {
EXPERIMENT_SUBJECT_TYPE_DATA_ID =
UUID.fromString(System.getenv("EXPERIMENT_SUBJECT_TYPE_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

ExperimentsReplaceExperimentProtocolRequest body =
new ExperimentsReplaceExperimentProtocolRequest()
.data(
new ExperimentsReplaceExperimentProtocolRequestData()
.type(ExperimentsPublicProtocolResponseDataType.PROTOCOLS)
.id(PUBLISHED_PROTOCOL_DATA_ID)
.attributes(
new ExperimentsReplaceExperimentProtocolRequestDataAttributes()
.subjectTypeId(EXPERIMENT_SUBJECT_TYPE_DATA_ID)
.isEqualSplitEnforced(false)
.isMinimumDurationEnabled(false)
.isDurationRequiredToStart(false)
.isMetricLimitEnabled(false)
.defaultDurationDays(14L)));

try {
ExperimentsPublicProtocolResponse result =
apiInstance.replaceExperimentProtocol(
PUBLISHED_PROTOCOL_DATA_ID,
body,
new ReplaceExperimentProtocolOptionalParameters()
.expectedUpdatedAt(PUBLISHED_PROTOCOL_DATA_ATTRIBUTES_UPDATED_AT));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ExperimentsApi#replaceExperimentProtocol");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading
Loading