Class IcebergCatalog (0.62.0)

public final class IcebergCatalog extends GeneratedMessageV3 implements IcebergCatalogOrBuilder

The Iceberg REST Catalog information.

Protobuf type google.cloud.biglake.v1.IcebergCatalog

Static Fields

BIGLAKE_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int BIGLAKE_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

CATALOG_REGIONS_FIELD_NUMBER

public static final int CATALOG_REGIONS_FIELD_NUMBER
Field Value
Type Description
int

CATALOG_TYPE_FIELD_NUMBER

public static final int CATALOG_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CREDENTIAL_MODE_FIELD_NUMBER

public static final int CREDENTIAL_MODE_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_LOCATION_FIELD_NUMBER

public static final int DEFAULT_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IcebergCatalog getDefaultInstance()
Returns
Type Description
IcebergCatalog

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static IcebergCatalog.Builder newBuilder()
Returns
Type Description
IcebergCatalog.Builder

newBuilder(IcebergCatalog prototype)

public static IcebergCatalog.Builder newBuilder(IcebergCatalog prototype)
Parameter
Name Description
prototype IcebergCatalog
Returns
Type Description
IcebergCatalog.Builder

parseDelimitedFrom(InputStream input)

public static IcebergCatalog parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IcebergCatalog parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IcebergCatalog parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IcebergCatalog parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IcebergCatalog parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IcebergCatalog parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<IcebergCatalog> parser()
Returns
Type Description
Parser<IcebergCatalog>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBiglakeServiceAccount()

public String getBiglakeServiceAccount()

Output only. The service account used for credential vending, output only. Might be empty if Credential vending was never enabled for the catalog.

string biglake_service_account = 3 [json_name = "biglake-service-account", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The biglakeServiceAccount.

getBiglakeServiceAccountBytes()

public ByteString getBiglakeServiceAccountBytes()

Output only. The service account used for credential vending, output only. Might be empty if Credential vending was never enabled for the catalog.

string biglake_service_account = 3 [json_name = "biglake-service-account", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for biglakeServiceAccount.

getCatalogRegions(int index)

public String getCatalogRegions(int index)

Output only. The GCP region(s) where the catalog metadata is stored. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.

repeated string catalog_regions = 6 [json_name = "catalog-regions", (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The catalogRegions at the given index.

getCatalogRegionsBytes(int index)

public ByteString getCatalogRegionsBytes(int index)

Output only. The GCP region(s) where the catalog metadata is stored. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.

repeated string catalog_regions = 6 [json_name = "catalog-regions", (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the catalogRegions at the given index.

getCatalogRegionsCount()

public int getCatalogRegionsCount()

Output only. The GCP region(s) where the catalog metadata is stored. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.

repeated string catalog_regions = 6 [json_name = "catalog-regions", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of catalogRegions.

getCatalogRegionsList()

public ProtocolStringList getCatalogRegionsList()

Output only. The GCP region(s) where the catalog metadata is stored. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.

repeated string catalog_regions = 6 [json_name = "catalog-regions", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the catalogRegions.

getCatalogType()

public IcebergCatalog.CatalogType getCatalogType()

Required. The catalog type. Required for CreateIcebergCatalog.

.google.cloud.biglake.v1.IcebergCatalog.CatalogType catalog_type = 4 [json_name = "catalog-type", (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IcebergCatalog.CatalogType

The catalogType.

getCatalogTypeValue()

public int getCatalogTypeValue()

Required. The catalog type. Required for CreateIcebergCatalog.

.google.cloud.biglake.v1.IcebergCatalog.CatalogType catalog_type = 4 [json_name = "catalog-type", (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for catalogType.

getCreateTime()

public Timestamp getCreateTime()

Output only. When the catalog was created.

.google.protobuf.Timestamp create_time = 7 [json_name = "create-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. When the catalog was created.

.google.protobuf.Timestamp create_time = 7 [json_name = "create-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCredentialMode()

public IcebergCatalog.CredentialMode getCredentialMode()

Optional. The credential mode for the catalog.

.google.cloud.biglake.v1.IcebergCatalog.CredentialMode credential_mode = 2 [json_name = "credential-mode", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IcebergCatalog.CredentialMode

The credentialMode.

getCredentialModeValue()

public int getCredentialModeValue()

Optional. The credential mode for the catalog.

.google.cloud.biglake.v1.IcebergCatalog.CredentialMode credential_mode = 2 [json_name = "credential-mode", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for credentialMode.

getDefaultInstanceForType()

public IcebergCatalog getDefaultInstanceForType()
Returns
Type Description
IcebergCatalog

getDefaultLocation()

public String getDefaultLocation()

Optional. The default location for the catalog. For the Google Cloud Storage Bucket catalog this is output only.

string default_location = 5 [json_name = "default-location", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The defaultLocation.

getDefaultLocationBytes()

public ByteString getDefaultLocationBytes()

Optional. The default location for the catalog. For the Google Cloud Storage Bucket catalog this is output only.

string default_location = 5 [json_name = "default-location", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for defaultLocation.

getName()

public String getName()

Identifier. The catalog name, projects/my-project/catalogs/my-catalog. This field is immutable. This field is ignored for CreateIcebergCatalog.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The catalog name, projects/my-project/catalogs/my-catalog. This field is immutable. This field is ignored for CreateIcebergCatalog.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<IcebergCatalog> getParserForType()
Returns
Type Description
Parser<IcebergCatalog>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. When the catalog was last updated.

.google.protobuf.Timestamp update_time = 8 [json_name = "update-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. When the catalog was last updated.

.google.protobuf.Timestamp update_time = 8 [json_name = "update-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. When the catalog was created.

.google.protobuf.Timestamp create_time = 7 [json_name = "create-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. When the catalog was last updated.

.google.protobuf.Timestamp update_time = 8 [json_name = "update-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IcebergCatalog.Builder newBuilderForType()
Returns
Type Description
IcebergCatalog.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IcebergCatalog.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IcebergCatalog.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public IcebergCatalog.Builder toBuilder()
Returns
Type Description
IcebergCatalog.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException