Class OperationUpdateContract


  • public final class OperationUpdateContract
    extends Object
    API Operation Update Contract details.
    • Constructor Detail

      • OperationUpdateContract

        public OperationUpdateContract()
    • Method Detail

      • displayName

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

        public OperationUpdateContract withDisplayName​(String displayName)
        Set the displayName property: Operation Name.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the OperationUpdateContract 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 OperationUpdateContract 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 OperationUpdateContract 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 OperationUpdateContract 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 OperationUpdateContract object itself.
      • templateParameters

        public List<ParameterContract> templateParameters()
        Get the templateParameters property: Collection of URL template parameters.
        Returns:
        the templateParameters value.
      • withTemplateParameters

        public OperationUpdateContract withTemplateParameters​(List<ParameterContract> templateParameters)
        Set the templateParameters property: Collection of URL template parameters.
        Parameters:
        templateParameters - the templateParameters value to set.
        Returns:
        the OperationUpdateContract object itself.
      • description

        public String description()
        Get the description property: Description of the operation. May include HTML formatting tags.
        Returns:
        the description value.
      • withDescription

        public OperationUpdateContract withDescription​(String description)
        Set the description property: Description of the operation. May include HTML formatting tags.
        Parameters:
        description - the description value to set.
        Returns:
        the OperationUpdateContract object itself.
      • request

        public RequestContract request()
        Get the request property: An entity containing request details.
        Returns:
        the request value.
      • withRequest

        public OperationUpdateContract withRequest​(RequestContract request)
        Set the request property: An entity containing request details.
        Parameters:
        request - the request value to set.
        Returns:
        the OperationUpdateContract object itself.
      • responses

        public List<ResponseContract> responses()
        Get the responses property: Array of Operation responses.
        Returns:
        the responses value.
      • withResponses

        public OperationUpdateContract withResponses​(List<ResponseContract> responses)
        Set the responses property: Array of Operation responses.
        Parameters:
        responses - the responses value to set.
        Returns:
        the OperationUpdateContract object itself.
      • policies

        public String policies()
        Get the policies property: Operation Policies.
        Returns:
        the policies value.
      • withPolicies

        public OperationUpdateContract withPolicies​(String policies)
        Set the policies property: Operation Policies.
        Parameters:
        policies - the policies value to set.
        Returns:
        the OperationUpdateContract object itself.
      • validate

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