Share via

ApiCreateOrUpdateParameter Class

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
  • java.lang.Object
    • com.microsoft.azure.management.apimanagement.v2019_01_01.ApiCreateOrUpdateParameter

public class ApiCreateOrUpdateParameter

API Create or Update Parameters.

Constructor Summary

Constructor Description
ApiCreateOrUpdateParameter()

Method Summary

Modifier and Type Method and Description
java.lang.String apiRevision()

Get describes the Revision of the Api.
java.lang.String apiRevisionDescription()

Get description of the Api Revision.
ApiType apiType()

Get type of API.
java.lang.String apiVersion()

Get indicates the Version identifier of the API if the API is versioned.
java.lang.String apiVersionDescription()

Get description of the Api Version.
ApiVersionSetContractDetails apiVersionSet()

Get version set details.
java.lang.String apiVersionSetId()

Get a resource identifier for the related ApiVersionSet.
AuthenticationSettingsContract authenticationSettings()

Get collection of authentication settings included into this API.
java.lang.String description()

Get description of the API.
java.lang.String displayName()

Get aPI name.
ContentFormat format()

Get format of the Content in which the API is getting imported.
java.lang.Boolean isCurrent()

Get indicates if API revision is current api revision.
java.lang.Boolean isOnline()

Get indicates if API revision is accessible via the gateway.
java.lang.String path()

Get relative URL uniquely identifying this API and all of its resource paths within the API Management service instance.
java.util.List<Protocol> protocols()

Get describes on which protocols the operations in this API can be invoked.
java.lang.String serviceUrl()

Get absolute URL of the backend service implementing this API.
SoapApiType soapApiType()

Get type of Api to create.
java.lang.String sourceApiId()

Get aPI identifier of the source API.
SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames()

Get protocols over which API is made available.
java.lang.Boolean subscriptionRequired()

Get specifies whether an API or Product subscription is required for accessing the API.
java.lang.String value()

Get content value when Importing an API.
ApiCreateOrUpdateParameter withApiRevision(String apiRevision)

Set describes the Revision of the Api.
ApiCreateOrUpdateParameter withApiRevisionDescription(String apiRevisionDescription)

Set description of the Api Revision.
ApiCreateOrUpdateParameter withApiType(ApiType apiType)

Set type of API.
ApiCreateOrUpdateParameter withApiVersion(String apiVersion)

Set indicates the Version identifier of the API if the API is versioned.
ApiCreateOrUpdateParameter withApiVersionDescription(String apiVersionDescription)

Set description of the Api Version.
ApiCreateOrUpdateParameter withApiVersionSet(ApiVersionSetContractDetails apiVersionSet)

Set version set details.
ApiCreateOrUpdateParameter withApiVersionSetId(String apiVersionSetId)

Set a resource identifier for the related ApiVersionSet.
ApiCreateOrUpdateParameter withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)

Set collection of authentication settings included into this API.
ApiCreateOrUpdateParameter withDescription(String description)

Set description of the API.
ApiCreateOrUpdateParameter withDisplayName(String displayName)

Set aPI name.
ApiCreateOrUpdateParameter withFormat(ContentFormat format)

Set format of the Content in which the API is getting imported.
ApiCreateOrUpdateParameter withIsCurrent(Boolean isCurrent)

Set indicates if API revision is current api revision.
ApiCreateOrUpdateParameter withPath(String path)

Set relative URL uniquely identifying this API and all of its resource paths within the API Management service instance.
ApiCreateOrUpdateParameter withProtocols(List<Protocol> protocols)

Set describes on which protocols the operations in this API can be invoked.
ApiCreateOrUpdateParameter withServiceUrl(String serviceUrl)

Set absolute URL of the backend service implementing this API.
ApiCreateOrUpdateParameter withSoapApiType(SoapApiType soapApiType)

Set type of Api to create.
ApiCreateOrUpdateParameter withSourceApiId(String sourceApiId)

Set aPI identifier of the source API.
ApiCreateOrUpdateParameter withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)

Set protocols over which API is made available.
ApiCreateOrUpdateParameter withSubscriptionRequired(Boolean subscriptionRequired)

