Interface DataDocumentationSpecOrBuilder (1.86.0)

public interface DataDocumentationSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCatalogPublishingEnabled()

public abstract 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.

getGenerationScopes(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.