Class IcebergCatalog.Builder (0.71.0)

public static final class IcebergCatalog.Builder extends GeneratedMessage.Builder<IcebergCatalog.Builder> implements IcebergCatalogOrBuilder

The Iceberg REST Catalog information.

Protobuf type google.cloud.biglake.v1.IcebergCatalog

Static Methods

getDescriptor()

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

Methods

addAllCatalogRegions(Iterable<String> values)

public IcebergCatalog.Builder addAllCatalogRegions(Iterable<String> values)

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
values Iterable<String>

The catalogRegions to add.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

addCatalogRegions(String value)

public IcebergCatalog.Builder addCatalogRegions(String value)

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
value String

The catalogRegions to add.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

addCatalogRegionsBytes(ByteString value)

public IcebergCatalog.Builder addCatalogRegionsBytes(ByteString value)

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
value ByteString

The bytes of the catalogRegions to add.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

build()

public IcebergCatalog build()
Returns
Type Description
IcebergCatalog

buildPartial()

public IcebergCatalog buildPartial()
Returns
Type Description
IcebergCatalog

clear()

public IcebergCatalog.Builder clear()
Returns
Type Description
IcebergCatalog.Builder
Overrides

clearBiglakeServiceAccount()

public IcebergCatalog.Builder clearBiglakeServiceAccount()

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
IcebergCatalog.Builder

This builder for chaining.

clearCatalogRegions()

public IcebergCatalog.Builder clearCatalogRegions()

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
IcebergCatalog.Builder

This builder for chaining.

clearCatalogType()

public IcebergCatalog.Builder clearCatalogType()

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.Builder

This builder for chaining.

clearCreateTime()

public IcebergCatalog.Builder clearCreateTime()

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
IcebergCatalog.Builder

clearCredentialMode()

public IcebergCatalog.Builder clearCredentialMode()

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.Builder

This builder for chaining.

clearDefaultLocation()

public IcebergCatalog.Builder clearDefaultLocation()

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
IcebergCatalog.Builder

This builder for chaining.

clearName()

public IcebergCatalog.Builder clearName()

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
IcebergCatalog.Builder

This builder for chaining.

clearUpdateTime()

public IcebergCatalog.Builder clearUpdateTime()

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
IcebergCatalog.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public IcebergCatalog.Builder mergeCreateTime(Timestamp value)

Output only. When the catalog was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
IcebergCatalog.Builder

mergeFrom(IcebergCatalog other)

public IcebergCatalog.Builder mergeFrom(IcebergCatalog other)
Parameter
Name Description
other IcebergCatalog
Returns
Type Description
IcebergCatalog.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public IcebergCatalog.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public IcebergCatalog.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
IcebergCatalog.Builder
Overrides

mergeUpdateTime(Timestamp value)

public IcebergCatalog.Builder mergeUpdateTime(Timestamp value)

Output only. When the catalog was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
IcebergCatalog.Builder

setBiglakeServiceAccount(String value)

public IcebergCatalog.Builder setBiglakeServiceAccount(String value)

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];

Parameter
Name Description
value String

The biglakeServiceAccount to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setBiglakeServiceAccountBytes(ByteString value)

public IcebergCatalog.Builder setBiglakeServiceAccountBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for biglakeServiceAccount to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setCatalogRegions(int index, String value)

public IcebergCatalog.Builder setCatalogRegions(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.

value String

The catalogRegions to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setCatalogType(IcebergCatalog.CatalogType value)

public IcebergCatalog.Builder setCatalogType(IcebergCatalog.CatalogType value)

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];

Parameter
Name Description
value IcebergCatalog.CatalogType

The catalogType to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setCatalogTypeValue(int value)

public IcebergCatalog.Builder setCatalogTypeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for catalogType to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public IcebergCatalog.Builder setCreateTime(Timestamp value)

Output only. When the catalog was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
IcebergCatalog.Builder

setCreateTime(Timestamp.Builder builderForValue)

public IcebergCatalog.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. When the catalog was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
IcebergCatalog.Builder

setCredentialMode(IcebergCatalog.CredentialMode value)

public IcebergCatalog.Builder setCredentialMode(IcebergCatalog.CredentialMode value)

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];

Parameter
Name Description
value IcebergCatalog.CredentialMode

The credentialMode to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setCredentialModeValue(int value)

public IcebergCatalog.Builder setCredentialModeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for credentialMode to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setDefaultLocation(String value)

public IcebergCatalog.Builder setDefaultLocation(String value)

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];

Parameter
Name Description
value String

The defaultLocation to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setDefaultLocationBytes(ByteString value)

public IcebergCatalog.Builder setDefaultLocationBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for defaultLocation to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setName(String value)

public IcebergCatalog.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setNameBytes(ByteString value)

public IcebergCatalog.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public IcebergCatalog.Builder setUpdateTime(Timestamp value)

Output only. When the catalog was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
IcebergCatalog.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public IcebergCatalog.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. When the catalog was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
IcebergCatalog.Builder