Set specifies whether an API or Product subscription is required for accessing the API.
ApiCreateOrUpdateParameter withValue(String value)

Set content value when Importing an API.
ApiCreateOrUpdateParameter withWsdlSelector(ApiCreateOrUpdatePropertiesWsdlSelector wsdlSelector)

Set criteria to limit import of WSDL to a subset of the document.
ApiCreateOrUpdatePropertiesWsdlSelector wsdlSelector()

Get criteria to limit import of WSDL to a subset of the document.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ApiCreateOrUpdateParameter

public ApiCreateOrUpdateParameter()

Method Details

apiRevision

public String apiRevision()

Get describes the Revision of the Api. If no value is provided, default revision 1 is created.

Returns:

the apiRevision value

apiRevisionDescription

public String apiRevisionDescription()

Get description of the Api Revision.

Returns:

the apiRevisionDescription value

apiType

public ApiType apiType()

Get type of API. Possible values include: 'http', 'soap'.

Returns:

the apiType value

apiVersion

public String apiVersion()

Get indicates the Version identifier of the API if the API is versioned.

Returns:

the apiVersion value

apiVersionDescription

public String apiVersionDescription()

Get description of the Api Version.

Returns:

the apiVersionDescription value

apiVersionSet

public ApiVersionSetContractDetails apiVersionSet()

Get version set details.

Returns:

the apiVersionSet value

apiVersionSetId

public String apiVersionSetId()

Get a resource identifier for the related ApiVersionSet.

Returns:

the apiVersionSetId value

authenticationSettings

public AuthenticationSettingsContract authenticationSettings()

Get collection of authentication settings included into this API.

Returns:

the authenticationSettings value

description

public String description()

Get description of the API. May include HTML formatting tags.

Returns:

the description value

displayName

public String displayName()

Get aPI name. Must be 1 to 300 characters long.

Returns:

the displayName value

format

public ContentFormat format()

Get format of the Content in which the API is getting imported. Possible values include: 'wadl-xml', 'wadl-link-json', 'swagger-json', 'swagger-link-json', 'wsdl', 'wsdl-link', 'openapi', 'openapi+json', 'openapi-link'.

Returns:

the format value

isCurrent

public Boolean isCurrent()

Get indicates if API revision is current api revision.

Returns:

the isCurrent value

isOnline

public Boolean isOnline()

Get indicates if API revision is accessible via the gateway.

Returns:

the isOnline value

path

public String path()

Get relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Returns:

the path value

protocols

public List<Protocol> protocols()

Get describes on which protocols the operations in this API can be invoked.

Returns:

the protocols value

serviceUrl

public String serviceUrl()

Get absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

Returns:

the serviceUrl value

soapApiType

public SoapApiType soapApiType()

Get type of Api to create. `http` creates a SOAP to REST API `soap` creates a SOAP pass-through API. Possible values include: 'SoapToRest', 'SoapPassThrough'.

Returns:

the soapApiType value

sourceApiId

public String sourceApiId()

Get aPI identifier of the source API.

Returns:

the sourceApiId value

subscriptionKeyParameterNames

public SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames()

Get protocols over which API is made available.

Returns:

the subscriptionKeyParameterNames value

subscriptionRequired

public Boolean subscriptionRequired()

Get specifies whether an API or Product subscription is required for accessing the API.

Returns:

the subscriptionRequired value

value

public String value()

Get content value when Importing an API.

Returns:

the value value

withApiRevision

public ApiCreateOrUpdateParameter withApiRevision(String apiRevision)

Set describes the Revision of the Api. If no value is provided, default revision 1 is created.

Parameters:

apiRevision - the apiRevision value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withApiRevisionDescription

public ApiCreateOrUpdateParameter withApiRevisionDescription(String apiRevisionDescription)

Set description of the Api Revision.

Parameters:

apiRevisionDescription - the apiRevisionDescription value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withApiType

public ApiCreateOrUpdateParameter withApiType(ApiType apiType)

Set type of API. Possible values include: 'http', 'soap'.

Parameters:

apiType - the apiType value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withApiVersion

