JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.apigatewayv2.model

Class UpdateApiResult

    • Constructor Detail

      • UpdateApiResult

        public UpdateApiResult()
    • Method Detail

      • setApiEndpoint

        public void setApiEndpoint(String apiEndpoint)

        The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

        Parameters:
        apiEndpoint - The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
      • getApiEndpoint

        public String getApiEndpoint()

        The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

        Returns:
        The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
      • withApiEndpoint

        public UpdateApiResult withApiEndpoint(String apiEndpoint)

        The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

        Parameters:
        apiEndpoint - The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setApiGatewayManaged

        public void setApiGatewayManaged(Boolean apiGatewayManaged)

        Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

        Parameters:
        apiGatewayManaged - Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
      • getApiGatewayManaged

        public Boolean getApiGatewayManaged()

        Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

        Returns:
        Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
      • withApiGatewayManaged

        public UpdateApiResult withApiGatewayManaged(Boolean apiGatewayManaged)

        Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

        Parameters:
        apiGatewayManaged - Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isApiGatewayManaged

        public Boolean isApiGatewayManaged()

        Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

        Returns:
        Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
      • setApiId

        public void setApiId(String apiId)

        The API ID.

        Parameters:
        apiId - The API ID.
      • getApiId

        public String getApiId()

        The API ID.

        Returns:
        The API ID.
      • withApiId

        public UpdateApiResult withApiId(String apiId)

        The API ID.

        Parameters:
        apiId - The API ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setApiKeySelectionExpression

        public void setApiKeySelectionExpression(String apiKeySelectionExpression)

        An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

        Parameters:
        apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
      • withApiKeySelectionExpression

        public UpdateApiResult withApiKeySelectionExpression(String apiKeySelectionExpression)

        An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

        Parameters:
        apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCorsConfiguration

        public void setCorsConfiguration(Cors corsConfiguration)

        A CORS configuration. Supported only for HTTP APIs.

        Parameters:
        corsConfiguration - A CORS configuration. Supported only for HTTP APIs.
      • getCorsConfiguration

        public Cors getCorsConfiguration()

        A CORS configuration. Supported only for HTTP APIs.

        Returns:
        A CORS configuration. Supported only for HTTP APIs.
      • withCorsConfiguration

        public UpdateApiResult withCorsConfiguration(Cors corsConfiguration)

        A CORS configuration. Supported only for HTTP APIs.

        Parameters:
        corsConfiguration - A CORS configuration. Supported only for HTTP APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCreatedDate

        public void setCreatedDate(Date createdDate)

        The timestamp when the API was created.

        Parameters:
        createdDate - The timestamp when the API was created.
      • getCreatedDate

        public Date getCreatedDate()

        The timestamp when the API was created.

        Returns:
        The timestamp when the API was created.
      • withCreatedDate

        public UpdateApiResult withCreatedDate(Date createdDate)

        The timestamp when the API was created.

        Parameters:
        createdDate - The timestamp when the API was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDescription

        public void setDescription(String description)

        The description of the API.

        Parameters:
        description - The description of the API.
      • getDescription

        public String getDescription()

        The description of the API.

        Returns:
        The description of the API.
      • withDescription

        public UpdateApiResult withDescription(String description)

        The description of the API.

        Parameters:
        description - The description of the API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDisableSchemaValidation

        public void setDisableSchemaValidation(Boolean disableSchemaValidation)

        Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

        Parameters:
        disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
      • getDisableSchemaValidation

        public Boolean getDisableSchemaValidation()

        Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

        Returns:
        Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
      • withDisableSchemaValidation

        public UpdateApiResult withDisableSchemaValidation(Boolean disableSchemaValidation)

        Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

        Parameters:
        disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isDisableSchemaValidation

        public Boolean isDisableSchemaValidation()

        Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

        Returns:
        Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
      • setDisableExecuteApiEndpoint

        public void setDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)

        Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

        Parameters:
        disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
      • getDisableExecuteApiEndpoint

        public Boolean getDisableExecuteApiEndpoint()

        Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

        Returns:
        Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
      • withDisableExecuteApiEndpoint

        public UpdateApiResult withDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)

        Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

        Parameters:
        disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isDisableExecuteApiEndpoint

        public Boolean isDisableExecuteApiEndpoint()

        Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

        Returns:
        Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
      • getImportInfo

        public List<String> getImportInfo()

        The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

        Returns:
        The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
      • setImportInfo

        public void setImportInfo(Collection<String> importInfo)

        The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

        Parameters:
        importInfo - The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
      • withImportInfo

        public UpdateApiResult withImportInfo(String... importInfo)

        The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

        NOTE: This method appends the values to the existing list (if any). Use setImportInfo(java.util.Collection) or withImportInfo(java.util.Collection) if you want to override the existing values.

        Parameters:
        importInfo - The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withImportInfo

        public UpdateApiResult withImportInfo(Collection<String> importInfo)

        The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

        Parameters:
        importInfo - The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setName

        public void setName(String name)

        The name of the API.

        Parameters:
        name - The name of the API.
      • getName

        public String getName()

        The name of the API.

        Returns:
        The name of the API.
      • withName

        public UpdateApiResult withName(String name)

        The name of the API.

        Parameters:
        name - The name of the API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setProtocolType

        public void setProtocolType(String protocolType)

        The API protocol.

        Parameters:
        protocolType - The API protocol.
        See Also:
        ProtocolType
      • getProtocolType

        public String getProtocolType()

        The API protocol.

        Returns:
        The API protocol.
        See Also:
        ProtocolType
      • withProtocolType

        public UpdateApiResult withProtocolType(String protocolType)

        The API protocol.

        Parameters:
        protocolType - The API protocol.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProtocolType
      • withProtocolType

        public UpdateApiResult withProtocolType(ProtocolType protocolType)

        The API protocol.

        Parameters:
        protocolType - The API protocol.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProtocolType
      • setRouteSelectionExpression

        public void setRouteSelectionExpression(String routeSelectionExpression)

        The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

        Parameters:
        routeSelectionExpression - The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
      • getRouteSelectionExpression

        public String getRouteSelectionExpression()

        The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

        Returns:
        The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
      • withRouteSelectionExpression

        public UpdateApiResult withRouteSelectionExpression(String routeSelectionExpression)

        The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

        Parameters:
        routeSelectionExpression - The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getTags

        public Map<String,String> getTags()

        A collection of tags associated with the API.

        Returns:
        A collection of tags associated with the API.
      • setTags

        public void setTags(Map<String,String> tags)

        A collection of tags associated with the API.

        Parameters:
        tags - A collection of tags associated with the API.
      • withTags

        public UpdateApiResult withTags(Map<String,String> tags)

        A collection of tags associated with the API.

        Parameters:
        tags - A collection of tags associated with the API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clearTagsEntries

        public UpdateApiResult clearTagsEntries()
        Removes all the entries added into Tags.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setVersion

        public void setVersion(String version)

        A version identifier for the API.

        Parameters:
        version - A version identifier for the API.
      • getVersion

        public String getVersion()

        A version identifier for the API.

        Returns:
        A version identifier for the API.
      • withVersion

        public UpdateApiResult withVersion(String version)

        A version identifier for the API.

        Parameters:
        version - A version identifier for the API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getWarnings

        public List<String> getWarnings()

        The warning messages reported when failonwarnings is turned on during API import.

        Returns:
        The warning messages reported when failonwarnings is turned on during API import.
      • setWarnings

        public void setWarnings(Collection<String> warnings)

        The warning messages reported when failonwarnings is turned on during API import.

        Parameters:
        warnings - The warning messages reported when failonwarnings is turned on during API import.
      • withWarnings

        public UpdateApiResult withWarnings(String... warnings)

        The warning messages reported when failonwarnings is turned on during API import.

        NOTE: This method appends the values to the existing list (if any). Use setWarnings(java.util.Collection) or withWarnings(java.util.Collection) if you want to override the existing values.

        Parameters:
        warnings - The warning messages reported when failonwarnings is turned on during API import.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withWarnings

        public UpdateApiResult withWarnings(Collection<String> warnings)

        The warning messages reported when failonwarnings is turned on during API import.

        Parameters:
        warnings - The warning messages reported when failonwarnings is turned on during API import.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /