GatewaysClient Interface

public interface GatewaysClient

An instance of this class provides access to all the operations defined in GatewaysClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<GatewayResourceInner>,GatewayResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

abstract SyncPoller<PollResult<GatewayResourceInner>,GatewayResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource, Context context)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

abstract PollerFlux<PollResult<GatewayResourceInner>,GatewayResourceInner> beginCreateOrUpdateAsync(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String serviceName, String gatewayName, Context context)

Disable the default Spring Cloud Gateway.

abstract PollerFlux<PollResult<Void>,Void> beginDeleteAsync(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

abstract SyncPoller<PollResult<Void>,Void> beginRestart(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

abstract SyncPoller<PollResult<Void>,Void> beginRestart(String resourceGroupName, String serviceName, String gatewayName, Context context)

Restart the Spring Cloud Gateway.

abstract PollerFlux<PollResult<Void>,Void> beginRestartAsync(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

abstract GatewayResourceInner createOrUpdate(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

abstract GatewayResourceInner createOrUpdate(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource, Context context)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

abstract Mono<GatewayResourceInner> createOrUpdateAsync(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

abstract Mono<Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

abstract void delete(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

abstract void delete(String resourceGroupName, String serviceName, String gatewayName, Context context)

Disable the default Spring Cloud Gateway.

abstract Mono<Void> deleteAsync(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

abstract Mono<Response<Flux<ByteBuffer>>> deleteWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

abstract GatewayResourceInner get(String resourceGroupName, String serviceName, String gatewayName)

Get the Spring Cloud Gateway and its properties.

abstract Mono<GatewayResourceInner> getAsync(String resourceGroupName, String serviceName, String gatewayName)

Get the Spring Cloud Gateway and its properties.

abstract Response<GatewayResourceInner> getWithResponse(String resourceGroupName, String serviceName, String gatewayName, Context context)

Get the Spring Cloud Gateway and its properties.

abstract Mono<Response<GatewayResourceInner>> getWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName)

Get the Spring Cloud Gateway and its properties.

abstract PagedIterable<GatewayResourceInner> list(String resourceGroupName, String serviceName)

Handles requests to list all resources in a Service.

abstract PagedIterable<GatewayResourceInner> list(String resourceGroupName, String serviceName, Context context)

Handles requests to list all resources in a Service.

abstract PagedFlux<GatewayResourceInner> listAsync(String resourceGroupName, String serviceName)

Handles requests to list all resources in a Service.

abstract Map<String,String> listEnvSecrets(String resourceGroupName, String serviceName, String gatewayName)

List sensitive environment variables of Spring Cloud Gateway.

abstract Mono<Map<String,String>> listEnvSecretsAsync(String resourceGroupName, String serviceName, String gatewayName)

List sensitive environment variables of Spring Cloud Gateway.

abstract Response<Map<String,String>> listEnvSecretsWithResponse(String resourceGroupName, String serviceName, String gatewayName, Context context)

List sensitive environment variables of Spring Cloud Gateway.

abstract Mono<Response<Map<String,String>>> listEnvSecretsWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName)

List sensitive environment variables of Spring Cloud Gateway.

abstract void restart(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

abstract void restart(String resourceGroupName, String serviceName, String gatewayName, Context context)

Restart the Spring Cloud Gateway.

abstract Mono<Void> restartAsync(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

abstract Mono<Response<Flux<ByteBuffer>>> restartWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

abstract CustomDomainValidateResult validateDomain(String resourceGroupName, String serviceName, String gatewayName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

abstract Mono<CustomDomainValidateResult> validateDomainAsync(String resourceGroupName, String serviceName, String gatewayName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

abstract Response<CustomDomainValidateResult> validateDomainWithResponse(String resourceGroupName, String serviceName, String gatewayName, CustomDomainValidatePayload validatePayload, Context context)

Check the domains are valid as well as not in use.

abstract Mono<Response<CustomDomainValidateResult>> validateDomainWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

Method Details

beginCreateOrUpdate

public abstract SyncPoller,GatewayResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
gatewayResource - The gateway for the create or update operation.

Returns:

the SyncPoller<T,U> for polling of spring Cloud Gateway resource.

beginCreateOrUpdate

public abstract SyncPoller,GatewayResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource, Context context)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
gatewayResource - The gateway for the create or update operation.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of spring Cloud Gateway resource.

beginCreateOrUpdateAsync

public abstract PollerFlux,GatewayResourceInner> beginCreateOrUpdateAsync(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
gatewayResource - The gateway for the create or update operation.

Returns:

the PollerFlux<T,U> for polling of spring Cloud Gateway resource.

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName, String serviceName, String gatewayName, Context context)

Disable the default Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDeleteAsync

public abstract PollerFlux,Void> beginDeleteAsync(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

the PollerFlux<T,U> for polling of long-running operation.

beginRestart

public abstract SyncPoller,Void> beginRestart(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginRestart

public abstract SyncPoller,Void> beginRestart(String resourceGroupName, String serviceName, String gatewayName, Context context)

Restart the Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginRestartAsync

public abstract PollerFlux,Void> beginRestartAsync(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

the PollerFlux<T,U> for polling of long-running operation.

createOrUpdate

public abstract GatewayResourceInner createOrUpdate(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
gatewayResource - The gateway for the create or update operation.

Returns:

spring Cloud Gateway resource.

createOrUpdate

public abstract GatewayResourceInner createOrUpdate(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource, Context context)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
gatewayResource - The gateway for the create or update operation.
context - The context to associate with this operation.

Returns:

spring Cloud Gateway resource.

createOrUpdateAsync

public abstract Mono createOrUpdateAsync(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
gatewayResource - The gateway for the create or update operation.

Returns:

spring Cloud Gateway resource on successful completion of Mono.

createOrUpdateWithResponseAsync

public abstract Mono>> createOrUpdateWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName, GatewayResourceInner gatewayResource)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
gatewayResource - The gateway for the create or update operation.

Returns:

spring Cloud Gateway resource along with Response<T> on successful completion of Mono.

delete

public abstract void delete(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

delete

public abstract void delete(String resourceGroupName, String serviceName, String gatewayName, Context context)

Disable the default Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
context - The context to associate with this operation.

deleteAsync

public abstract Mono deleteAsync(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

A Mono that completes when a successful response is received.

deleteWithResponseAsync

public abstract Mono>> deleteWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName)

Disable the default Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

the Response<T> on successful completion of Mono.

get

public abstract GatewayResourceInner get(String resourceGroupName, String serviceName, String gatewayName)

Get the Spring Cloud Gateway and its properties.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

the Spring Cloud Gateway and its properties.

getAsync

public abstract Mono getAsync(String resourceGroupName, String serviceName, String gatewayName)

Get the Spring Cloud Gateway and its properties.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

the Spring Cloud Gateway and its properties on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String gatewayName, Context context)

Get the Spring Cloud Gateway and its properties.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
context - The context to associate with this operation.

Returns:

the Spring Cloud Gateway and its properties along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName)

Get the Spring Cloud Gateway and its properties.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

the Spring Cloud Gateway and its properties along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable list(String resourceGroupName, String serviceName)

Handles requests to list all resources in a Service.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.

Returns:

object that includes an array of gateway resources and a possible link for next set as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String resourceGroupName, String serviceName, Context context)

Handles requests to list all resources in a Service.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
context - The context to associate with this operation.

Returns:

object that includes an array of gateway resources and a possible link for next set as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync(String resourceGroupName, String serviceName)

Handles requests to list all resources in a Service.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.

Returns:

object that includes an array of gateway resources and a possible link for next set as paginated response with PagedFlux<T>.

listEnvSecrets

public abstract Map listEnvSecrets(String resourceGroupName, String serviceName, String gatewayName)

List sensitive environment variables of Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

sensitive properties for Spring Cloud Gateway.

listEnvSecretsAsync

public abstract Mono> listEnvSecretsAsync(String resourceGroupName, String serviceName, String gatewayName)

List sensitive environment variables of Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

sensitive properties for Spring Cloud Gateway on successful completion of Mono.

listEnvSecretsWithResponse

public abstract Response> listEnvSecretsWithResponse(String resourceGroupName, String serviceName, String gatewayName, Context context)

List sensitive environment variables of Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
context - The context to associate with this operation.

Returns:

sensitive properties for Spring Cloud Gateway along with Response<T>.

listEnvSecretsWithResponseAsync

public abstract Mono>> listEnvSecretsWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName)

List sensitive environment variables of Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

sensitive properties for Spring Cloud Gateway along with Response<T> on successful completion of Mono.

restart

public abstract void restart(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

restart

public abstract void restart(String resourceGroupName, String serviceName, String gatewayName, Context context)

Restart the Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
context - The context to associate with this operation.

restartAsync

public abstract Mono restartAsync(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

A Mono that completes when a successful response is received.

restartWithResponseAsync

public abstract Mono>> restartWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName)

Restart the Spring Cloud Gateway.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.

Returns:

the Response<T> on successful completion of Mono.

validateDomain

public abstract CustomDomainValidateResult validateDomain(String resourceGroupName, String serviceName, String gatewayName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
validatePayload - Custom domain payload to be validated.

Returns:

validation result for custom domain.

validateDomainAsync

public abstract Mono validateDomainAsync(String resourceGroupName, String serviceName, String gatewayName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
validatePayload - Custom domain payload to be validated.

Returns:

validation result for custom domain on successful completion of Mono.

validateDomainWithResponse

public abstract Response validateDomainWithResponse(String resourceGroupName, String serviceName, String gatewayName, CustomDomainValidatePayload validatePayload, Context context)

Check the domains are valid as well as not in use.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
validatePayload - Custom domain payload to be validated.
context - The context to associate with this operation.

Returns:

validation result for custom domain along with Response<T>.

validateDomainWithResponseAsync

public abstract Mono> validateDomainWithResponseAsync(String resourceGroupName, String serviceName, String gatewayName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
gatewayName - The name of Spring Cloud Gateway.
validatePayload - Custom domain payload to be validated.

Returns:

validation result for custom domain along with Response<T> on successful completion of Mono.

Applies to