Compartilhar via


GatewayApiMetadataProperties Classe

  • java.lang.Object
    • com.azure.resourcemanager.appplatform.models.GatewayApiMetadataProperties

public final class GatewayApiMetadataProperties

Propriedade de metadados de API para o Spring Cloud Gateway.

Resumo do Construtor

Construtor Description
GatewayApiMetadataProperties()

Resumo do método

Modificador e tipo Método e descrição
String description()

Obter a propriedade description: descrição detalhada das APIs disponíveis na instância do Gateway (padrão: 'Documento openAPI 3 gerado que descreve as rotas de API configuradas.').

String documentation()

Obter a propriedade de documentação: local da documentação adicional para as APIs disponíveis na instância do Gateway.

String serverUrl()

Obter a propriedade url do servidor: URL base que os consumidores de API usarão para acessar APIs na instância do Gateway.

String title()

Obter a propriedade title: Título que descreve o contexto das APIs disponíveis na instância do Gateway (padrão: 'Spring Cloud Gateway para K8S').

void validate()

Valida a instância .

String version()

Obter a propriedade de versão: versão das APIs disponíveis nesta instância do Gateway (padrão: 'não especificado').

GatewayApiMetadataProperties withDescription(String description)

Defina a propriedade description: descrição detalhada das APIs disponíveis na instância do Gateway (padrão: 'Documento OpenAPI 3 gerado que descreve as rotas de API configuradas.').

GatewayApiMetadataProperties withDocumentation(String documentation)

Defina a propriedade de documentação: local da documentação adicional para as APIs disponíveis na instância do Gateway.

GatewayApiMetadataProperties withServerUrl(String serverUrl)

Defina a propriedade url do servidor: URL base que os consumidores de API usarão para acessar APIs na instância do Gateway.

GatewayApiMetadataProperties withTitle(String title)

Defina a propriedade title: Título que descreve o contexto das APIs disponíveis na instância do Gateway (padrão: 'Spring Cloud Gateway para K8S').

GatewayApiMetadataProperties withVersion(String version)

Definir a propriedade de versão: versão das APIs disponíveis nesta instância do Gateway (padrão: 'não especificado').

Métodos herdados de java.lang.Object

Detalhes do construtor

GatewayApiMetadataProperties

public GatewayApiMetadataProperties()

Detalhes do método

description

public String description()

Obter a propriedade description: descrição detalhada das APIs disponíveis na instância do Gateway (padrão: 'Documento openAPI 3 gerado que descreve as rotas de API configuradas.').

Returns:

o valor de descrição.

documentation

public String documentation()

Obter a propriedade de documentação: local da documentação adicional para as APIs disponíveis na instância do Gateway.

Returns:

o valor da documentação.

serverUrl

public String serverUrl()

Obter a propriedade serverUrl: URL base que os consumidores de API usarão para acessar APIs na instância do Gateway.

Returns:

o valor serverUrl.

title

public String title()

Obter a propriedade title: Título que descreve o contexto das APIs disponíveis na instância do Gateway (padrão: 'Spring Cloud Gateway para K8S').

Returns:

o valor do título.

validate

public void validate()

Valida a instância .

version

public String version()

Obter a propriedade de versão: versão das APIs disponíveis nesta instância do Gateway (padrão: 'não especificado').

Returns:

o valor da versão.

withDescription

public GatewayApiMetadataProperties withDescription(String description)

Defina a propriedade description: descrição detalhada das APIs disponíveis na instância do Gateway (padrão: 'Documento OpenAPI 3 gerado que descreve as rotas de API configuradas.').

Parameters:

description - o valor de descrição a ser definido.

Returns:

o próprio objeto GatewayApiMetadataProperties.

withDocumentation

public GatewayApiMetadataProperties withDocumentation(String documentation)

Defina a propriedade de documentação: local da documentação adicional para as APIs disponíveis na instância do Gateway.

Parameters:

documentation - o valor da documentação a ser definido.

Returns:

o próprio objeto GatewayApiMetadataProperties.

withServerUrl

public GatewayApiMetadataProperties withServerUrl(String serverUrl)

Defina a propriedade serverUrl: URL base que os consumidores de API usarão para acessar APIs na instância do Gateway.

Parameters:

serverUrl - o valor serverUrl a ser definido.

Returns:

o próprio objeto GatewayApiMetadataProperties.

withTitle

public GatewayApiMetadataProperties withTitle(String title)

Defina a propriedade title: Título que descreve o contexto das APIs disponíveis na instância do Gateway (padrão: 'Spring Cloud Gateway para K8S').

Parameters:

title - o valor do título a ser definido.

Returns:

o próprio objeto GatewayApiMetadataProperties.

withVersion

public GatewayApiMetadataProperties withVersion(String version)

Definir a propriedade de versão: versão das APIs disponíveis nesta instância do Gateway (padrão: 'não especificado').

Parameters:

version - o valor de versão a ser definido.

Returns:

o próprio objeto GatewayApiMetadataProperties.

Aplica-se a