Package io.github.primelib.webmethodsapigateway4j.spec

Klasse ImportExportAPIGatewayAssetsOperationSpec

java.lang.Object
io.github.primelib.webmethodsapigateway4j.spec.ImportExportAPIGatewayAssetsOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class ImportExportAPIGatewayAssetsOperationSpec extends Object
ImportExportAPIGatewayAssetsSpec

Specification for the ImportExportAPIGatewayAssets operation.

  • Felddetails

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Konstruktordetails

  • Methodendetails

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Löst aus:
      NullPointerException

    • overwrite

      @Nullable public @Nullable String overwrite()
      This parameter specifies the import option to define the artifact types that can be overwritten during import. The parameter enables you to specify overwriting of APIs, policies, policy actions, aliases, applications, configurations, approval configurations, outbound proxies, URL aliases, keyStores, trustStores, JNDI provider aliases, JMS connection aliases, JMS triggers, webservice endpoint aliases, users, groups, teams, kerberos settings, plans and packages. The wildcard "*" enables you to specify all types. For example, the following request enables you to overwrite APIs during import: POST /rest/apigateway/archive?overwrite=apis Whereas, overwriting all asset types during import can be specified as follows: POST /rest/apigateway/archive?overwrite=*

    • fixingMissingVersions

      @Nullable public @Nullable String fixingMissingVersions()

    • preserveAssetState

      @Nullable public @Nullable String preserveAssetState()
      This parameter is used to specify whether the asset state needs to be preserved after importing the assets in to API Gateway. By default this value will be true. If false specified the assets will be imported and wont preserve asset state after importing asset.

    • policies

      @Nullable public @Nullable List<String> policies()
      This parameter identifies the policies to be imported. The wildcard "*" selects all the policies. For example a single policy can be imported with its id using the following request: POST /rest/apigateway/archive?policies=07b8d7b7-20b7-422e-8464-4b19d405c41a Whereas, all the policies can be imported using the following request: POST /rest/apigateway/archive?policies=*

    • apis

      @Nullable public @Nullable List<String> apis()
      This parameter identifies the APIs to be imported. The wildcard "*" selects all the APIs. For example a single API can be imported using the following request: POST /rest/apigateway/archive?apis=e2996867-af49-4ac6-98e7-cba48837c13e Whereas, all the APIs can be imported using the following request: POST /rest/apigateway/archive?apis=*

    • aliases

      @Nullable public @Nullable List<String> aliases()
      This parameter identifies the aliases to be imported. The wildcard "*" selects all aliases. For example, a single alias can be imported using the following requrest: POST /rest/apigateway/archive?aliases=d1885756-9e38-39b5-87d6-ba937726b02d Whereas, all the APIs can be imported using the following request: POST /rest/apigateway/archive?alias=*

    • applications

      @Nullable public @Nullable List<String> applications()
      This parameter identifies the applications to be imported. The wildcard "*" selects all applications. For example, a single application can be imported using the following requrest: POST /rest/apigateway/archive?applications=d1885756-9e38-39b5-87d6-ba937726b02d Whereas, all the applications can be imported using the following request: POST /rest/apigateway/archive?applications=*

    • approvalConfigurations

      @Nullable public @Nullable List<String> approvalConfigurations()
      This parameter identifies the approval configurations to be imported. The wildcard "*" selects all approval configurations. For example, a single approval configuration can be imported using the following request: POST /rest/apigateway/archive?approvalConfigurations=createApplication Whereas, all the approval configurations can be imported using the following request: POST /rest/apigateway/archive?approvalConfigurations=*

    • outboundProxies

      @Nullable public @Nullable List<String> outboundProxies()
      This parameter identifies the outbound proxy aliases to be imported. outbound proxy aliases are identified with it's name. The wildcard "*" selects all the outbound proxy aliases. For example a single outbound proxy alias can be imported using the following request: POST /rest/apigateway/archive?outboundProxies=testOutboundProxyAlias Whereas, all the outbound proxy aliases can be imported using the following request: POST /rest/apigateway/archive?outboundProxies=*

    • urlAliases

      @Nullable public @Nullable List<String> urlAliases()
      This parameter identifies the URL aliases to be imported. URL aliases are identified with it's name. The wildcard "*" selects all the URL aliases. For example, a single URL alias can be imported using the following request: POST /rest/apigateway/archive?urlAliases=testUrlAlias Whereas, all the URL aliases can be imported using the following request: POST /rest/apigateway/archive?testUrlAlias=*

    • keyStores

      @Nullable public @Nullable List<String> keyStores()
      This parameter identifies the keystore aliases to be imported. Keystore aliases are identified with it's name. The wildcard "*" selects all the keystore aliases. For example, a single keystore alias can be imported using the following request: POST /rest/apigateway/archive?keyStores=test_keystore Whereas, all the keystore aliases can be imported using the following request: POST /rest/apigateway/archive?keyStores=*

    • trustStores

      @Nullable public @Nullable List<String> trustStores()
      This parameter identifies the truststore aliases to be imported. Truststore aliases are identified with it's name. The wildcard "*" selects all the truststore aliases. For example, a single truststore alias can be imported using the following request: POST /rest/apigateway/archive?trustStores=test_truststore Whereas, all the truststore aliases can be imported using the following request: POST /rest/apigateway/archive?trustStores=*

    • jnDIProviderAliases

      @Nullable public @Nullable List<String> jnDIProviderAliases()
      This parameter identifies the JNDI provider aliases to be imported. JNDI provider aliases are identified with it's name. The wildcard "*" selects all the JNDI provider aliases. For example, a single JNDI provider alias can be imported using the following request: POST /rest/apigateway/archive?JNDIProviderAliases=test_jndiProviderAlias Whereas, all the JNDI provider aliases can be imported using the following request: POST /rest/apigateway/archive?JNDIProviderAliases=*

    • jmSConnectionAliases

      @Nullable public @Nullable List<String> jmSConnectionAliases()
      This parameter identifies the JMS connection aliases to be imported. JMS connection aliases are identified with it's name. The wildcard "*" selects all the JNDI provider aliases. For example, a single JNDI provider alias can be imported using the following request: POST /rest/apigateway/archive?JMSConnectionAliases=test_jmsConnectionAlias Whereas, all the JMS connection aliases can be imported using the following request: POST /rest/apigateway/archive?JMSConnectionAliases=*

    • jmSTriggers

      @Nullable public @Nullable List<String> jmSTriggers()
      This parameter identifies the JMS triggers to be imported. JMS triggers are identified with it's name. The wildcard "*" selects all the JMS triggers. For example, a single JMS trigger can be imported using the following request: POST /rest/apigateway/archive?JMSTriggers=test_jmsTrigger Whereas, all the JMS triggers can be imported using the following request: POST /rest/apigateway/archive?JMSTriggers=*

    • webserviceEndpointAliases

      @Nullable public @Nullable List<String> webserviceEndpointAliases()
      This parameter identifies the 'web service endpoint' aliases to be imported. Web service endpoint aliases are identified with it's name. The wildcard "*" selects all the web service endpoint aliases. For example, a single web service endpoint alias can be imported using the following request: POST /rest/apigateway/archive?webserviceEndpointAliases=test_wsEndpointAlias Whereas, all the JMS triggers can be imported using the following request: POST /rest/apigateway/archive?webserviceEndpointAliases=*

    • users

      @Nullable public @Nullable List<String> users()
      This parameter identifies the users to be imported. The wildcard "*" selects all the users. For example, a single user can be imported using the following request: POST /rest/apigateway/archive?users=7a6d3d40-44d8-4ab1-83df-5be63cdbae54 Whereas, all the users can be imported using the following request: POST /rest/apigateway/archive?users=*

    • groups

      @Nullable public @Nullable List<String> groups()
      This parameter identifies the groups to be imported. The wildcard "*" selects all the groups. For example, a single group can be imported using the following request: POST /rest/apigateway/archive?groups=d6b38ff8-59a8-47bf-9fba-0bdb24ee5b48 Whereas, all the groups can be imported using the following request: POST /rest/apigateway/archive?groups=*

    • accessProfiles

      @Nullable public @Nullable List<String> accessProfiles()
      This parameter identifies the teams to be imported. The wildcard "*" selects all the teams. For example, a single team can be imported using the following request: POST /rest/apigateway/archive?accessProfiles=d6b38ff8-59a8-47bf-9fba-0bdb24ee5b48 Whereas, all the teams can be imported using the following request: POST /rest/apigateway/archive?accessProfiles=*

    • kerberosSetting

      @Nullable public @Nullable String kerberosSetting()
      This parameter identifies the kerberos configuration to be imported. The kerberos configuration can be imported using the following request: POST /rest/apigateway/archive?kerberosSetting=kerberosSetting

    • plans

      @Nullable public @Nullable List<String> plans()
      This parameter identifies the plans to be imported. The wildcard "*" selects all the plans. For example, a single plan can be imported using the following request: POST /rest/apigateway/archive?plans=86d58023-be4b-4735-a08f-14e78131ce4a Whereas, all the plans can be imported using the following request: POST /rest/apigateway/archive?plans=*

    • packages

      @Nullable public @Nullable List<String> packages()
      This parameter identifies the packages to be imported. The wildcard "*" selects all the packages. For example, a single package can be imported using the following request: POST /rest/apigateway/archive?packages=73c93393-1477-4a99-9e44-c9b3e679de0c Whereas, all the packages can be imported using the following request: POST /rest/apigateway/archive?packages=*

    • configurations

      @Nullable public @Nullable List<String> configurations()
      This parameter identifies the configurations to be imported. The wildcard "*" selects all the configurations. For example, a single configuration can be imported using the following request: POST /rest/apigateway/archive?configurations=loadBalancer,customContentTypes Whereas, all the configurations can be imported using the following request: POST /rest/apigateway/archive?configurations=*

    • gatewayScopes

      @Nullable public @Nullable List<String> gatewayScopes()
      This parameter identifies the oauth scopes to be imported. The wildcard "*" selects all the oauth scopes. For example, a single oauth scope can be imported using the following request: POST /rest/apigateway/archive?gatewayScopes=73c93393-1477-4a99-9e44-c9b3e679de0c Whereas, all the oauth scopes can be imported using the following request: POST /rest/apigateway/archive?gatewayScopes=*

    • xHTTPMethodOverride

      @Nullable public @Nullable String xHTTPMethodOverride()
      This parameter is used to specify that this REST call is an export operation. The value for this field is GET. If this is specified then you need to provide the filtering criteria in body to specify the asset. If empty payload specified then all assets will be exported.

    • zipFile

      @Nullable public @Nullable File zipFile()
      Zip file that contains the API Gateway asset needs to be imported

    • overwrite

      public ImportExportAPIGatewayAssetsOperationSpec overwrite(@Nullable @Nullable String overwrite)
      This parameter specifies the import option to define the artifact types that can be overwritten during import. The parameter enables you to specify overwriting of APIs, policies, policy actions, aliases, applications, configurations, approval configurations, outbound proxies, URL aliases, keyStores, trustStores, JNDI provider aliases, JMS connection aliases, JMS triggers, webservice endpoint aliases, users, groups, teams, kerberos settings, plans and packages. The wildcard "*" enables you to specify all types. For example, the following request enables you to overwrite APIs during import: POST /rest/apigateway/archive?overwrite=apis Whereas, overwriting all asset types during import can be specified as follows: POST /rest/apigateway/archive?overwrite=*
      Gibt zurück:
      this.

    • fixingMissingVersions

      public ImportExportAPIGatewayAssetsOperationSpec fixingMissingVersions(@Nullable @Nullable String fixingMissingVersions)
      Gibt zurück:
      this.

    • preserveAssetState

      public ImportExportAPIGatewayAssetsOperationSpec preserveAssetState(@Nullable @Nullable String preserveAssetState)
      This parameter is used to specify whether the asset state needs to be preserved after importing the assets in to API Gateway. By default this value will be true. If false specified the assets will be imported and wont preserve asset state after importing asset.
      Gibt zurück:
      this.

    • policies

      public ImportExportAPIGatewayAssetsOperationSpec policies(@Nullable @Nullable List<String> policies)
      This parameter identifies the policies to be imported. The wildcard "*" selects all the policies. For example a single policy can be imported with its id using the following request: POST /rest/apigateway/archive?policies=07b8d7b7-20b7-422e-8464-4b19d405c41a Whereas, all the policies can be imported using the following request: POST /rest/apigateway/archive?policies=*
      Gibt zurück:
      this.

    • apis

      public ImportExportAPIGatewayAssetsOperationSpec apis(@Nullable @Nullable List<String> apis)
      This parameter identifies the APIs to be imported. The wildcard "*" selects all the APIs. For example a single API can be imported using the following request: POST /rest/apigateway/archive?apis=e2996867-af49-4ac6-98e7-cba48837c13e Whereas, all the APIs can be imported using the following request: POST /rest/apigateway/archive?apis=*
      Gibt zurück:
      this.

    • aliases

      public ImportExportAPIGatewayAssetsOperationSpec aliases(@Nullable @Nullable List<String> aliases)
      This parameter identifies the aliases to be imported. The wildcard "*" selects all aliases. For example, a single alias can be imported using the following requrest: POST /rest/apigateway/archive?aliases=d1885756-9e38-39b5-87d6-ba937726b02d Whereas, all the APIs can be imported using the following request: POST /rest/apigateway/archive?alias=*
      Gibt zurück:
      this.

    • applications

      public ImportExportAPIGatewayAssetsOperationSpec applications(@Nullable @Nullable List<String> applications)
      This parameter identifies the applications to be imported. The wildcard "*" selects all applications. For example, a single application can be imported using the following requrest: POST /rest/apigateway/archive?applications=d1885756-9e38-39b5-87d6-ba937726b02d Whereas, all the applications can be imported using the following request: POST /rest/apigateway/archive?applications=*
      Gibt zurück:
      this.

    • approvalConfigurations

      public ImportExportAPIGatewayAssetsOperationSpec approvalConfigurations(@Nullable @Nullable List<String> approvalConfigurations)
      This parameter identifies the approval configurations to be imported. The wildcard "*" selects all approval configurations. For example, a single approval configuration can be imported using the following request: POST /rest/apigateway/archive?approvalConfigurations=createApplication Whereas, all the approval configurations can be imported using the following request: POST /rest/apigateway/archive?approvalConfigurations=*
      Gibt zurück:
      this.

    • outboundProxies

      public ImportExportAPIGatewayAssetsOperationSpec outboundProxies(@Nullable @Nullable List<String> outboundProxies)
      This parameter identifies the outbound proxy aliases to be imported. outbound proxy aliases are identified with it's name. The wildcard "*" selects all the outbound proxy aliases. For example a single outbound proxy alias can be imported using the following request: POST /rest/apigateway/archive?outboundProxies=testOutboundProxyAlias Whereas, all the outbound proxy aliases can be imported using the following request: POST /rest/apigateway/archive?outboundProxies=*
      Gibt zurück:
      this.

    • urlAliases

      public ImportExportAPIGatewayAssetsOperationSpec urlAliases(@Nullable @Nullable List<String> urlAliases)
      This parameter identifies the URL aliases to be imported. URL aliases are identified with it's name. The wildcard "*" selects all the URL aliases. For example, a single URL alias can be imported using the following request: POST /rest/apigateway/archive?urlAliases=testUrlAlias Whereas, all the URL aliases can be imported using the following request: POST /rest/apigateway/archive?testUrlAlias=*
      Gibt zurück:
      this.

    • keyStores

      public ImportExportAPIGatewayAssetsOperationSpec keyStores(@Nullable @Nullable List<String> keyStores)
      This parameter identifies the keystore aliases to be imported. Keystore aliases are identified with it's name. The wildcard "*" selects all the keystore aliases. For example, a single keystore alias can be imported using the following request: POST /rest/apigateway/archive?keyStores=test_keystore Whereas, all the keystore aliases can be imported using the following request: POST /rest/apigateway/archive?keyStores=*
      Gibt zurück:
      this.

    • trustStores

      public ImportExportAPIGatewayAssetsOperationSpec trustStores(@Nullable @Nullable List<String> trustStores)
      This parameter identifies the truststore aliases to be imported. Truststore aliases are identified with it's name. The wildcard "*" selects all the truststore aliases. For example, a single truststore alias can be imported using the following request: POST /rest/apigateway/archive?trustStores=test_truststore Whereas, all the truststore aliases can be imported using the following request: POST /rest/apigateway/archive?trustStores=*
      Gibt zurück:
      this.

    • jnDIProviderAliases

      public ImportExportAPIGatewayAssetsOperationSpec jnDIProviderAliases(@Nullable @Nullable List<String> jnDIProviderAliases)
      This parameter identifies the JNDI provider aliases to be imported. JNDI provider aliases are identified with it's name. The wildcard "*" selects all the JNDI provider aliases. For example, a single JNDI provider alias can be imported using the following request: POST /rest/apigateway/archive?JNDIProviderAliases=test_jndiProviderAlias Whereas, all the JNDI provider aliases can be imported using the following request: POST /rest/apigateway/archive?JNDIProviderAliases=*
      Gibt zurück:
      this.

    • jmSConnectionAliases

      public ImportExportAPIGatewayAssetsOperationSpec jmSConnectionAliases(@Nullable @Nullable List<String> jmSConnectionAliases)
      This parameter identifies the JMS connection aliases to be imported. JMS connection aliases are identified with it's name. The wildcard "*" selects all the JNDI provider aliases. For example, a single JNDI provider alias can be imported using the following request: POST /rest/apigateway/archive?JMSConnectionAliases=test_jmsConnectionAlias Whereas, all the JMS connection aliases can be imported using the following request: POST /rest/apigateway/archive?JMSConnectionAliases=*
      Gibt zurück:
      this.

    • jmSTriggers

      public ImportExportAPIGatewayAssetsOperationSpec jmSTriggers(@Nullable @Nullable List<String> jmSTriggers)
      This parameter identifies the JMS triggers to be imported. JMS triggers are identified with it's name. The wildcard "*" selects all the JMS triggers. For example, a single JMS trigger can be imported using the following request: POST /rest/apigateway/archive?JMSTriggers=test_jmsTrigger Whereas, all the JMS triggers can be imported using the following request: POST /rest/apigateway/archive?JMSTriggers=*
      Gibt zurück:
      this.

    • webserviceEndpointAliases

      public ImportExportAPIGatewayAssetsOperationSpec webserviceEndpointAliases(@Nullable @Nullable List<String> webserviceEndpointAliases)
      This parameter identifies the 'web service endpoint' aliases to be imported. Web service endpoint aliases are identified with it's name. The wildcard "*" selects all the web service endpoint aliases. For example, a single web service endpoint alias can be imported using the following request: POST /rest/apigateway/archive?webserviceEndpointAliases=test_wsEndpointAlias Whereas, all the JMS triggers can be imported using the following request: POST /rest/apigateway/archive?webserviceEndpointAliases=*
      Gibt zurück:
      this.

    • users

      public ImportExportAPIGatewayAssetsOperationSpec users(@Nullable @Nullable List<String> users)
      This parameter identifies the users to be imported. The wildcard "*" selects all the users. For example, a single user can be imported using the following request: POST /rest/apigateway/archive?users=7a6d3d40-44d8-4ab1-83df-5be63cdbae54 Whereas, all the users can be imported using the following request: POST /rest/apigateway/archive?users=*
      Gibt zurück:
      this.

    • groups

      public ImportExportAPIGatewayAssetsOperationSpec groups(@Nullable @Nullable List<String> groups)
      This parameter identifies the groups to be imported. The wildcard "*" selects all the groups. For example, a single group can be imported using the following request: POST /rest/apigateway/archive?groups=d6b38ff8-59a8-47bf-9fba-0bdb24ee5b48 Whereas, all the groups can be imported using the following request: POST /rest/apigateway/archive?groups=*
      Gibt zurück:
      this.

    • accessProfiles

      public ImportExportAPIGatewayAssetsOperationSpec accessProfiles(@Nullable @Nullable List<String> accessProfiles)
      This parameter identifies the teams to be imported. The wildcard "*" selects all the teams. For example, a single team can be imported using the following request: POST /rest/apigateway/archive?accessProfiles=d6b38ff8-59a8-47bf-9fba-0bdb24ee5b48 Whereas, all the teams can be imported using the following request: POST /rest/apigateway/archive?accessProfiles=*
      Gibt zurück:
      this.

    • kerberosSetting

      public ImportExportAPIGatewayAssetsOperationSpec kerberosSetting(@Nullable @Nullable String kerberosSetting)
      This parameter identifies the kerberos configuration to be imported. The kerberos configuration can be imported using the following request: POST /rest/apigateway/archive?kerberosSetting=kerberosSetting
      Gibt zurück:
      this.

    • plans

      public ImportExportAPIGatewayAssetsOperationSpec plans(@Nullable @Nullable List<String> plans)
      This parameter identifies the plans to be imported. The wildcard "*" selects all the plans. For example, a single plan can be imported using the following request: POST /rest/apigateway/archive?plans=86d58023-be4b-4735-a08f-14e78131ce4a Whereas, all the plans can be imported using the following request: POST /rest/apigateway/archive?plans=*
      Gibt zurück:
      this.

    • packages

      public ImportExportAPIGatewayAssetsOperationSpec packages(@Nullable @Nullable List<String> packages)
      This parameter identifies the packages to be imported. The wildcard "*" selects all the packages. For example, a single package can be imported using the following request: POST /rest/apigateway/archive?packages=73c93393-1477-4a99-9e44-c9b3e679de0c Whereas, all the packages can be imported using the following request: POST /rest/apigateway/archive?packages=*
      Gibt zurück:
      this.

    • configurations

      public ImportExportAPIGatewayAssetsOperationSpec configurations(@Nullable @Nullable List<String> configurations)
      This parameter identifies the configurations to be imported. The wildcard "*" selects all the configurations. For example, a single configuration can be imported using the following request: POST /rest/apigateway/archive?configurations=loadBalancer,customContentTypes Whereas, all the configurations can be imported using the following request: POST /rest/apigateway/archive?configurations=*
      Gibt zurück:
      this.

    • gatewayScopes

      public ImportExportAPIGatewayAssetsOperationSpec gatewayScopes(@Nullable @Nullable List<String> gatewayScopes)
      This parameter identifies the oauth scopes to be imported. The wildcard "*" selects all the oauth scopes. For example, a single oauth scope can be imported using the following request: POST /rest/apigateway/archive?gatewayScopes=73c93393-1477-4a99-9e44-c9b3e679de0c Whereas, all the oauth scopes can be imported using the following request: POST /rest/apigateway/archive?gatewayScopes=*
      Gibt zurück:
      this.

    • xHTTPMethodOverride

      public ImportExportAPIGatewayAssetsOperationSpec xHTTPMethodOverride(@Nullable @Nullable String xHTTPMethodOverride)
      This parameter is used to specify that this REST call is an export operation. The value for this field is GET. If this is specified then you need to provide the filtering criteria in body to specify the asset. If empty payload specified then all assets will be exported.
      Gibt zurück:
      this.

    • zipFile

      public ImportExportAPIGatewayAssetsOperationSpec zipFile(@Nullable @Nullable File zipFile)
      Zip file that contains the API Gateway asset needs to be imported
      Gibt zurück:
      this.

    • equals

      public boolean equals(Object o)
      Setzt außer Kraft:
      equals in Klasse Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object