Class OperationEntityBaseContract

    • Constructor Detail

      • OperationEntityBaseContract

        public OperationEntityBaseContract()
    • Method Detail

      • templateParameters

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

        public OperationEntityBaseContract withTemplateParameters​(List<ParameterContract> templateParameters)
        Set the templateParameters property: Collection of URL template parameters.
        Parameters:
        templateParameters - the templateParameters value to set.
        Returns:
        the OperationEntityBaseContract 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 OperationEntityBaseContract 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 OperationEntityBaseContract object itself.
      • request

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

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

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

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

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

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

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