Package com.azure.resourcemanager.logic.models

Class ApiOperationPropertiesDefinition

java.lang.Object
com.azure.resourcemanager.logic.models.ApiOperationPropertiesDefinition
public final class ApiOperationPropertiesDefinition extends Object
The api operations properties.

  • Constructor Details

    • ApiOperationPropertiesDefinition

      public ApiOperationPropertiesDefinition()
      Creates an instance of ApiOperationPropertiesDefinition class.

  • Method Details

    • summary

      public String summary()
      Get the summary property: The summary of the api operation.
      Returns:
      the summary value.

    • withSummary

      public ApiOperationPropertiesDefinition withSummary(String summary)
      Set the summary property: The summary of the api operation.
      Parameters:
      summary - the summary value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • description

      public String description()
      Get the description property: The description of the api operation.
      Returns:
      the description value.

    • withDescription

      public ApiOperationPropertiesDefinition withDescription(String description)
      Set the description property: The description of the api operation.
      Parameters:
      description - the description value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • visibility

      public String visibility()
      Get the visibility property: The visibility of the api operation.
      Returns:
      the visibility value.

    • withVisibility

      public ApiOperationPropertiesDefinition withVisibility(String visibility)
      Set the visibility property: The visibility of the api operation.
      Parameters:
      visibility - the visibility value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • trigger

      public String trigger()
      Get the trigger property: The trigger type of api operation.
      Returns:
      the trigger value.

    • withTrigger

      public ApiOperationPropertiesDefinition withTrigger(String trigger)
      Set the trigger property: The trigger type of api operation.
      Parameters:
      trigger - the trigger value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • triggerHint

      public String triggerHint()
      Get the triggerHint property: The trigger hint for the api operation.
      Returns:
      the triggerHint value.

    • withTriggerHint

      public ApiOperationPropertiesDefinition withTriggerHint(String triggerHint)
      Set the triggerHint property: The trigger hint for the api operation.
      Parameters:
      triggerHint - the triggerHint value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • pageable

      public Boolean pageable()
      Get the pageable property: Indicates whether the api operation is pageable.
      Returns:
      the pageable value.

    • withPageable

      public ApiOperationPropertiesDefinition withPageable(Boolean pageable)
      Set the pageable property: Indicates whether the api operation is pageable.
      Parameters:
      pageable - the pageable value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • annotation

      public ApiOperationAnnotation annotation()
      Get the annotation property: The annotation of api operation.
      Returns:
      the annotation value.

    • withAnnotation

      public ApiOperationPropertiesDefinition withAnnotation(ApiOperationAnnotation annotation)
      Set the annotation property: The annotation of api operation.
      Parameters:
      annotation - the annotation value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • api

      public ApiReference api()
      Get the api property: The api reference.
      Returns:
      the api value.

    • withApi

      public ApiOperationPropertiesDefinition withApi(ApiReference api)
      Set the api property: The api reference.
      Parameters:
      api - the api value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • inputsDefinition

      public SwaggerSchema inputsDefinition()
      Get the inputsDefinition property: The operation inputs definition schema.
      Returns:
      the inputsDefinition value.

    • withInputsDefinition

      public ApiOperationPropertiesDefinition withInputsDefinition(SwaggerSchema inputsDefinition)
      Set the inputsDefinition property: The operation inputs definition schema.
      Parameters:
      inputsDefinition - the inputsDefinition value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • responsesDefinition

      public Map<String,SwaggerSchema> responsesDefinition()
      Get the responsesDefinition property: The operation responses definition schemas.
      Returns:
      the responsesDefinition value.

    • withResponsesDefinition

      public ApiOperationPropertiesDefinition withResponsesDefinition(Map<String,SwaggerSchema> responsesDefinition)
      Set the responsesDefinition property: The operation responses definition schemas.
      Parameters:
      responsesDefinition - the responsesDefinition value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • isWebhook

      public Boolean isWebhook()
      Get the isWebhook property: Indicates whether the API operation is webhook or not.
      Returns:
      the isWebhook value.

    • withIsWebhook

      public ApiOperationPropertiesDefinition withIsWebhook(Boolean isWebhook)
      Set the isWebhook property: Indicates whether the API operation is webhook or not.
      Parameters:
      isWebhook - the isWebhook value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • isNotification

      public Boolean isNotification()
      Get the isNotification property: Indicates whether the API operation is notification or not.
      Returns:
      the isNotification value.

    • withIsNotification

      public ApiOperationPropertiesDefinition withIsNotification(Boolean isNotification)
      Set the isNotification property: Indicates whether the API operation is notification or not.
      Parameters:
      isNotification - the isNotification value to set.
      Returns:
      the ApiOperationPropertiesDefinition object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.