Class BigQueryLink.Builder (0.63.0) 

public static final class BigQueryLink.Builder extends GeneratedMessageV3.Builder<BigQueryLink.Builder> implements BigQueryLinkOrBuilder

A link between a GA4 Property and BigQuery project.

Protobuf type google.analytics.admin.v1alpha.BigQueryLink

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BigQueryLink.Builder

Static Methods

getDescriptor()

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

Methods

addAllExcludedEvents(Iterable<String> values)

public BigQueryLink.Builder addAllExcludedEvents(Iterable<String> values)

The list of event names that will be excluded from exports.

repeated string excluded_events = 8;

Parameter
Name Description
values Iterable<String>

The excludedEvents to add.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

addAllExportStreams(Iterable<String> values)

public BigQueryLink.Builder addAllExportStreams(Iterable<String> values)

The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']

repeated string export_streams = 7;

Parameter
Name Description
values Iterable<String>

The exportStreams to add.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

addExcludedEvents(String value)

public BigQueryLink.Builder addExcludedEvents(String value)

The list of event names that will be excluded from exports.

repeated string excluded_events = 8;

Parameter
Name Description
value String

The excludedEvents to add.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

addExcludedEventsBytes(ByteString value)

public BigQueryLink.Builder addExcludedEventsBytes(ByteString value)

The list of event names that will be excluded from exports.

repeated string excluded_events = 8;

Parameter
Name Description
value ByteString

The bytes of the excludedEvents to add.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

addExportStreams(String value)

public BigQueryLink.Builder addExportStreams(String value)

The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']

repeated string export_streams = 7;

Parameter
Name Description
value String

The exportStreams to add.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

addExportStreamsBytes(ByteString value)

public BigQueryLink.Builder addExportStreamsBytes(ByteString value)

The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']

repeated string export_streams = 7;

Parameter
Name Description
value ByteString

The bytes of the exportStreams to add.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BigQueryLink.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BigQueryLink.Builder
Overrides

build()

public BigQueryLink build()
Returns
Type Description
BigQueryLink

buildPartial()

public BigQueryLink buildPartial()
Returns
Type Description
BigQueryLink

clear()

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

clearCreateTime()

public BigQueryLink.Builder clearCreateTime()

Output only. Time when the link was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BigQueryLink.Builder

clearDailyExportEnabled()

public BigQueryLink.Builder clearDailyExportEnabled()

If set true, enables daily data export to the linked Google Cloud project.

bool daily_export_enabled = 4;

Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

clearDatasetLocation()

public BigQueryLink.Builder clearDatasetLocation()

Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.

string dataset_location = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

clearExcludedEvents()

public BigQueryLink.Builder clearExcludedEvents()

The list of event names that will be excluded from exports.

repeated string excluded_events = 8;

Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

clearExportStreams()

public BigQueryLink.Builder clearExportStreams()

The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']

repeated string export_streams = 7;

Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BigQueryLink.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BigQueryLink.Builder
Overrides

clearFreshDailyExportEnabled()

public BigQueryLink.Builder clearFreshDailyExportEnabled()

If set true, enables fresh daily export to the linked Google Cloud project.

bool fresh_daily_export_enabled = 9;

Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

clearIncludeAdvertisingId()

public BigQueryLink.Builder clearIncludeAdvertisingId()

If set true, exported data will include advertising identifiers for mobile app streams.

bool include_advertising_id = 6;

Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

clearName()

public BigQueryLink.Builder clearName()

Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'

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

Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BigQueryLink.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BigQueryLink.Builder
Overrides

clearProject()

public BigQueryLink.Builder clearProject()

Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'

string project = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

clearStreamingExportEnabled()

public BigQueryLink.Builder clearStreamingExportEnabled()

If set true, enables streaming export to the linked Google Cloud project.

bool streaming_export_enabled = 5;

Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

clone()

public BigQueryLink.Builder clone()
Returns
Type Description
BigQueryLink.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when the link was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time when the link was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when the link was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDailyExportEnabled()

public boolean getDailyExportEnabled()

If set true, enables daily data export to the linked Google Cloud project.

bool daily_export_enabled = 4;

Returns
Type Description
boolean

The dailyExportEnabled.

getDatasetLocation()

public String getDatasetLocation()

Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.

string dataset_location = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The datasetLocation.

getDatasetLocationBytes()

public ByteString getDatasetLocationBytes()

Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.

string dataset_location = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for datasetLocation.

getDefaultInstanceForType()

public BigQueryLink getDefaultInstanceForType()
Returns
Type Description
BigQueryLink

getDescriptorForType()

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

getExcludedEvents(int index)

public String getExcludedEvents(int index)

The list of event names that will be excluded from exports.

repeated string excluded_events = 8;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The excludedEvents at the given index.

getExcludedEventsBytes(int index)

public ByteString getExcludedEventsBytes(int index)

The list of event names that will be excluded from exports.

repeated string excluded_events = 8;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the excludedEvents at the given index.

getExcludedEventsCount()

public int getExcludedEventsCount()

The list of event names that will be excluded from exports.

