org.apache.gravitino.dto

Class CatalogDTO

java.lang.Object

org.apache.gravitino.dto.CatalogDTO

All Implemented Interfaces:

Auditable, Catalog

public class CatalogDTO
extends java.lang.Object
implements Catalog

Data transfer object representing catalog information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogDTO.Builder<S extends CatalogDTO.Builder> Builder class for constructing a CatalogDTO instance.

Nested classes/interfaces inherited from interface org.apache.gravitino.Catalog

Catalog.CloudName, Catalog.Type

Field Summary

Fields inherited from interface org.apache.gravitino.Catalog

AUTHORIZATION_PROVIDER, CLOUD_NAME, CLOUD_REGION_CODE, PROPERTY_IN_USE, PROPERTY_PACKAGE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CatalogDTO() Default constructor for Jackson.
protected	CatalogDTO(java.lang.String name, Catalog.Type type, java.lang.String provider, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties, AuditDTO audit) Constructor for the catalog.

Method Summary

Modifier and Type	Method and Description
Audit	auditInfo() Get the audit information of the catalog.
static CatalogDTO.Builder	builder()
java.lang.String	comment() Get the comment of the catalog.
java.lang.String	name() Get the name of the catalog.
java.util.Map<java.lang.String,java.lang.String>	properties() Get the properties of the catalog.
java.lang.String	provider() Get the provider of the catalog.
Catalog.Type	type() Get the type of the catalog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.gravitino.Catalog

asFilesetCatalog, asModelCatalog, asSchemas, asTableCatalog, asTopicCatalog, supportsCredentials, supportsRoles, supportsTags

Constructor Detail

CatalogDTO

protected CatalogDTO()

Default constructor for Jackson.

CatalogDTO

protected CatalogDTO(java.lang.String name,
                     Catalog.Type type,
                     java.lang.String provider,
                     java.lang.String comment,
                     java.util.Map<java.lang.String,java.lang.String> properties,
                     AuditDTO audit)

Constructor for the catalog.

Parameters:

name - The name of the catalog.

type - The type of the catalog.

provider - The provider of the catalog.

comment - The comment of the catalog.

properties - The properties of the catalog.

audit - The audit information of the catalog.

Method Detail

name

public java.lang.String name()

Get the name of the catalog.

Specified by:

name in interface Catalog

Returns:

The name of the catalog.

type

public Catalog.Type type()

Get the type of the catalog.

Specified by:

type in interface Catalog

Returns:

The type of the catalog.

provider

public java.lang.String provider()

Get the provider of the catalog.

Specified by:

provider in interface Catalog

Returns:

The provider of the catalog.

comment

public java.lang.String comment()

Get the comment of the catalog.

Specified by:

comment in interface Catalog

Returns:

The comment of the catalog.

properties

public java.util.Map<java.lang.String,java.lang.String> properties()

Get the properties of the catalog.

Specified by:

properties in interface Catalog

Returns:

The properties of the catalog.

auditInfo

public Audit auditInfo()

Get the audit information of the catalog.

Specified by:

auditInfo in interface Auditable

Returns:

The audit information of the catalog.

builder

public static CatalogDTO.Builder builder()

Returns:

the builder for creating a new instance of CatalogDTO.