Apim3xApiDto (Micro Gateway - Code Generator 3.2.10 API)

java.lang.Object
- org.wso2.apimgt.gateway.cli.model.rest.APIInfoBaseDTO
- - org.wso2.apimgt.gateway.cli.model.rest.apim3x.Apim3xApiDto

public class Apim3xApiDto
extends APIInfoBaseDTO

DTO for APIM 3.x API model

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Apim3xApiDto.AccessControlEnum` WSO2 APIM access control level.
`static class`	`Apim3xApiDto.SubscriptionAvailabilityEnum` Subscription availability in WSO2 APIM.
`static class`	`Apim3xApiDto.TypeEnum` API Type.
`static class`	`Apim3xApiDto.VisibilityEnum` API Visibility level.

Constructor Summary

Constructors
Constructor and Description

Apim3xApiDto()

Constructors
Constructor and Description
`Apim3xApiDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Apim3xApiDto.AccessControlEnum`	`getAccessControl()` Is the API is restricted to certain set of publishers or creators or is it visible to all the\npublishers and creators.
`Map<String,String>`	`getAdditionalProperties()` Map of custom properties of APIDetailedDTO.
`String`	`getApiLevelPolicy()` The policy selected for the particular APIDetailedDTO.
`String`	`getApiSecurity()` Type of API security, the current API secured with.
`com.google.gson.JsonObject`	`getApiSwagger()`
`String`	`getDestinationStatsEnabled()`
`String`	`getEndpointConfigStr()`
`APIEndpointSecurityDTO`	`getEndpointSecurity()`
`String`	`getGatewayEnvironments()` Comma separated list of gateway environments.
`List<LabelDTO>`	`getLabels()` Labels of micro-gateway environments attached to the APIDetailedDTO.
`String`	`getResponseCaching()`
`List<SequenceDTO>`	`getSequences()`
`String`	`getStatus()` This describes in which status of the lifecycle the APIDetailedDTO is.
`Apim3xApiDto.SubscriptionAvailabilityEnum`	`getSubscriptionAvailability()` The subscription availability.
`String`	`getThumbnailUri()`
`List<String>`	`getTiers()` The subscription tiers selected for the particular APIDetailedDTO.
`Apim3xApiDto.TypeEnum`	`getType()` The transport to be set.
`Apim3xApiDto.VisibilityEnum`	`getVisibility()` The visibility level of the APIDetailedDTO.
`String`	`getWsdlUri()` WSDL URL if the APIDetailedDTO is based on a WSDL endpoint.
`void`	`setAccessControl(Apim3xApiDto.AccessControlEnum accessControl)`
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)`
`void`	`setApiLevelPolicy(String apiLevelPolicy)`
`void`	`setApiSecurity(String apiSecurity)`
`void`	`setApiSwagger(io.swagger.util.Json apiSwagger)`
`void`	`setDestinationStatsEnabled(String destinationStatsEnabled)`
`void`	`setEndpointConfigStr(String endpointConfig)`
`void`	`setEndpointSecurity(APIEndpointSecurityDTO endpointSecurity)`
`void`	`setGatewayEnvironments(String gatewayEnvironments)`
`void`	`setLabels(List<LabelDTO> labels)`
`void`	`setResponseCaching(String responseCaching)`
`void`	`setSequences(List<SequenceDTO> sequences)`
`void`	`setStatus(String status)`
`void`	`setSubscriptionAvailability(Apim3xApiDto.SubscriptionAvailabilityEnum subscriptionAvailability)`
`void`	`setThumbnailUri(String thumbnailUri)`
`void`	`setTiers(List<String> tiers)`
`void`	`setType(Apim3xApiDto.TypeEnum type)`
`void`	`setVisibility(Apim3xApiDto.VisibilityEnum visibility)`
`void`	`setWsdlUri(String wsdlUri)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Apim3xApiDto
```
public Apim3xApiDto()
```
- Method Detail
  - getStatus
```
public String getStatus()
```
    This describes in which status of the lifecycle the APIDetailedDTO is.
  - setStatus
```
public void setStatus(String status)
```
  - getThumbnailUri
```
public String getThumbnailUri()
```
  - setThumbnailUri
```
public void setThumbnailUri(String thumbnailUri)
```
  - getType
```
public Apim3xApiDto.TypeEnum getType()
```
    The transport to be set. Accepted values are HTTP, WS
  - setType
```
public void setType(Apim3xApiDto.TypeEnum type)
```
  - getWsdlUri
```
public String getWsdlUri()
```
    WSDL URL if the APIDetailedDTO is based on a WSDL endpoint.
  - setWsdlUri
```
public void setWsdlUri(String wsdlUri)
```
  - getResponseCaching
```
public String getResponseCaching()
```
    Overrides:
    
    getResponseCaching in class APIInfoBaseDTO
  - setResponseCaching
```
public void setResponseCaching(String responseCaching)
```
    Overrides:
    
    setResponseCaching in class APIInfoBaseDTO
  - getDestinationStatsEnabled
```
public String getDestinationStatsEnabled()
```
  - setDestinationStatsEnabled
```
public void setDestinationStatsEnabled(String destinationStatsEnabled)
```
  - getApiSwagger
```
public com.google.gson.JsonObject getApiSwagger()
```
  - setApiSwagger
```
public void setApiSwagger(io.swagger.util.Json apiSwagger)
```
  - getTiers
```
public List<String> getTiers()
```
    The subscription tiers selected for the particular APIDetailedDTO.
  - setTiers
```
public void setTiers(List<String> tiers)
```
  - getApiLevelPolicy
```
public String getApiLevelPolicy()
```
    The policy selected for the particular APIDetailedDTO.
    
    Overrides:
    
    getApiLevelPolicy in class APIInfoBaseDTO
  - setApiLevelPolicy
```
public void setApiLevelPolicy(String apiLevelPolicy)
```
    Overrides:
    
    setApiLevelPolicy in class APIInfoBaseDTO
  - getApiSecurity
```
public String getApiSecurity()
```
    Type of API security, the current API secured with. It can be either OAuth2 or mutual SSL or both. If it is not set OAuth2 will be set as the security for the current API.
  - setApiSecurity
```
public void setApiSecurity(String apiSecurity)
```
  - getVisibility
```
public Apim3xApiDto.VisibilityEnum getVisibility()
```
    The visibility level of the APIDetailedDTO. Accepts one of the following. PUBLIC, PRIVATE, RESTRICTED OR CONTROLLED.
  - setVisibility
```
public void setVisibility(Apim3xApiDto.VisibilityEnum visibility)
```
  - getEndpointConfigStr
```
public String getEndpointConfigStr()
```
    Overrides:
    
    getEndpointConfigStr in class APIInfoBaseDTO
  - setEndpointConfigStr
```
public void setEndpointConfigStr(String endpointConfig)
```
    Overrides:
    
    setEndpointConfigStr in class APIInfoBaseDTO
  - getEndpointSecurity
```
public APIEndpointSecurityDTO getEndpointSecurity()
```
    Overrides:
    
    getEndpointSecurity in class APIInfoBaseDTO
  - setEndpointSecurity
```
public void setEndpointSecurity(APIEndpointSecurityDTO endpointSecurity)
```
    Overrides:
    
    setEndpointSecurity in class APIInfoBaseDTO
  - getGatewayEnvironments
```
public String getGatewayEnvironments()
```
    Comma separated list of gateway environments.
  - setGatewayEnvironments
```
public void setGatewayEnvironments(String gatewayEnvironments)
```
  - getLabels
```
public List<LabelDTO> getLabels()
```
    Labels of micro-gateway environments attached to the APIDetailedDTO.
  - setLabels
```
public void setLabels(List<LabelDTO> labels)
```
  - getSequences
```
public List<SequenceDTO> getSequences()
```
  - setSequences
```
public void setSequences(List<SequenceDTO> sequences)
```
  - getSubscriptionAvailability
```
public Apim3xApiDto.SubscriptionAvailabilityEnum getSubscriptionAvailability()
```
    The subscription availability. Accepts one of the following. current_tenant, all_tenants or specific_tenants.
  - setSubscriptionAvailability
```
public void setSubscriptionAvailability(Apim3xApiDto.SubscriptionAvailabilityEnum subscriptionAvailability)
```
  - getAdditionalProperties
```
public Map<String,String> getAdditionalProperties()
```
    Map of custom properties of APIDetailedDTO.
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,String> additionalProperties)
```
  - getAccessControl
