commonMain.aws.sdk.kotlin.services.glue.model.SearchTablesRequest.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of glue-jvm Show documentation
Show all versions of glue-jvm Show documentation
The AWS SDK for Kotlin client for Glue
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.glue.model
import aws.smithy.kotlin.runtime.SdkDsl
public class SearchTablesRequest private constructor(builder: Builder) {
/**
* A unique identifier, consisting of ` account_id `.
*/
public val catalogId: kotlin.String? = builder.catalogId
/**
* A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
*
* The `Comparator` member of the `PropertyPredicate` struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when `Key=Name`, a fuzzy match algorithm is used. The `Key` field (for example, the value of the `Name` field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the `Value` member of `PropertyPredicate`. For example, if `Key=Name` and `Value=link`, tables named `customer-link` and `xx-link-yy` are returned, but `xxlinkyy` is not returned.
*/
public val filters: List? = builder.filters
/**
* Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
*/
public val includeStatusDetails: kotlin.Boolean? = builder.includeStatusDetails
/**
* The maximum number of tables to return in a single response.
*/
public val maxResults: kotlin.Int? = builder.maxResults
/**
* A continuation token, included if this is a continuation call.
*/
public val nextToken: kotlin.String? = builder.nextToken
/**
* Allows you to specify that you want to search the tables shared with your account. The allowable values are `FOREIGN` or `ALL`.
* + If set to `FOREIGN`, will search the tables shared with your account.
* + If set to `ALL`, will search the tables shared with your account, as well as the tables in yor local account.
*/
public val resourceShareType: aws.sdk.kotlin.services.glue.model.ResourceShareType? = builder.resourceShareType
/**
* A string used for a text search.
*
* Specifying a value in quotes filters based on an exact match to the value.
*/
public val searchText: kotlin.String? = builder.searchText
/**
* A list of criteria for sorting the results by a field name, in an ascending or descending order.
*/
public val sortCriteria: List? = builder.sortCriteria
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.glue.model.SearchTablesRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("SearchTablesRequest(")
append("catalogId=$catalogId,")
append("filters=$filters,")
append("includeStatusDetails=$includeStatusDetails,")
append("maxResults=$maxResults,")
append("nextToken=$nextToken,")
append("resourceShareType=$resourceShareType,")
append("searchText=$searchText,")
append("sortCriteria=$sortCriteria")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = catalogId?.hashCode() ?: 0
result = 31 * result + (filters?.hashCode() ?: 0)
result = 31 * result + (includeStatusDetails?.hashCode() ?: 0)
result = 31 * result + (maxResults ?: 0)
result = 31 * result + (nextToken?.hashCode() ?: 0)
result = 31 * result + (resourceShareType?.hashCode() ?: 0)
result = 31 * result + (searchText?.hashCode() ?: 0)
result = 31 * result + (sortCriteria?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as SearchTablesRequest
if (catalogId != other.catalogId) return false
if (filters != other.filters) return false
if (includeStatusDetails != other.includeStatusDetails) return false
if (maxResults != other.maxResults) return false
if (nextToken != other.nextToken) return false
if (resourceShareType != other.resourceShareType) return false
if (searchText != other.searchText) return false
if (sortCriteria != other.sortCriteria) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.glue.model.SearchTablesRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* A unique identifier, consisting of ` account_id `.
*/
public var catalogId: kotlin.String? = null
/**
* A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
*
* The `Comparator` member of the `PropertyPredicate` struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when `Key=Name`, a fuzzy match algorithm is used. The `Key` field (for example, the value of the `Name` field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the `Value` member of `PropertyPredicate`. For example, if `Key=Name` and `Value=link`, tables named `customer-link` and `xx-link-yy` are returned, but `xxlinkyy` is not returned.
*/
public var filters: List? = null
/**
* Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
*/
public var includeStatusDetails: kotlin.Boolean? = null
/**
* The maximum number of tables to return in a single response.
*/
public var maxResults: kotlin.Int? = null
/**
* A continuation token, included if this is a continuation call.
*/
public var nextToken: kotlin.String? = null
/**
* Allows you to specify that you want to search the tables shared with your account. The allowable values are `FOREIGN` or `ALL`.
* + If set to `FOREIGN`, will search the tables shared with your account.
* + If set to `ALL`, will search the tables shared with your account, as well as the tables in yor local account.
*/
public var resourceShareType: aws.sdk.kotlin.services.glue.model.ResourceShareType? = null
/**
* A string used for a text search.
*
* Specifying a value in quotes filters based on an exact match to the value.
*/
public var searchText: kotlin.String? = null
/**
* A list of criteria for sorting the results by a field name, in an ascending or descending order.
*/
public var sortCriteria: List? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.glue.model.SearchTablesRequest) : this() {
this.catalogId = x.catalogId
this.filters = x.filters
this.includeStatusDetails = x.includeStatusDetails
this.maxResults = x.maxResults
this.nextToken = x.nextToken
this.resourceShareType = x.resourceShareType
this.searchText = x.searchText
this.sortCriteria = x.sortCriteria
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.glue.model.SearchTablesRequest = SearchTablesRequest(this)
internal fun correctErrors(): Builder {
return this
}
}
}