Class BigQueryLink.Builder (0.40.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

Static Methods

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

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

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

repeated string excluded_events = 8;

Parameter
NameDescription
valuesIterable<String>

The excludedEvents to add.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
valuesIterable<String>

The exportStreams to add.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public BigQueryLink.Builder addExcludedEvents(String value)

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

repeated string excluded_events = 8;

Parameter
NameDescription
valueString

The excludedEvents to add.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public BigQueryLink.Builder addExcludedEventsBytes(ByteString value)

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

repeated string excluded_events = 8;

Parameter
NameDescription
valueByteString

The bytes of the excludedEvents to add.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
valueString

The exportStreams to add.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
valueByteString

The bytes of the exportStreams to add.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public BigQueryLink.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BigQueryLink.Builder
Overrides
public BigQueryLink build()
Returns
TypeDescription
BigQueryLink
public BigQueryLink buildPartial()
Returns
TypeDescription
BigQueryLink
public BigQueryLink.Builder clear()
Returns
TypeDescription
BigQueryLink.Builder
Overrides
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
TypeDescription
BigQueryLink.Builder
public BigQueryLink.Builder clearDailyExportEnabled()

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

bool daily_export_enabled = 4;

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public BigQueryLink.Builder clearExcludedEvents()

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

repeated string excluded_events = 8;

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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

This builder for chaining.

public BigQueryLink.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BigQueryLink.Builder
Overrides
public BigQueryLink.Builder clearFreshDailyExportEnabled()

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

bool fresh_daily_export_enabled = 9;

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public BigQueryLink.Builder clearIncludeAdvertisingId()

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

bool include_advertising_id = 6;

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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

This builder for chaining.

public BigQueryLink.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BigQueryLink.Builder
Overrides
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
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public BigQueryLink.Builder clearStreamingExportEnabled()

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

bool streaming_export_enabled = 5;

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public BigQueryLink.Builder clone()
Returns
TypeDescription
BigQueryLink.Builder
Overrides
public Timestamp getCreateTime()

Output only. Time when the link was created.

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

Returns
TypeDescription
Timestamp

The createTime.

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
TypeDescription
Builder
public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when the link was created.

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

Returns
TypeDescription
TimestampOrBuilder
public boolean getDailyExportEnabled()

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

bool daily_export_enabled = 4;

Returns
TypeDescription
boolean

The dailyExportEnabled.

public BigQueryLink getDefaultInstanceForType()
Returns
TypeDescription
BigQueryLink
public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides
public String getExcludedEvents(int index)

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

repeated string excluded_events = 8;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The excludedEvents at the given index.

public ByteString getExcludedEventsBytes(int index)

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

repeated string excluded_events = 8;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the excludedEvents at the given index.

public int getExcludedEventsCount()

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

repeated string excluded_events = 8;

Returns
TypeDescription
int

The count of excludedEvents.

public ProtocolStringList getExcludedEventsList()

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

repeated string excluded_events = 8;

Returns
TypeDescription
ProtocolStringList

A list containing the excludedEvents.

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The exportStreams at the given 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the exportStreams at the given index.

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
TypeDescription
int

The count of exportStreams.

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
TypeDescription
ProtocolStringList

A list containing the exportStreams.

public boolean getFreshDailyExportEnabled()

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

bool fresh_daily_export_enabled = 9;

Returns
TypeDescription
boolean

The freshDailyExportEnabled.

public boolean getIncludeAdvertisingId()

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

bool include_advertising_id = 6;

Returns
TypeDescription
boolean

The includeAdvertisingId.

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

The name.

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

The bytes for name.

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

The project.

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

The bytes for project.

public boolean getStreamingExportEnabled()

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

bool streaming_export_enabled = 5;

Returns
TypeDescription
boolean

The streamingExportEnabled.

public boolean hasCreateTime()

Output only. Time when the link was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides
public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides
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
NameDescription
valueTimestamp
Returns
TypeDescription
BigQueryLink.Builder
public BigQueryLink.Builder mergeFrom(BigQueryLink other)
Parameter
NameDescription
otherBigQueryLink
Returns
TypeDescription
BigQueryLink.Builder
public BigQueryLink.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryLink.Builder
Overrides
Exceptions
TypeDescription
IOException
public BigQueryLink.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BigQueryLink.Builder
Overrides
public final BigQueryLink.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BigQueryLink.Builder
Overrides
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
NameDescription
valueTimestamp
Returns
TypeDescription
BigQueryLink.Builder
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
BigQueryLink.Builder
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
NameDescription
valueboolean

The dailyExportEnabled to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
indexint

The index to set the value at.

valueString

The excludedEvents to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
indexint

The index to set the value at.

valueString

The exportStreams to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public BigQueryLink.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BigQueryLink.Builder
Overrides
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
NameDescription
valueboolean

The freshDailyExportEnabled to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
valueboolean

The includeAdvertisingId to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
valueString

The name to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
valueString

The project to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

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
NameDescription
valueByteString

The bytes for project to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public BigQueryLink.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BigQueryLink.Builder
Overrides
public BigQueryLink.Builder setStreamingExportEnabled(boolean value)

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

bool streaming_export_enabled = 5;

Parameter
NameDescription
valueboolean

The streamingExportEnabled to set.

Returns
TypeDescription
BigQueryLink.Builder

This builder for chaining.

public final BigQueryLink.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BigQueryLink.Builder
Overrides