public ApiCreateOrUpdateParameter withApiVersion(String apiVersion)

Set indicates the Version identifier of the API if the API is versioned.

Parameters:

apiVersion - the apiVersion value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withApiVersionDescription

public ApiCreateOrUpdateParameter withApiVersionDescription(String apiVersionDescription)

Set description of the Api Version.

Parameters:

apiVersionDescription - the apiVersionDescription value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withApiVersionSet

public ApiCreateOrUpdateParameter withApiVersionSet(ApiVersionSetContractDetails apiVersionSet)

Set version set details.

Parameters:

apiVersionSet - the apiVersionSet value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withApiVersionSetId

public ApiCreateOrUpdateParameter withApiVersionSetId(String apiVersionSetId)

Set a resource identifier for the related ApiVersionSet.

Parameters:

apiVersionSetId - the apiVersionSetId value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withAuthenticationSettings

public ApiCreateOrUpdateParameter withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)

Set collection of authentication settings included into this API.

Parameters:

authenticationSettings - the authenticationSettings value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withDescription

public ApiCreateOrUpdateParameter withDescription(String description)

Set description of the API. May include HTML formatting tags.

Parameters:

description - the description value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withDisplayName

public ApiCreateOrUpdateParameter withDisplayName(String displayName)

Set aPI name. Must be 1 to 300 characters long.

Parameters:

displayName - the displayName value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withFormat

public ApiCreateOrUpdateParameter withFormat(ContentFormat format)

Set format of the Content in which the API is getting imported. Possible values include: 'wadl-xml', 'wadl-link-json', 'swagger-json', 'swagger-link-json', 'wsdl', 'wsdl-link', 'openapi', 'openapi+json', 'openapi-link'.

Parameters:

format - the format value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withIsCurrent

public ApiCreateOrUpdateParameter withIsCurrent(Boolean isCurrent)

Set indicates if API revision is current api revision.

Parameters:

isCurrent - the isCurrent value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withPath

public ApiCreateOrUpdateParameter withPath(String path)

Set relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Parameters:

path - the path value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withProtocols

public ApiCreateOrUpdateParameter withProtocols(List<Protocol> protocols)

Set describes on which protocols the operations in this API can be invoked.

Parameters:

protocols - the protocols value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withServiceUrl

public ApiCreateOrUpdateParameter withServiceUrl(String serviceUrl)

Set absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

Parameters:

serviceUrl - the serviceUrl value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withSoapApiType

public ApiCreateOrUpdateParameter withSoapApiType(SoapApiType soapApiType)

Set type of Api to create. `http` creates a SOAP to REST API `soap` creates a SOAP pass-through API. Possible values include: 'SoapToRest', 'SoapPassThrough'.

Parameters:

soapApiType - the soapApiType value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withSourceApiId

public ApiCreateOrUpdateParameter withSourceApiId(String sourceApiId)

Set aPI identifier of the source API.

Parameters:

sourceApiId - the sourceApiId value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withSubscriptionKeyParameterNames

public ApiCreateOrUpdateParameter withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)

Set protocols over which API is made available.

Parameters:

subscriptionKeyParameterNames - the subscriptionKeyParameterNames value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withSubscriptionRequired

public ApiCreateOrUpdateParameter withSubscriptionRequired(Boolean subscriptionRequired)

Set specifies whether an API or Product subscription is required for accessing the API.

Parameters:

subscriptionRequired - the subscriptionRequired value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withValue

public ApiCreateOrUpdateParameter withValue(String value)

Set content value when Importing an API.

Parameters:

value - the value value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

withWsdlSelector

public ApiCreateOrUpdateParameter withWsdlSelector(ApiCreateOrUpdatePropertiesWsdlSelector wsdlSelector)

Set criteria to limit import of WSDL to a subset of the document.

Parameters:

wsdlSelector - the wsdlSelector value to set

Returns:

the ApiCreateOrUpdateParameter object itself.

wsdlSelector

public ApiCreateOrUpdatePropertiesWsdlSelector wsdlSelector()

Get criteria to limit import of WSDL to a subset of the document.

Returns:

the wsdlSelector value

Applies to