Class APIDTO
java.lang.Object
org.wso2.am.integration.clients.publisher.api.v1.dto.APIDTO
APIDTO
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumIs the API is restricted to certain set of publishers or creators or is it visible to all the publishers and creators.static enumThe audience of the API.static enumGets or Sets endpointImplementationTypestatic enumThe subscription availability.static enumThe api creation type to be used.static enumThe visibility level of the API. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccessControl(APIDTO.AccessControlEnum accessControl) accessControlRoles(List<String> accessControlRoles) additionalProperties(List<APIInfoAdditionalPropertiesDTO> additionalProperties) additionalPropertiesMap(Map<String, APIInfoAdditionalPropertiesMapDTO> additionalPropertiesMap) advertiseInfo(AdvertiseInfoDTO advertiseInfo) apiKeyHeader(String apiKeyHeader) apiPolicies(APIOperationPoliciesDTO apiPolicies) apiThrottlingPolicy(String apiThrottlingPolicy) asyncTransportProtocols(List<String> asyncTransportProtocols) audience(APIDTO.AudienceEnum audience) authorizationHeader(String authorizationHeader) businessInformation(APIBusinessInformationDTO businessInformation) cacheTimeout(Integer cacheTimeout) categories(List<String> categories) corsConfiguration(APICorsConfigurationDTO corsConfiguration) createdTime(String createdTime) description(String description) displayName(String displayName) enableSchemaValidation(Boolean enableSchemaValidation) enableSubscriberVerification(Boolean enableSubscriberVerification) endpointConfig(Object endpointConfig) endpointImplementationType(APIDTO.EndpointImplementationTypeEnum endpointImplementationType) booleangatewayType(String gatewayType) gatewayVendor(String gatewayVendor) Is the API is restricted to certain set of publishers or creators or is it visible to all the publishers and creators.The user roles that are able to view/modify as API publisher or creator.Map of custom properties of APIGet additionalPropertiesMapGet advertiseInfoName of the API key header used for invoking the API.Get apiPoliciesThe API level throttling policy selected for the particular APISupported transports for the async API (http and/or https).The audience of the API.The audiences of the API for jwt validation.Name of the Authorization header used for invoking the API.Get businessInformationGet cacheTimeoutAPI categoriesGet contextGet corsConfigurationGet createdTimeGet descriptionHuman-friendly name shown in UI.Endpoint configuration of the API.Get endpointImplementationTypeThe gateway type selected for the API policies.Get gatewayVendorgetId()UUID of the api registry artifactAPI Key ManagersGet lastUpdatedTimeGet lastUpdatedTimestampGet lifeCycleStatusGet maxTpsGet mediationPoliciesGet monetizationgetName()Get nameGet operationsGet organizationPoliciesGet policiesGet primaryProductionEndpointIdGet primarySandboxEndpointIdIf the provider value is not given user invoking the api will be used as the provider.UUID of the api registry artifactGet revisionIdGet scopesTypes of API security, the current API secured with.Get serviceInfoThe subscription availability.Get subscriptionAvailableTenantsgetTags()Get tagsGet threatProtectionPoliciesSupported transports for the API (http and/or https).getType()The api creation type to be used.Get versionThe visibility level of the API.The organizations that are able to access the API in Developer PortalThe user roles that are able to access the API in Developer PortalGet visibleTenantsGet websubSubscriptionConfigurationGet workflowStatusGet wsdlInfoGet wsdlUrlinthashCode()hasThumbnail(Boolean hasThumbnail) initiatedFromGateway(Boolean initiatedFromGateway) isDefaultVersion(Boolean isDefaultVersion) Get enableSchemaValidationGet enableSubscriberVerificationGet hasThumbnailWhether the API is initiated from the gateway or not.Get isDefaultVersionGet isRevisionGet responseCachingEnabledisRevision(Boolean isRevision) keyManagers(Object keyManagers) lastUpdatedTime(String lastUpdatedTime) lastUpdatedTimestamp(String lastUpdatedTimestamp) lifeCycleStatus(String lifeCycleStatus) maxTps(APIMaxTpsDTO maxTps) mediationPolicies(List<MediationPolicyDTO> mediationPolicies) monetization(APIMonetizationInfoDTO monetization) operations(List<APIOperationsDTO> operations) organizationPolicies(List<OrganizationPoliciesDTO> organizationPolicies) primaryProductionEndpointId(String primaryProductionEndpointId) primarySandboxEndpointId(String primarySandboxEndpointId) responseCachingEnabled(Boolean responseCachingEnabled) revisionedApiId(String revisionedApiId) revisionId(Integer revisionId) scopes(List<APIScopeDTO> scopes) securityScheme(List<String> securityScheme) serviceInfo(APIServiceInfoDTO serviceInfo) voidsetAccessControl(APIDTO.AccessControlEnum accessControl) voidsetAccessControlRoles(List<String> accessControlRoles) voidsetAdditionalProperties(List<APIInfoAdditionalPropertiesDTO> additionalProperties) voidsetAdditionalPropertiesMap(Map<String, APIInfoAdditionalPropertiesMapDTO> additionalPropertiesMap) voidsetAdvertiseInfo(AdvertiseInfoDTO advertiseInfo) voidsetApiKeyHeader(String apiKeyHeader) voidsetApiPolicies(APIOperationPoliciesDTO apiPolicies) voidsetApiThrottlingPolicy(String apiThrottlingPolicy) voidsetAsyncTransportProtocols(List<String> asyncTransportProtocols) voidsetAudience(APIDTO.AudienceEnum audience) voidsetAudiences(List<String> audiences) voidsetAuthorizationHeader(String authorizationHeader) voidsetBusinessInformation(APIBusinessInformationDTO businessInformation) voidsetCacheTimeout(Integer cacheTimeout) voidsetCategories(List<String> categories) voidsetContext(String context) voidsetCorsConfiguration(APICorsConfigurationDTO corsConfiguration) voidsetCreatedTime(String createdTime) voidsetDescription(String description) voidsetDisplayName(String displayName) voidsetEnableSchemaValidation(Boolean enableSchemaValidation) voidsetEnableSubscriberVerification(Boolean enableSubscriberVerification) voidsetEndpointConfig(Object endpointConfig) voidsetEndpointImplementationType(APIDTO.EndpointImplementationTypeEnum endpointImplementationType) voidsetGatewayType(String gatewayType) voidsetGatewayVendor(String gatewayVendor) voidsetHasThumbnail(Boolean hasThumbnail) voidvoidsetInitiatedFromGateway(Boolean initiatedFromGateway) voidsetIsDefaultVersion(Boolean isDefaultVersion) voidsetIsRevision(Boolean isRevision) voidsetKeyManagers(Object keyManagers) voidsetLastUpdatedTime(String lastUpdatedTime) voidsetLastUpdatedTimestamp(String lastUpdatedTimestamp) voidsetLifeCycleStatus(String lifeCycleStatus) voidsetMaxTps(APIMaxTpsDTO maxTps) voidsetMediationPolicies(List<MediationPolicyDTO> mediationPolicies) voidsetMonetization(APIMonetizationInfoDTO monetization) voidvoidsetOperations(List<APIOperationsDTO> operations) voidsetOrganizationPolicies(List<OrganizationPoliciesDTO> organizationPolicies) voidsetPolicies(List<String> policies) voidsetPrimaryProductionEndpointId(String primaryProductionEndpointId) voidsetPrimarySandboxEndpointId(String primarySandboxEndpointId) voidsetProvider(String provider) voidsetResponseCachingEnabled(Boolean responseCachingEnabled) voidsetRevisionedApiId(String revisionedApiId) voidsetRevisionId(Integer revisionId) voidsetScopes(List<APIScopeDTO> scopes) voidsetSecurityScheme(List<String> securityScheme) voidsetServiceInfo(APIServiceInfoDTO serviceInfo) voidsetSubscriptionAvailability(APIDTO.SubscriptionAvailabilityEnum subscriptionAvailability) voidsetSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants) voidvoidsetThreatProtectionPolicies(APIThreatProtectionPoliciesDTO threatProtectionPolicies) voidsetTransport(List<String> transport) voidsetType(APIDTO.TypeEnum type) voidsetVersion(String version) voidsetVisibility(APIDTO.VisibilityEnum visibility) voidsetVisibleOrganizations(List<String> visibleOrganizations) voidsetVisibleRoles(List<String> visibleRoles) voidsetVisibleTenants(List<String> visibleTenants) voidsetWebsubSubscriptionConfiguration(WebsubSubscriptionConfigurationDTO websubSubscriptionConfiguration) voidsetWorkflowStatus(String workflowStatus) voidsetWsdlInfo(WSDLInfoDTO wsdlInfo) voidsetWsdlUrl(String wsdlUrl) subscriptionAvailability(APIDTO.SubscriptionAvailabilityEnum subscriptionAvailability) subscriptionAvailableTenants(List<String> subscriptionAvailableTenants) threatProtectionPolicies(APIThreatProtectionPoliciesDTO threatProtectionPolicies) toString()type(APIDTO.TypeEnum type) visibility(APIDTO.VisibilityEnum visibility) visibleOrganizations(List<String> visibleOrganizations) visibleRoles(List<String> visibleRoles) visibleTenants(List<String> visibleTenants) websubSubscriptionConfiguration(WebsubSubscriptionConfigurationDTO websubSubscriptionConfiguration) workflowStatus(String workflowStatus) wsdlInfo(WSDLInfoDTO wsdlInfo)
-
Field Details
-
SERIALIZED_NAME_ID
- See Also:
-
SERIALIZED_NAME_NAME
- See Also:
-
SERIALIZED_NAME_DISPLAY_NAME
- See Also:
-
SERIALIZED_NAME_DESCRIPTION
- See Also:
-
SERIALIZED_NAME_CONTEXT
- See Also:
-
SERIALIZED_NAME_VERSION
- See Also:
-
SERIALIZED_NAME_PROVIDER
- See Also:
-
SERIALIZED_NAME_LIFE_CYCLE_STATUS
- See Also:
-
SERIALIZED_NAME_WSDL_INFO
- See Also:
-
SERIALIZED_NAME_WSDL_URL
- See Also:
-
SERIALIZED_NAME_RESPONSE_CACHING_ENABLED
- See Also:
-
SERIALIZED_NAME_CACHE_TIMEOUT
- See Also:
-
SERIALIZED_NAME_HAS_THUMBNAIL
- See Also:
-
SERIALIZED_NAME_IS_DEFAULT_VERSION
- See Also:
-
SERIALIZED_NAME_IS_REVISION
- See Also:
-
SERIALIZED_NAME_REVISIONED_API_ID
- See Also:
-
SERIALIZED_NAME_REVISION_ID
- See Also:
-
SERIALIZED_NAME_ENABLE_SCHEMA_VALIDATION
- See Also:
-
SERIALIZED_NAME_ENABLE_SUBSCRIBER_VERIFICATION
- See Also:
-
SERIALIZED_NAME_TYPE
- See Also:
-
SERIALIZED_NAME_AUDIENCE
- See Also:
-
SERIALIZED_NAME_AUDIENCES
- See Also:
-
SERIALIZED_NAME_TRANSPORT
- See Also:
-
SERIALIZED_NAME_TAGS
- See Also:
-
SERIALIZED_NAME_POLICIES
- See Also:
-
SERIALIZED_NAME_ORGANIZATION_POLICIES
- See Also:
-
SERIALIZED_NAME_API_THROTTLING_POLICY
- See Also:
-
SERIALIZED_NAME_AUTHORIZATION_HEADER
- See Also:
-
SERIALIZED_NAME_API_KEY_HEADER
- See Also:
-
SERIALIZED_NAME_SECURITY_SCHEME
- See Also:
-
SERIALIZED_NAME_MAX_TPS
- See Also:
-
SERIALIZED_NAME_VISIBILITY
- See Also:
-
SERIALIZED_NAME_VISIBLE_ROLES
- See Also:
-
SERIALIZED_NAME_VISIBLE_TENANTS
- See Also:
-
SERIALIZED_NAME_VISIBLE_ORGANIZATIONS
- See Also:
-
SERIALIZED_NAME_MEDIATION_POLICIES
- See Also:
-
SERIALIZED_NAME_API_POLICIES
- See Also:
-
SERIALIZED_NAME_SUBSCRIPTION_AVAILABILITY
- See Also:
-
SERIALIZED_NAME_SUBSCRIPTION_AVAILABLE_TENANTS
- See Also:
-
SERIALIZED_NAME_ADDITIONAL_PROPERTIES
- See Also:
-
SERIALIZED_NAME_ADDITIONAL_PROPERTIES_MAP
- See Also:
-
SERIALIZED_NAME_MONETIZATION
- See Also:
-
SERIALIZED_NAME_ACCESS_CONTROL
- See Also:
-
SERIALIZED_NAME_ACCESS_CONTROL_ROLES
- See Also:
-
SERIALIZED_NAME_BUSINESS_INFORMATION
- See Also:
-
SERIALIZED_NAME_CORS_CONFIGURATION
- See Also:
-
SERIALIZED_NAME_WEBSUB_SUBSCRIPTION_CONFIGURATION
- See Also:
-
SERIALIZED_NAME_WORKFLOW_STATUS
- See Also:
-
SERIALIZED_NAME_CREATED_TIME
- See Also:
-
SERIALIZED_NAME_LAST_UPDATED_TIMESTAMP
- See Also:
-
SERIALIZED_NAME_LAST_UPDATED_TIME
- See Also:
-
SERIALIZED_NAME_ENDPOINT_CONFIG
- See Also:
-
SERIALIZED_NAME_PRIMARY_PRODUCTION_ENDPOINT_ID
- See Also:
-
SERIALIZED_NAME_PRIMARY_SANDBOX_ENDPOINT_ID
- See Also:
-
SERIALIZED_NAME_ENDPOINT_IMPLEMENTATION_TYPE
- See Also:
-
SERIALIZED_NAME_SCOPES
- See Also:
-
SERIALIZED_NAME_OPERATIONS
- See Also:
-
SERIALIZED_NAME_THREAT_PROTECTION_POLICIES
- See Also:
-
SERIALIZED_NAME_CATEGORIES
- See Also:
-
SERIALIZED_NAME_KEY_MANAGERS
- See Also:
-
SERIALIZED_NAME_SERVICE_INFO
- See Also:
-
SERIALIZED_NAME_ADVERTISE_INFO
- See Also:
-
SERIALIZED_NAME_GATEWAY_VENDOR
- See Also:
-
SERIALIZED_NAME_GATEWAY_TYPE
- See Also:
-
SERIALIZED_NAME_ASYNC_TRANSPORT_PROTOCOLS
- See Also:
-
SERIALIZED_NAME_INITIATED_FROM_GATEWAY
- See Also:
-
-
Constructor Details
-
APIDTO
public APIDTO()
-
-
Method Details
-
id
-
getId
UUID of the api registry artifact- Returns:
- id
-
setId
-
name
-
getName
Get name- Returns:
- name
-
setName
-
displayName
-
getDisplayName
Human-friendly name shown in UI. Length limited to DB column size.- Returns:
- displayName
-
setDisplayName
-
description
-
getDescription
Get description- Returns:
- description
-
setDescription
-
context
-
getContext
Get context- Returns:
- context
-
setContext
-
version
-
getVersion
Get version- Returns:
- version
-
setVersion
-
provider
-
getProvider
If the provider value is not given user invoking the api will be used as the provider.- Returns:
- provider
-
setProvider
-
lifeCycleStatus
-
getLifeCycleStatus
Get lifeCycleStatus- Returns:
- lifeCycleStatus
-
setLifeCycleStatus
-
wsdlInfo
-
getWsdlInfo
Get wsdlInfo- Returns:
- wsdlInfo
-
setWsdlInfo
-
wsdlUrl
-
getWsdlUrl
Get wsdlUrl- Returns:
- wsdlUrl
-
setWsdlUrl
-
responseCachingEnabled
-
isResponseCachingEnabled
Get responseCachingEnabled- Returns:
- responseCachingEnabled
-
setResponseCachingEnabled
-
cacheTimeout
-
getCacheTimeout
Get cacheTimeout- Returns:
- cacheTimeout
-
setCacheTimeout
-
hasThumbnail
-
isHasThumbnail
Get hasThumbnail- Returns:
- hasThumbnail
-
setHasThumbnail
-
isDefaultVersion
-
isIsDefaultVersion
Get isDefaultVersion- Returns:
- isDefaultVersion
-
setIsDefaultVersion
-
isRevision
-
isIsRevision
Get isRevision- Returns:
- isRevision
-
setIsRevision
-
revisionedApiId
-
getRevisionedApiId
UUID of the api registry artifact- Returns:
- revisionedApiId
-
setRevisionedApiId
-
revisionId
-
getRevisionId
Get revisionId- Returns:
- revisionId
-
setRevisionId
-
enableSchemaValidation
-
isEnableSchemaValidation
Get enableSchemaValidation- Returns:
- enableSchemaValidation
-
setEnableSchemaValidation
-
enableSubscriberVerification
-
isEnableSubscriberVerification
Get enableSubscriberVerification- Returns:
- enableSubscriberVerification
-
setEnableSubscriberVerification
-
type
-
getType
The api creation type to be used. Accepted values are HTTP, WS, SOAPTOREST, GRAPHQL, WEBSUB, SSE, WEBHOOK, ASYNC- Returns:
- type
-
setType
-
audience
-
getAudience
The audience of the API. Accepted values are PUBLIC, SINGLE- Returns:
- audience
-
setAudience
-
audiences
-
getAudiences
The audiences of the API for jwt validation. Accepted values are any String values- Returns:
- audiences
-
setAudiences
-
transport
-
getTransport
Supported transports for the API (http and/or https).- Returns:
- transport
-
setTransport
-
tags
-
getTags
Get tags- Returns:
- tags
-
setTags
-
policies
-
getPolicies
Get policies- Returns:
- policies
-
setPolicies
-
organizationPolicies
-
getOrganizationPolicies
Get organizationPolicies- Returns:
- organizationPolicies
-
setOrganizationPolicies
-
apiThrottlingPolicy
-
getApiThrottlingPolicy
The API level throttling policy selected for the particular API- Returns:
- apiThrottlingPolicy
-
setApiThrottlingPolicy
-
authorizationHeader
-
getAuthorizationHeader
Name of the Authorization header used for invoking the API. If it is not set, Authorization header name specified in tenant or system level will be used.- Returns:
- authorizationHeader
-
setAuthorizationHeader
-
apiKeyHeader
-
getApiKeyHeader
Name of the API key header used for invoking the API. If it is not set, default value `apiKey` will be used.- Returns:
- apiKeyHeader
-
setApiKeyHeader
-
securityScheme
-
getSecurityScheme
Types 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.- Returns:
- securityScheme
-
setSecurityScheme
-
maxTps
-
getMaxTps
Get maxTps- Returns:
- maxTps
-
setMaxTps
-
visibility
-
getVisibility
The visibility level of the API. Accepts one of the following. PUBLIC, PRIVATE, RESTRICTED.- Returns:
- visibility
-
setVisibility
-
visibleRoles
-
getVisibleRoles
The user roles that are able to access the API in Developer Portal- Returns:
- visibleRoles
-
setVisibleRoles
-
visibleTenants
-
getVisibleTenants
Get visibleTenants- Returns:
- visibleTenants
-
setVisibleTenants
-
visibleOrganizations
-
getVisibleOrganizations
The organizations that are able to access the API in Developer Portal- Returns:
- visibleOrganizations
-
setVisibleOrganizations
-
mediationPolicies
-
getMediationPolicies
Get mediationPolicies- Returns:
- mediationPolicies
-
setMediationPolicies
-
apiPolicies
-
getApiPolicies
Get apiPolicies- Returns:
- apiPolicies
-
setApiPolicies
-
subscriptionAvailability
public APIDTO subscriptionAvailability(APIDTO.SubscriptionAvailabilityEnum subscriptionAvailability) -
getSubscriptionAvailability
The subscription availability. Accepts one of the following. CURRENT_TENANT, ALL_TENANTS or SPECIFIC_TENANTS.- Returns:
- subscriptionAvailability
-
setSubscriptionAvailability
public void setSubscriptionAvailability(APIDTO.SubscriptionAvailabilityEnum subscriptionAvailability) -
subscriptionAvailableTenants
-
getSubscriptionAvailableTenants
Get subscriptionAvailableTenants- Returns:
- subscriptionAvailableTenants
-
setSubscriptionAvailableTenants
-
additionalProperties
-
getAdditionalProperties
Map of custom properties of API- Returns:
- additionalProperties
-
setAdditionalProperties
-
additionalPropertiesMap
public APIDTO additionalPropertiesMap(Map<String, APIInfoAdditionalPropertiesMapDTO> additionalPropertiesMap) -
getAdditionalPropertiesMap
Get additionalPropertiesMap- Returns:
- additionalPropertiesMap
-
setAdditionalPropertiesMap
public void setAdditionalPropertiesMap(Map<String, APIInfoAdditionalPropertiesMapDTO> additionalPropertiesMap) -
monetization
-
getMonetization
Get monetization- Returns:
- monetization
-
setMonetization
-
accessControl
-
getAccessControl
Is the API is restricted to certain set of publishers or creators or is it visible to all the publishers and creators. If the accessControl restriction is none, this API can be modified by all the publishers and creators, if not it can only be viewable/modifiable by certain set of publishers and creators, based on the restriction.- Returns:
- accessControl
-
setAccessControl
-
accessControlRoles
-
getAccessControlRoles
The user roles that are able to view/modify as API publisher or creator.- Returns:
- accessControlRoles
-
setAccessControlRoles
-
businessInformation
-
getBusinessInformation
Get businessInformation- Returns:
- businessInformation
-
setBusinessInformation
-
corsConfiguration
-
getCorsConfiguration
Get corsConfiguration- Returns:
- corsConfiguration
-
setCorsConfiguration
-
websubSubscriptionConfiguration
public APIDTO websubSubscriptionConfiguration(WebsubSubscriptionConfigurationDTO websubSubscriptionConfiguration) -
getWebsubSubscriptionConfiguration
Get websubSubscriptionConfiguration- Returns:
- websubSubscriptionConfiguration
-
setWebsubSubscriptionConfiguration
public void setWebsubSubscriptionConfiguration(WebsubSubscriptionConfigurationDTO websubSubscriptionConfiguration) -
workflowStatus
-
getWorkflowStatus
Get workflowStatus- Returns:
- workflowStatus
-
setWorkflowStatus
-
createdTime
-
getCreatedTime
Get createdTime- Returns:
- createdTime
-
setCreatedTime
-
lastUpdatedTimestamp
-
getLastUpdatedTimestamp
Get lastUpdatedTimestamp- Returns:
- lastUpdatedTimestamp
-
setLastUpdatedTimestamp
-
lastUpdatedTime
-
getLastUpdatedTime
Get lastUpdatedTime- Returns:
- lastUpdatedTime
-
setLastUpdatedTime
-
endpointConfig
-
getEndpointConfig
Endpoint configuration of the API. This can be used to provide different types of endpoints including Simple REST Endpoints, Loadbalanced and Failover. `Simple REST Endpoint` { \"endpoint_type\": \"http\", \"sandbox_endpoints\": { \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/\" }, \"production_endpoints\": { \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/\" } } `Loadbalanced Endpoint` { \"endpoint_type\": \"load_balance\", \"algoCombo\": \"org.apache.synapse.endpoints.algorithms.RoundRobin\", \"sessionManagement\": \"\", \"sandbox_endpoints\": [ { \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/1\" }, { \"endpoint_type\": \"http\", \"template_not_supported\": false, \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/2\" } ], \"production_endpoints\": [ { \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/3\" }, { \"endpoint_type\": \"http\", \"template_not_supported\": false, \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/4\" } ], \"sessionTimeOut\": \"\", \"algoClassName\": \"org.apache.synapse.endpoints.algorithms.RoundRobin\" } `Failover Endpoint` { \"production_failovers\":[ { \"endpoint_type\":\"http\", \"template_not_supported\":false, \"url\":\"https://localhost:9443/am/sample/pizzashack/v1/api/1\" } ], \"endpoint_type\":\"failover\", \"sandbox_endpoints\":{ \"url\":\"https://localhost:9443/am/sample/pizzashack/v1/api/2\" }, \"production_endpoints\":{ \"url\":\"https://localhost:9443/am/sample/pizzashack/v1/api/3\" }, \"sandbox_failovers\":[ { \"endpoint_type\":\"http\", \"template_not_supported\":false, \"url\":\"https://localhost:9443/am/sample/pizzashack/v1/api/4\" } ] } `Default Endpoint` { \"endpoint_type\":\"default\", \"sandbox_endpoints\":{ \"url\":\"default\" }, \"production_endpoints\":{ \"url\":\"default\" } } `Endpoint from Endpoint Registry` { \"endpoint_type\": \"Registry\", \"endpoint_id\": \"{registry-name:entry-name:version}\", }- Returns:
- endpointConfig
-
setEndpointConfig
-
-
getPrimaryProductionEndpointId
Get primaryProductionEndpointId- Returns:
- primaryProductionEndpointId
-
setPrimaryProductionEndpointId
-
primarySandboxEndpointId
-
getPrimarySandboxEndpointId
Get primarySandboxEndpointId- Returns:
- primarySandboxEndpointId
-
setPrimarySandboxEndpointId
-
endpointImplementationType
public APIDTO endpointImplementationType(APIDTO.EndpointImplementationTypeEnum endpointImplementationType) -
getEndpointImplementationType
Get endpointImplementationType- Returns:
- endpointImplementationType
-
setEndpointImplementationType
public void setEndpointImplementationType(APIDTO.EndpointImplementationTypeEnum endpointImplementationType) -
scopes
-
getScopes
Get scopes- Returns:
- scopes
-
setScopes
-
operations
-
getOperations
Get operations- Returns:
- operations
-
setOperations
-
threatProtectionPolicies
-
getThreatProtectionPolicies
Get threatProtectionPolicies- Returns:
- threatProtectionPolicies
-
setThreatProtectionPolicies
-
categories
-
getCategories
API categories- Returns:
- categories
-
setCategories
-
keyManagers
-
getKeyManagers
API Key Managers- Returns:
- keyManagers
-
setKeyManagers
-
serviceInfo
-
getServiceInfo
Get serviceInfo- Returns:
- serviceInfo
-
setServiceInfo
-
advertiseInfo
-
getAdvertiseInfo
Get advertiseInfo- Returns:
- advertiseInfo
-
setAdvertiseInfo
-
gatewayVendor
-
getGatewayVendor
Get gatewayVendor- Returns:
- gatewayVendor
-
setGatewayVendor
-
gatewayType
-
getGatewayType
The gateway type selected for the API policies. Accepts one of the following. wso2/synapse, wso2/apk.- Returns:
- gatewayType
-
setGatewayType
-
asyncTransportProtocols
-
getAsyncTransportProtocols
Supported transports for the async API (http and/or https).- Returns:
- asyncTransportProtocols
-
setAsyncTransportProtocols
-
initiatedFromGateway
-
isInitiatedFromGateway
Whether the API is initiated from the gateway or not. This is used to identify whether the API is created from the publisher or discovered from the gateway.- Returns:
- initiatedFromGateway
-
setInitiatedFromGateway
-
equals
-
hashCode
public int hashCode() -
toString
-