Class GetDatabasesRequest

    • Method Detail

      • catalogId

        public final String catalogId()

        The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.

        Returns:
        The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.
      • nextToken

        public final String nextToken()

        A continuation token, if this is a continuation call.

        Returns:
        A continuation token, if this is a continuation call.
      • maxResults

        public final Integer maxResults()

        The maximum number of databases to return in one response.

        Returns:
        The maximum number of databases to return in one response.
      • resourceShareType

        public final ResourceShareType resourceShareType()

        Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

        • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

        • If set to FOREIGN, will list the databases shared with your account.

        • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

        If the service returns an enum value that is not available in the current SDK version, resourceShareType will return ResourceShareType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceShareTypeAsString().

        Returns:
        Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

        • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

        • If set to FOREIGN, will list the databases shared with your account.

        • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

        See Also:
        ResourceShareType
      • resourceShareTypeAsString

        public final String resourceShareTypeAsString()

        Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

        • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

        • If set to FOREIGN, will list the databases shared with your account.

        • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

        If the service returns an enum value that is not available in the current SDK version, resourceShareType will return ResourceShareType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceShareTypeAsString().

        Returns:
        Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

        • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

        • If set to FOREIGN, will list the databases shared with your account.

        • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

        See Also:
        ResourceShareType
      • attributesToGet

        public final List<DatabaseAttributes> attributesToGet()

        Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.

        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 hasAttributesToGet() method.

        Returns:
        Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.
      • hasAttributesToGet

        public final boolean hasAttributesToGet()
        For responses, this returns true if the service returned a value for the AttributesToGet 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.
      • attributesToGetAsStrings

        public final List<String> attributesToGetAsStrings()

        Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.

        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 hasAttributesToGet() method.

        Returns:
        Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.
      • 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