Skip to content

[AutoPR deploymentmanager/resource-manager] DeploymentManager: Fix property name and enhance descriptions #2446

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

Merged
AutorestCI merged 1 commit into from
Oct 1, 2018
Merged

[AutoPR deploymentmanager/resource-manager] DeploymentManager: Fix property name and enhance descriptions #2446

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
13 changes: 9 additions & 4 deletions ...azure/management/deploymentmanager/v2018-09-01-preview/ArtifactSourcePropertiesModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,13 @@ public class ArtifactSourcePropertiesModel {
private String sourceType;

/**
* The root folder under which all artifacts for all environments are
* expected to be organized.
* The path from the location that the 'authentication' property [say, a
* SAS URI to the blob container] refers to, to the location of the
* artifacts. This can be used to differentiate different versions of the
* artifacts. Or, different types of artifacts like binaries or templates.
* The location referenced by the authentication property concatenated with
* this optional artifactRoot path forms the artifact source location where
* the artifacts are expected to be found.
*/
@JsonProperty(value = "artifactRoot")
private String artifactRoot;
Expand Down Expand Up @@ -55,7 +60,7 @@ public ArtifactSourcePropertiesModel withSourceType(String sourceType) {
}

/**
* Get the root folder under which all artifacts for all environments are expected to be organized.
* Get the path from the location that the 'authentication' property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.
*
* @return the artifactRoot value
*/
Expand All @@ -64,7 +69,7 @@ public String artifactRoot() {
}

/**
* Set the root folder under which all artifacts for all environments are expected to be organized.
* Set the path from the location that the 'authentication' property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.
*
* @param artifactRoot the artifactRoot value to set
* @return the ArtifactSourcePropertiesModel object itself.
Expand Down
6 changes: 3 additions & 3 deletions ...ava/com/microsoft/azure/management/deploymentmanager/v2018-09-01-preview/PrePostStep.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
*/
public class PrePostStep {
/**
* The reference to the ARM resource Id of a step.
* The resource Id of the step to be run.
*/
@JsonProperty(value = "stepId", required = true)
private String stepId;

/**
* Get the reference to the ARM resource Id of a step.
* Get the resource Id of the step to be run.
*
* @return the stepId value
*/
Expand All @@ -30,7 +30,7 @@ public String stepId() {
}

/**
* Set the reference to the ARM resource Id of a step.
* Set the resource Id of the step to be run.
*
* @param stepId the stepId value to set
* @return the PrePostStep object itself.
Expand Down
13 changes: 7 additions & 6 deletions ...icrosoft/azure/management/deploymentmanager/v2018-09-01-preview/RolloutOperationInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,16 @@
*/
public class RolloutOperationInfo {
/**
* The ordinal count of retry attempt. 0 if no retries of the rollout have
* been performed.
* The ordinal count of the number of retry attempts on a rollout. 0 if no
* retries of the rollout have been performed. If the rollout is updated
* with a PUT, this count is reset to 0.
*/
@JsonProperty(value = "retryAttempt", access = JsonProperty.Access.WRITE_ONLY)
private Integer retryAttempt;

/**
* True if skipping all successful steps in the given retry attempt was
* chosen. False otherwise.
* True, if all steps that succeeded on the previous run/attempt were
* chosen to be skipped in this retry attempt. False, otherwise.
*/
@JsonProperty(value = "skipSucceededOnRetry", access = JsonProperty.Access.WRITE_ONLY)
private Boolean skipSucceededOnRetry;
Expand All @@ -49,7 +50,7 @@ public class RolloutOperationInfo {
private CloudErrorBody error;

/**
* Get the ordinal count of retry attempt. 0 if no retries of the rollout have been performed.
* Get the ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0.
*
* @return the retryAttempt value
*/
Expand All @@ -58,7 +59,7 @@ public Integer retryAttempt() {
}

/**
* Get true if skipping all successful steps in the given retry attempt was chosen. False otherwise.
* Get true, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise.
*
* @return the skipSucceededOnRetry value
*/
Expand Down
4 changes: 2 additions & 2 deletions ...rosoft/azure/management/deploymentmanager/v2018-09-01-preview/RolloutPropertiesModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public class RolloutPropertiesModel {
private RolloutOperationInfo operationInfo;

/**
* Set of detailed step result information on target resource groups.
* The detailed information on the services being deployed.
*/
@JsonProperty(value = "services", access = JsonProperty.Access.WRITE_ONLY)
private List<ServiceInner> services;
Expand Down Expand Up @@ -69,7 +69,7 @@ public RolloutOperationInfo operationInfo() {
}

/**
* Get set of detailed step result information on target resource groups.
* Get the detailed information on the services being deployed.
*
* @return the services value
*/
Expand Down
13 changes: 6 additions & 7 deletions ...ava/com/microsoft/azure/management/deploymentmanager/v2018-09-01-preview/RolloutStep.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@
*/
public class RolloutStep {
/**
* Name of the step as specified in the rollout specification input
* artifact.
* Name of the step.
*/
@JsonProperty(value = "name", required = true)
private String name;
Expand All @@ -41,8 +40,8 @@ public class RolloutStep {
private StepOperationInfo operationInfo;

/**
* Set of resource operations that were performed on the Azure resource
* that the action acted upon.
* Set of resource operations that were performed, if any, on an Azure
* resource.
*/
@JsonProperty(value = "resourceOperations", access = JsonProperty.Access.WRITE_ONLY)
private List<ResourceOperation> resourceOperations;
Expand All @@ -54,7 +53,7 @@ public class RolloutStep {
private List<Message> messages;

/**
* Get name of the step as specified in the rollout specification input artifact.
* Get name of the step.
*
* @return the name value
*/
Expand All @@ -63,7 +62,7 @@ public String name() {
}

/**
* Set name of the step as specified in the rollout specification input artifact.
* Set name of the step.
*
* @param name the name value to set
* @return the RolloutStep object itself.
Expand Down Expand Up @@ -112,7 +111,7 @@ public StepOperationInfo operationInfo() {
}

/**
* Get set of resource operations that were performed on the Azure resource that the action acted upon.
* Get set of resource operations that were performed, if any, on an Azure resource.
*
* @return the resourceOperations value
*/
Expand Down
4 changes: 2 additions & 2 deletions ...n/java/com/microsoft/azure/management/deploymentmanager/v2018-09-01-preview/Rollouts.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
public interface Rollouts extends SupportsCreating<Rollout.DefinitionStages.Blank>, SupportsDeletingByResourceGroup, SupportsBatchDeletion, SupportsGettingByResourceGroup<Rollout>, HasInner<RolloutsInner> {
/**
* Stops a running rollout.
* A rollout can be canceled only if it is in running state.
* Only running rollouts can be canceled.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param rolloutName The rollout name.
Expand All @@ -33,7 +33,7 @@ public interface Rollouts extends SupportsCreating<Rollout.DefinitionStages.Blan

/**
* Restarts a failed rollout and optionally skips all succeeded steps.
* A rollout can be restarted only if is in a terminal state and failed.
* Only failed rollouts can be restarted.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param rolloutName The rollout name.
Expand Down
12 changes: 7 additions & 5 deletions ...m/microsoft/azure/management/deploymentmanager/v2018-09-01-preview/SasAuthentication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,23 @@
import com.microsoft.rest.serializer.JsonFlatten;

/**
* Defines the authentication properties to access the artifacts using Azure
* Storage SAS URI.
* Defines the properties to access the artifacts using an Azure Storage SAS
* URI.
*/
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonTypeName("Sas")
@JsonFlatten
public class SasAuthentication extends Authentication {
/**
* The complete SAS URI to the location of the artifacts.
* The SAS URI to the Azure Storage blob container. Any offset from the
* root of the container to where the artifacts are located can be defined
* in the artifactRoot.
*/
@JsonProperty(value = "properties.sasUri", required = true)
private String sasUri;

/**
* Get the complete SAS URI to the location of the artifacts.
* Get the SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot.
*
* @return the sasUri value
*/
Expand All @@ -37,7 +39,7 @@ public String sasUri() {
}

/**
* Set the complete SAS URI to the location of the artifacts.
* Set the SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot.
*
* @param sasUri the sasUri value to set
* @return the SasAuthentication object itself.
Expand Down
14 changes: 8 additions & 6 deletions ...m/microsoft/azure/management/deploymentmanager/v2018-09-01-preview/ServiceProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,21 @@
*/
public class ServiceProperties {
/**
* The Azure location to which the resources in the service belong to.
* The Azure location to which the resources in the service belong to or
* should be deployed to.
*/
@JsonProperty(value = "targetLocation", required = true)
private String targetLocation;

/**
* The subscription to which the resources in the service belong to.
* The subscription to which the resources in the service belong to or
* should be deployed to.
*/
@JsonProperty(value = "targetSubscriptionId", required = true)
private String targetSubscriptionId;

/**
* Get the Azure location to which the resources in the service belong to.
* Get the Azure location to which the resources in the service belong to or should be deployed to.
*
* @return the targetLocation value
*/
Expand All @@ -36,7 +38,7 @@ public String targetLocation() {
}

/**
* Set the Azure location to which the resources in the service belong to.
* Set the Azure location to which the resources in the service belong to or should be deployed to.
*
* @param targetLocation the targetLocation value to set
* @return the ServiceProperties object itself.
Expand All @@ -47,7 +49,7 @@ public ServiceProperties withTargetLocation(String targetLocation) {
}

/**
* Get the subscription to which the resources in the service belong to.
* Get the subscription to which the resources in the service belong to or should be deployed to.
*
* @return the targetSubscriptionId value
*/
Expand All @@ -56,7 +58,7 @@ public String targetSubscriptionId() {
}

/**
* Set the subscription to which the resources in the service belong to.
* Set the subscription to which the resources in the service belong to or should be deployed to.
*
* @param targetSubscriptionId the targetSubscriptionId value to set
* @return the ServiceProperties object itself.
Expand Down
8 changes: 4 additions & 4 deletions ...oft/azure/management/deploymentmanager/v2018-09-01-preview/ServiceTopologyProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@
*/
public class ServiceTopologyProperties {
/**
* The artifact source that contains the artifacts that can be referenced
* in the service units.
* The resource Id of the artifact source that contains the artifacts that
* can be referenced in the service units.
*/
@JsonProperty(value = "artifactSourceId")
private String artifactSourceId;

/**
* Get the artifact source that contains the artifacts that can be referenced in the service units.
* Get the resource Id of the artifact source that contains the artifacts that can be referenced in the service units.
*
* @return the artifactSourceId value
*/
Expand All @@ -31,7 +31,7 @@ public String artifactSourceId() {
}

/**
* Set the artifact source that contains the artifacts that can be referenced in the service units.
* Set the resource Id of the artifact source that contains the artifacts that can be referenced in the service units.
*
* @param artifactSourceId the artifactSourceId value to set
* @return the ServiceTopologyProperties object itself.
Expand Down
6 changes: 3 additions & 3 deletions ...crosoft/azure/management/deploymentmanager/v2018-09-01-preview/ServiceUnitProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
public class ServiceUnitProperties {
/**
* The Azure Resource Group to which the resources in the service unit
* belong to.
* belong to or should be deployed to.
*/
@JsonProperty(value = "targetResourceGroup", required = true)
private String targetResourceGroup;
Expand All @@ -35,7 +35,7 @@ public class ServiceUnitProperties {
private ServiceUnitArtifacts artifacts;

/**
* Get the Azure Resource Group to which the resources in the service unit belong to.
* Get the Azure Resource Group to which the resources in the service unit belong to or should be deployed to.
*
* @return the targetResourceGroup value
*/
Expand All @@ -44,7 +44,7 @@ public String targetResourceGroup() {
}

/**
* Set the Azure Resource Group to which the resources in the service unit belong to.
* Set the Azure Resource Group to which the resources in the service unit belong to or should be deployed to.
*
* @param targetResourceGroup the targetResourceGroup value to set
* @return the ServiceUnitProperties object itself.
Expand Down
4 changes: 2 additions & 2 deletions ...va/com/microsoft/azure/management/deploymentmanager/v2018-09-01-preview/ServiceUnits.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/
public interface ServiceUnits extends SupportsCreating<ServiceUnitResource.DefinitionStages.Blank>, HasInner<ServiceUnitsInner> {
/**
* Gets a service unit resource.
* Gets the service unit.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param serviceTopologyName The name of the service topology .
Expand All @@ -31,7 +31,7 @@ public interface ServiceUnits extends SupportsCreating<ServiceUnitResource.Defin
Observable<ServiceUnitResource> getAsync(String resourceGroupName, String serviceTopologyName, String serviceName, String serviceUnitName);

/**
* Deletes a service unit resource.
* Deletes the service unit.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param serviceTopologyName The name of the service topology .
Expand Down
4 changes: 2 additions & 2 deletions ...n/java/com/microsoft/azure/management/deploymentmanager/v2018-09-01-preview/Services.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/
public interface Services extends SupportsCreating<ServiceResource.DefinitionStages.Blank>, HasInner<ServicesInner> {
/**
* Gets a service resource.
* Gets the service.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param serviceTopologyName The name of the service topology .
Expand All @@ -30,7 +30,7 @@ public interface Services extends SupportsCreating<ServiceResource.DefinitionSta
Observable<ServiceResource> getAsync(String resourceGroupName, String serviceTopologyName, String serviceName);

/**
* Deletes a service resource.
* Deletes the service.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param serviceTopologyName The name of the service topology .
Expand Down
7 changes: 3 additions & 4 deletions ...m/microsoft/azure/management/deploymentmanager/v2018-09-01-preview/StepOperationInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@
import com.fasterxml.jackson.annotation.JsonProperty;

/**
* Detailed information of specific step execution.
* Detailed information of a specific step run.
*/
public class StepOperationInfo {
/**
* The name of the Azure Resource Manager deployment initiated as part of
* the step.
* The name of the ARM deployment initiated as part of the step.
*/
@JsonProperty(value = "deploymentName", access = JsonProperty.Access.WRITE_ONLY)
private String deploymentName;
Expand Down Expand Up @@ -53,7 +52,7 @@ public class StepOperationInfo {
private CloudErrorBody error;

/**
* Get the name of the Azure Resource Manager deployment initiated as part of the step.
* Get the name of the ARM deployment initiated as part of the step.
*
* @return the deploymentName value
*/
Expand Down
Loading