Class DataDocumentationSpec.Builder (1.86.0)

public static final class DataDocumentationSpec.Builder extends GeneratedMessage.Builder<DataDocumentationSpec.Builder> implements DataDocumentationSpecOrBuilder

DataDocumentation scan related spec.

Protobuf type google.cloud.dataplex.v1.DataDocumentationSpec

Static Methods

getDescriptor()

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

Methods

addAllGenerationScopes(Iterable<? extends DataDocumentationSpec.GenerationScope> values)

public DataDocumentationSpec.Builder addAllGenerationScopes(Iterable<? extends DataDocumentationSpec.GenerationScope> values)

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope>

The generationScopes to add.

Returns
Type Description
DataDocumentationSpec.Builder

This builder for chaining.

addAllGenerationScopesValue(Iterable<Integer> values)

public DataDocumentationSpec.Builder addAllGenerationScopesValue(Iterable<Integer> values)

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for generationScopes to add.

Returns
Type Description
DataDocumentationSpec.Builder

This builder for chaining.

addGenerationScopes(DataDocumentationSpec.GenerationScope value)

public DataDocumentationSpec.Builder addGenerationScopes(DataDocumentationSpec.GenerationScope value)

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataDocumentationSpec.GenerationScope

The generationScopes to add.

Returns
Type Description
DataDocumentationSpec.Builder

This builder for chaining.

addGenerationScopesValue(int value)

public DataDocumentationSpec.Builder addGenerationScopesValue(int value)

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for generationScopes to add.

Returns
Type Description
DataDocumentationSpec.Builder

This builder for chaining.

build()

public DataDocumentationSpec build()
Returns
Type Description
DataDocumentationSpec

buildPartial()

public DataDocumentationSpec buildPartial()
Returns
Type Description
DataDocumentationSpec

clear()

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

clearCatalogPublishingEnabled()

public DataDocumentationSpec.Builder clearCatalogPublishingEnabled()

Optional. Whether to publish result to Dataplex Catalog.

bool catalog_publishing_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataDocumentationSpec.Builder

This builder for chaining.

clearGenerationScopes()

public DataDocumentationSpec.Builder clearGenerationScopes()

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataDocumentationSpec.Builder

This builder for chaining.

getCatalogPublishingEnabled()

public boolean getCatalogPublishingEnabled()

Optional. Whether to publish result to Dataplex Catalog.

bool catalog_publishing_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The catalogPublishingEnabled.

getDefaultInstanceForType()

public DataDocumentationSpec getDefaultInstanceForType()
Returns
Type Description
DataDocumentationSpec

getDescriptorForType()

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

getGenerationScopes(int index)

public DataDocumentationSpec.GenerationScope getGenerationScopes(int index)

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
DataDocumentationSpec.GenerationScope

The generationScopes at the given index.

getGenerationScopesCount()

public int getGenerationScopesCount()

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of generationScopes.

getGenerationScopesList()

public List<DataDocumentationSpec.GenerationScope> getGenerationScopesList()

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<GenerationScope>

A list containing the generationScopes.

getGenerationScopesValue(int index)

public int getGenerationScopesValue(int index)

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of generationScopes at the given index.

getGenerationScopesValueList()

public List<Integer> getGenerationScopesValueList()

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for generationScopes.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataDocumentationSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setCatalogPublishingEnabled(boolean value)

public DataDocumentationSpec.Builder setCatalogPublishingEnabled(boolean value)

Optional. Whether to publish result to Dataplex Catalog.

bool catalog_publishing_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The catalogPublishingEnabled to set.

Returns
Type Description
DataDocumentationSpec.Builder

This builder for chaining.

setGenerationScopes(int index, DataDocumentationSpec.GenerationScope value)

public DataDocumentationSpec.Builder setGenerationScopes(int index, DataDocumentationSpec.GenerationScope value)

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value DataDocumentationSpec.GenerationScope

The generationScopes to set.

Returns
Type Description
DataDocumentationSpec.Builder

This builder for chaining.

setGenerationScopesValue(int index, int value)

public DataDocumentationSpec.Builder setGenerationScopesValue(int index, int value)

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value int

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

Returns
Type Description
DataDocumentationSpec.Builder

This builder for chaining.