Package com.azure.resourcemanager.apimanagement.fluent.models

Class OperationContractProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.models.OperationEntityBaseContract
com.azure.resourcemanager.apimanagement.fluent.models.OperationContractProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<OperationEntityBaseContract>
public final class OperationContractProperties extends OperationEntityBaseContract
Operation Contract Properties.

  • Constructor Details

    • OperationContractProperties

      public OperationContractProperties()
      Creates an instance of OperationContractProperties class.

  • Method Details

    • displayName

      public String displayName()
      Get the displayName property: Operation Name.
      Returns:
      the displayName value.

    • withDisplayName

      public OperationContractProperties withDisplayName(String displayName)
      Set the displayName property: Operation Name.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the OperationContractProperties object itself.

    • method

      public String method()
      Get the method property: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
      Returns:
      the method value.

    • withMethod

      public OperationContractProperties withMethod(String method)
      Set the method property: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
      Parameters:
      method - the method value to set.
      Returns:
      the OperationContractProperties object itself.

    • urlTemplate

      public String urlTemplate()
      Get the urlTemplate property: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}.
      Returns:
      the urlTemplate value.

    • withUrlTemplate

      public OperationContractProperties withUrlTemplate(String urlTemplate)
      Set the urlTemplate property: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}.
      Parameters:
      urlTemplate - the urlTemplate value to set.
      Returns:
      the OperationContractProperties object itself.

    • withTemplateParameters

      public OperationContractProperties withTemplateParameters(List<ParameterContract> templateParameters)
      Set the templateParameters property: Collection of URL template parameters.
      Overrides:
      withTemplateParameters in class OperationEntityBaseContract
      Parameters:
      templateParameters - the templateParameters value to set.
      Returns:
      the OperationEntityBaseContract object itself.

    • withDescription

      public OperationContractProperties withDescription(String description)
      Set the description property: Description of the operation. May include HTML formatting tags.
      Overrides:
      withDescription in class OperationEntityBaseContract
      Parameters:
      description - the description value to set.
      Returns:
      the OperationEntityBaseContract object itself.

    • withRequest

      public OperationContractProperties withRequest(RequestContract request)
      Set the request property: An entity containing request details.
      Overrides:
      withRequest in class OperationEntityBaseContract
      Parameters:
      request - the request value to set.
      Returns:
      the OperationEntityBaseContract object itself.

    • withResponses

      public OperationContractProperties withResponses(List<ResponseContract> responses)
      Set the responses property: Array of Operation responses.
      Overrides:
      withResponses in class OperationEntityBaseContract
      Parameters:
      responses - the responses value to set.
      Returns:
      the OperationEntityBaseContract object itself.

    • withPolicies

      public OperationContractProperties withPolicies(String policies)
      Set the policies property: Operation Policies.
      Overrides:
      withPolicies in class OperationEntityBaseContract
      Parameters:
      policies - the policies value to set.
      Returns:
      the OperationEntityBaseContract object itself.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<OperationEntityBaseContract>
      Overrides:
      toJson in class OperationEntityBaseContract
      Throws:
      IOException

    • fromJson

      public static OperationContractProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of OperationContractProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of OperationContractProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the OperationContractProperties.