/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the redshift-data-2019-12-20.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.RedshiftDataAPIService.Model
{
///
/// Container for the parameters to the ListStatements operation.
/// List of SQL statements. By default, only finished statements are shown. A token is
/// returned to page through the statement list.
///
///
///
/// For more information about the Amazon Redshift Data API and CLI usage examples, see
/// Using the
/// Amazon Redshift Data API in the Amazon Redshift Management Guide.
///
///
public partial class ListStatementsRequest : AmazonRedshiftDataAPIServiceRequest
{
private int? _maxResults;
private string _nextToken;
private bool? _roleLevel;
private string _statementName;
private StatusString _status;
///
/// Gets and sets the property MaxResults.
///
/// The maximum number of SQL statements to return in the response. If more SQL statements
/// exist than fit in one response, then NextToken
is returned to page through
/// the results.
///
///
[AWSProperty(Min=0, Max=100)]
public int MaxResults
{
get { return this._maxResults.GetValueOrDefault(); }
set { this._maxResults = value; }
}
// Check to see if MaxResults property is set
internal bool IsSetMaxResults()
{
return this._maxResults.HasValue;
}
///
/// Gets and sets the property NextToken.
///
/// A value that indicates the starting point for the next set of response records in
/// a subsequent request. If a value is returned in a response, you can retrieve the next
/// set of records by providing this returned NextToken value in the next NextToken parameter
/// and retrying the command. If the NextToken field is empty, all response records have
/// been retrieved for the request.
///
///
public string NextToken
{
get { return this._nextToken; }
set { this._nextToken = value; }
}
// Check to see if NextToken property is set
internal bool IsSetNextToken()
{
return this._nextToken != null;
}
///
/// Gets and sets the property RoleLevel.
///
/// A value that filters which statements to return in the response. If true, all statements
/// run by the caller's IAM role are returned. If false, only statements run by the caller's
/// IAM role in the current IAM session are returned. The default is true.
///
///
public bool RoleLevel
{
get { return this._roleLevel.GetValueOrDefault(); }
set { this._roleLevel = value; }
}
// Check to see if RoleLevel property is set
internal bool IsSetRoleLevel()
{
return this._roleLevel.HasValue;
}
///
/// Gets and sets the property StatementName.
///
/// The name of the SQL statement specified as input to BatchExecuteStatement
/// or ExecuteStatement
to identify the query. You can list multiple statements
/// by providing a prefix that matches the beginning of the statement name. For example,
/// to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value
/// of myStatement
. Data API does a case-sensitive match of SQL statement
/// names to the prefix value you provide.
///
///
[AWSProperty(Min=0, Max=500)]
public string StatementName
{
get { return this._statementName; }
set { this._statementName = value; }
}
// Check to see if StatementName property is set
internal bool IsSetStatementName()
{
return this._statementName != null;
}
///
/// Gets and sets the property Status.
///
/// The status of the SQL statement to list. Status values are defined as follows:
///
/// -
///
/// ABORTED - The query run was stopped by the user.
///
///
-
///
/// ALL - A status value that includes all query statuses. This value can be used to filter
/// results.
///
///
-
///
/// FAILED - The query run failed.
///
///
-
///
/// FINISHED - The query has finished running.
///
///
-
///
/// PICKED - The query has been chosen to be run.
///
///
-
///
/// STARTED - The query run has started.
///
///
-
///
/// SUBMITTED - The query was submitted, but not yet processed.
///
///
///
public StatusString Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
}
}