Skip to content
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.

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

Javadoc sample code generated #15805

Merged
merged 36 commits into from
Oct 1, 2020
Merged
Show file tree
Hide file tree
Changes from 33 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
7441502
Adding snippets
azabbasi Sep 29, 2020
8762341
Create relationship snippets
azabbasi Sep 29, 2020
2d7a7be
CreateRelationshipWithResponse
azabbasi Sep 29, 2020
988ea05
getRelationship
azabbasi Sep 29, 2020
0f46359
Get relationship with response
azabbasi Sep 29, 2020
f569f39
Update relationship
azabbasi Sep 29, 2020
3f6efe0
updateRelationship with response
azabbasi Sep 29, 2020
c2cc8e3
delete relationship and delete relationship with response
azabbasi Sep 29, 2020
649d475
refactor
azabbasi Sep 29, 2020
fd586c1
listRelationship
azabbasi Sep 29, 2020
ab2a51f
list relationships
azabbasi Sep 29, 2020
d9aef12
list incoming relationships
azabbasi Sep 29, 2020
8314247
createModels
azabbasi Sep 29, 2020
7ea1356
getModel and geModel with response
azabbasi Sep 29, 2020
31ddfcb
list models
azabbasi Sep 29, 2020
8f987f7
decommission model
azabbasi Sep 29, 2020
2507a58
Delete models
azabbasi Sep 29, 2020
b7b7216
get components
azabbasi Sep 29, 2020
a20652a
Update components
azabbasi Sep 29, 2020
5d1ae08
create eventroute and query
azabbasi Sep 29, 2020
526a112
get event route
azabbasi Sep 29, 2020
35d410d
delete eventroute
azabbasi Sep 29, 2020
f8e9aa5
list event routes
azabbasi Sep 29, 2020
9e63b6f
telemetry scafold
azabbasi Sep 29, 2020
6ef288d
PublishTelemetry
azabbasi Sep 29, 2020
6773ae1
Publish component telemetry
azabbasi Sep 29, 2020
886393f
Format docs
azabbasi Sep 29, 2020
025933e
Update DigitalTwinsAsyncClient.java
azabbasi Sep 29, 2020
4da936f
Bring back API
azabbasi Sep 30, 2020
1577cef
Update README.md
azabbasi Sep 30, 2020
31e22cc
Update DigitalTwinsClientJavaDocCodeSnippets.java
azabbasi Sep 30, 2020
388013a
Update DigitalTwinsAsyncClient.java
azabbasi Sep 30, 2020
3faeb33
Move snippet codes to snippets package
azabbasi Sep 30, 2020
4d26509
update formatting
azabbasi Oct 1, 2020
b7b75d7
remove extra p tag
azabbasi Oct 1, 2020
b963dee
Update CodeSnippetBase.java
azabbasi Oct 1, 2020
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
2 changes: 1 addition & 1 deletion sdk/digitaltwins/azure-digitaltwins-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For the best development experience, developers should use the official Microsof
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-digitaltwins-core</artifactId>
<version>1.0.0-beta.1</version>
<version>1.0.0-beta.2</version>
</dependency>
```

Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
package com.azure.digitaltwins.core.models;

import com.azure.core.annotation.Fluent;
import com.azure.core.util.Context;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
* Defines an incoming relationship on a digital twin. Unlike outgoing relationships, incoming relationships have no user-defined
* properties when retrieved using {@link com.azure.digitaltwins.core.DigitalTwinsClient#listIncomingRelationships(String)}
* properties when retrieved using {@link com.azure.digitaltwins.core.DigitalTwinsClient#listIncomingRelationships(String, Context)}
* or {@link com.azure.digitaltwins.core.DigitalTwinsAsyncClient#listIncomingRelationships(String)}. Because of this, there is no
* need for user-defined types for deserialization. This class will capture the full service response when listing incoming relationships.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ public static void runRelationshipsSample() throws JsonProcessingException {
ConsoleLogger.printHeader("List incoming relationships");
// Get all incoming relationships in the graph where floorTwinId is the target of the relationship.

PagedIterable<IncomingRelationship> incomingRelationships = client.listIncomingRelationships(floorTwinId);
PagedIterable<IncomingRelationship> incomingRelationships = client.listIncomingRelationships(floorTwinId, Context.NONE);

for (IncomingRelationship incomingRelationship : incomingRelationships) {
ConsoleLogger.printSuccess("Found an incoming relationship: " + incomingRelationship.getRelationshipId() + " from: " + incomingRelationship.getSourceId());
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
package com.azure.digitaltwins.core.snippets;

public abstract class CodeSnippetBase {

//region DigitalTwinSnippets

azabbasi marked this conversation as resolved.
Show resolved Hide resolved
public abstract void createDigitalTwin();
public abstract void createDigitalTwinWithResponse();
public abstract void getDigitalTwin();
public abstract void getDigitalTwinWithResponse();
public abstract void updateDigitalTwin();
public abstract void updateDigitalTwinWithResponse();
public abstract void deleteDigitalTwin();
public abstract void deleteDigitalTwinWithResponse();

//endregion DigitalTwinSnippets

//region RelationshipSnippets
public abstract void createRelationship();
public abstract void createRelationshipWithResponse();
public abstract void getRelationship();
public abstract void getRelationshipWithResponse();
public abstract void updateRelationship();
public abstract void updateRelationshipWithResponse();
public abstract void deleteRelationship();
public abstract void deleteRelationshipWithResponse();
public abstract void listRelationships();
public abstract void listIncomingRelationships();
//endregion RelationshipSnippets

//region ModelsSnippets
public abstract void createModels();
public abstract void createModelsWithResponse();
public abstract void getModel();
public abstract void getModelWithResponse();
public abstract void listModels();
public abstract void decommissionModel();
public abstract void decommissionModelWithResponse();
public abstract void deleteModel();
public abstract void deleteModelWithResponse();
//endregion ModelsSnippets

//region ComponentSnippets
public abstract void getComponent();
public abstract void getComponentWithResponse();
public abstract void updateComponent();
public abstract void updateComponentWithResponse();
//endregion ComponentSnippets

//region ComponentSnippets
public abstract void query();
//endregion ComponentSnippets

//region EventRouteSnippets
public abstract void createEventRoute();
public abstract void createEventRouteWithResponse();
public abstract void getEventRoute();
public abstract void getEventRouteWithResponse();
public abstract void deleteEventRoute();
public abstract void deleteEventRouteWithResponse();
public abstract void listEventRoutes();
//endregion EventRouteSnippets

//region TelemetrySnippets
public abstract void publishTelemetry();
public abstract void publishTelemetryWithResponse();
public abstract void publishComponentTelemetry();
public abstract void publishComponentTelemetryWithResponse();
//endregion TelemetrySnippets

/**
* Implementation not provided for this method
*
* @return {@code null}
*/
protected String getTenenatId() {
return null;
}

/**
* Implementation not provided for this method
*
* @return {@code null}
*/
protected String getClientId() {
return null;
}

/**
* Implementation not provided for this method
*
* @return {@code null}
*/
protected String getClientSecret() {
return null;
}

/**
* Implementation not provided for this method
*
* @return {@code null}
*/
protected String getEndpointUrl() {
return null;
}

/**
* Implementation not provided for this method
*
* @return {@code null}
*/
protected String getDigitalTwinPayload() {
return null;
}

/**
* Implementation not provided for this method
*
* @return {@code null}
*/
protected String getRelationshipPayload() {
return null;
}

/**
* Implementation not provided for this method
*
* @return {@code null}
*/
protected String loadModelFromFile(String fileName){
return null;
}
}
Loading