repeated string excluded_events = 8;

Returns
Type Description
int

The count of excludedEvents.

getExcludedEventsList()

public ProtocolStringList getExcludedEventsList()

The list of event names that will be excluded from exports.

repeated string excluded_events = 8;

Returns
Type Description
ProtocolStringList

A list containing the excludedEvents.

getExportStreams(int index)

public String getExportStreams(int index)

The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']

repeated string export_streams = 7;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The exportStreams at the given index.

getExportStreamsBytes(int index)

public ByteString getExportStreamsBytes(int index)

The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']

repeated string export_streams = 7;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the exportStreams at the given index.

getExportStreamsCount()

public int getExportStreamsCount()

The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']

repeated string export_streams = 7;

Returns
Type Description
int

The count of exportStreams.

getExportStreamsList()

public ProtocolStringList getExportStreamsList()

The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']

repeated string export_streams = 7;

Returns
Type Description
ProtocolStringList

A list containing the exportStreams.

getFreshDailyExportEnabled()

public boolean getFreshDailyExportEnabled()

If set true, enables fresh daily export to the linked Google Cloud project.

bool fresh_daily_export_enabled = 9;

Returns
Type Description
boolean

The freshDailyExportEnabled.

getIncludeAdvertisingId()

public boolean getIncludeAdvertisingId()

If set true, exported data will include advertising identifiers for mobile app streams.

bool include_advertising_id = 6;

Returns
Type Description
boolean

The includeAdvertisingId.

getName()

public String getName()

Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'

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

Returns
Type Description
ByteString

The bytes for name.

getProject()

public String getProject()

Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'

string project = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'

string project = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for project.

getStreamingExportEnabled()

public boolean getStreamingExportEnabled()

If set true, enables streaming export to the linked Google Cloud project.

bool streaming_export_enabled = 5;

Returns
Type Description
boolean

The streamingExportEnabled.

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when the link was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public BigQueryLink.Builder mergeCreateTime(Timestamp value)

Output only. Time when the link was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BigQueryLink.Builder

mergeFrom(BigQueryLink other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BigQueryLink.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BigQueryLink.Builder
Overrides

setCreateTime(Timestamp value)

public BigQueryLink.Builder setCreateTime(Timestamp value)

Output only. Time when the link was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BigQueryLink.Builder

setCreateTime(Timestamp.Builder builderForValue)

public BigQueryLink.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when the link was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BigQueryLink.Builder

setDailyExportEnabled(boolean value)

public BigQueryLink.Builder setDailyExportEnabled(boolean value)

If set true, enables daily data export to the linked Google Cloud project.

bool daily_export_enabled = 4;

Parameter
Name Description
value boolean

The dailyExportEnabled to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setDatasetLocation(String value)

public BigQueryLink.Builder setDatasetLocation(String value)

Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.

string dataset_location = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The datasetLocation to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setDatasetLocationBytes(ByteString value)

public BigQueryLink.Builder setDatasetLocationBytes(ByteString value)

Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.

string dataset_location = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for datasetLocation to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setExcludedEvents(int index, String value)

public BigQueryLink.Builder setExcludedEvents(int index, String value)

The list of event names that will be excluded from exports.

repeated string excluded_events = 8;

Parameters
Name Description
index int

The index to set the value at.
value String

The excludedEvents to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setExportStreams(int index, String value)

public BigQueryLink.Builder setExportStreams(int index, String value)

The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']

repeated string export_streams = 7;

Parameters
Name Description
index int

The index to set the value at.
value String

The exportStreams to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BigQueryLink.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BigQueryLink.Builder
Overrides

setFreshDailyExportEnabled(boolean value)

public BigQueryLink.Builder setFreshDailyExportEnabled(boolean value)

If set true, enables fresh daily export to the linked Google Cloud project.

bool fresh_daily_export_enabled = 9;

Parameter
Name Description
value boolean

The freshDailyExportEnabled to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setIncludeAdvertisingId(boolean value)

public BigQueryLink.Builder setIncludeAdvertisingId(boolean value)

If set true, exported data will include advertising identifiers for mobile app streams.

bool include_advertising_id = 6;

Parameter
Name Description
value boolean

The includeAdvertisingId to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setName(String value)

public BigQueryLink.Builder setName(String value)

Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setNameBytes(ByteString value)

public BigQueryLink.Builder setNameBytes(ByteString value)

Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setProject(String value)

public BigQueryLink.Builder setProject(String value)

Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'

string project = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The project to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public BigQueryLink.Builder setProjectBytes(ByteString value)

Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'

string project = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for project to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BigQueryLink.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BigQueryLink.Builder
Overrides

setStreamingExportEnabled(boolean value)

public BigQueryLink.Builder setStreamingExportEnabled(boolean value)

If set true, enables streaming export to the linked Google Cloud project.

bool streaming_export_enabled = 5;

Parameter
Name Description
value boolean

The streamingExportEnabled to set.
Returns
Type Description
BigQueryLink.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BigQueryLink.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BigQueryLink.Builder
Overrides