```
public Apim3xApiDto.AccessControlEnum getAccessControl()
```
    Is the API is restricted to certain set of publishers or creators or is it visible to all the\npublishers and creators. If the accessControl restriction is none, this API can be modified by all the\npublishers and creators, if not it can only be viewable/modifiable by certain set of publishers and creators,\n based on the restriction. \n
  - setAccessControl
```
public void setAccessControl(Apim3xApiDto.AccessControlEnum accessControl)
```

Class Apim3xApiDto

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.wso2.apimgt.gateway.cli.model.rest.APIInfoBaseDTO

Methods inherited from class java.lang.Object

Constructor Detail

Apim3xApiDto

Method Detail

getStatus

setStatus

getThumbnailUri

setThumbnailUri

getType

setType

getWsdlUri

setWsdlUri

getResponseCaching

setResponseCaching

getDestinationStatsEnabled

setDestinationStatsEnabled

getApiSwagger

setApiSwagger

getTiers

setTiers

getApiLevelPolicy

setApiLevelPolicy

getApiSecurity

setApiSecurity

getVisibility

setVisibility

getEndpointConfigStr

setEndpointConfigStr

getEndpointSecurity

setEndpointSecurity

getGatewayEnvironments

setGatewayEnvironments

getLabels

setLabels

getSequences

setSequences

getSubscriptionAvailability

setSubscriptionAvailability

getAdditionalProperties

setAdditionalProperties

getAccessControl

setAccessControl