Class ExecuteStatementResponse

    • Method Detail

      • hasRecords

        public final boolean hasRecords()
        For responses, this returns true if the service returned a value for the Records property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • records

        public final List<List<Field>> records()

        The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecords() method.

        Returns:
        The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.
      • hasColumnMetadata

        public final boolean hasColumnMetadata()
        For responses, this returns true if the service returned a value for the ColumnMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • columnMetadata

        public final List<ColumnMetadata> columnMetadata()

        Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasColumnMetadata() method.

        Returns:
        Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.
      • numberOfRecordsUpdated

        public final Long numberOfRecordsUpdated()

        The number of records updated by the request.

        Returns:
        The number of records updated by the request.
      • hasGeneratedFields

        public final boolean hasGeneratedFields()
        For responses, this returns true if the service returned a value for the GeneratedFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • generatedFields

        public final List<Field> generatedFields()

        Values for fields generated during a DML request.

        The generatedFields data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the RETURNING clause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGeneratedFields() method.

        Returns:
        Values for fields generated during a DML request.

        The generatedFields data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the RETURNING clause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.

      • formattedRecords

        public final String formattedRecords()

        A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON.

        The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.

        Returns:
        A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON.

        The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.

      • toString

        public final 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