public final class ApiOperationPropertiesDefinition extends Object
Constructor and Description |
---|
ApiOperationPropertiesDefinition() |
Modifier and Type | Method and Description |
---|---|
ApiOperationAnnotation |
annotation()
Get the annotation property: The annotation of api operation.
|
ApiReference |
api()
Get the api property: The api reference.
|
String |
description()
Get the description property: The description of the api operation.
|
SwaggerSchema |
inputsDefinition()
Get the inputsDefinition property: The operation inputs definition schema.
|
Boolean |
isNotification()
Get the isNotification property: Indicates whether the API operation is notification or not.
|
Boolean |
isWebhook()
Get the isWebhook property: Indicates whether the API operation is webhook or not.
|
Boolean |
pageable()
Get the pageable property: Indicates whether the api operation is pageable.
|
Map<String,SwaggerSchema> |
responsesDefinition()
Get the responsesDefinition property: The operation responses definition schemas.
|
String |
summary()
Get the summary property: The summary of the api operation.
|
String |
trigger()
Get the trigger property: The trigger type of api operation.
|
String |
triggerHint()
Get the triggerHint property: The trigger hint for the api operation.
|
void |
validate()
Validates the instance.
|
String |
visibility()
Get the visibility property: The visibility of the api operation.
|
ApiOperationPropertiesDefinition |
withAnnotation(ApiOperationAnnotation annotation)
Set the annotation property: The annotation of api operation.
|
ApiOperationPropertiesDefinition |
withApi(ApiReference api)
Set the api property: The api reference.
|
ApiOperationPropertiesDefinition |
withDescription(String description)
Set the description property: The description of the api operation.
|
ApiOperationPropertiesDefinition |
withInputsDefinition(SwaggerSchema inputsDefinition)
Set the inputsDefinition property: The operation inputs definition schema.
|
ApiOperationPropertiesDefinition |
withIsNotification(Boolean isNotification)
Set the isNotification property: Indicates whether the API operation is notification or not.
|
ApiOperationPropertiesDefinition |
withIsWebhook(Boolean isWebhook)
Set the isWebhook property: Indicates whether the API operation is webhook or not.
|
ApiOperationPropertiesDefinition |
withPageable(Boolean pageable)
Set the pageable property: Indicates whether the api operation is pageable.
|
ApiOperationPropertiesDefinition |
withResponsesDefinition(Map<String,SwaggerSchema> responsesDefinition)
Set the responsesDefinition property: The operation responses definition schemas.
|
ApiOperationPropertiesDefinition |
withSummary(String summary)
Set the summary property: The summary of the api operation.
|
ApiOperationPropertiesDefinition |
withTrigger(String trigger)
Set the trigger property: The trigger type of api operation.
|
ApiOperationPropertiesDefinition |
withTriggerHint(String triggerHint)
Set the triggerHint property: The trigger hint for the api operation.
|
ApiOperationPropertiesDefinition |
withVisibility(String visibility)
Set the visibility property: The visibility of the api operation.
|
public String summary()
public ApiOperationPropertiesDefinition withSummary(String summary)
summary
- the summary value to set.public String description()
public ApiOperationPropertiesDefinition withDescription(String description)
description
- the description value to set.public String visibility()
public ApiOperationPropertiesDefinition withVisibility(String visibility)
visibility
- the visibility value to set.public String trigger()
public ApiOperationPropertiesDefinition withTrigger(String trigger)
trigger
- the trigger value to set.public String triggerHint()
public ApiOperationPropertiesDefinition withTriggerHint(String triggerHint)
triggerHint
- the triggerHint value to set.public Boolean pageable()
public ApiOperationPropertiesDefinition withPageable(Boolean pageable)
pageable
- the pageable value to set.public ApiOperationAnnotation annotation()
public ApiOperationPropertiesDefinition withAnnotation(ApiOperationAnnotation annotation)
annotation
- the annotation value to set.public ApiReference api()
public ApiOperationPropertiesDefinition withApi(ApiReference api)
api
- the api value to set.public SwaggerSchema inputsDefinition()
public ApiOperationPropertiesDefinition withInputsDefinition(SwaggerSchema inputsDefinition)
inputsDefinition
- the inputsDefinition value to set.public Map<String,SwaggerSchema> responsesDefinition()
public ApiOperationPropertiesDefinition withResponsesDefinition(Map<String,SwaggerSchema> responsesDefinition)
responsesDefinition
- the responsesDefinition value to set.public Boolean isWebhook()
public ApiOperationPropertiesDefinition withIsWebhook(Boolean isWebhook)
isWebhook
- the isWebhook value to set.public Boolean isNotification()
public ApiOperationPropertiesDefinition withIsNotification(Boolean isNotification)
isNotification
- the isNotification value to set.public void validate()
IllegalArgumentException
- thrown if the instance is not valid.Copyright © 2021 Microsoft Corporation. All rights reserved.