Class BigQueryLink (0.58.0)

public final class BigQueryLink extends GeneratedMessageV3 implements BigQueryLinkOrBuilder

A link between a GA4 Property and BigQuery project.

Protobuf type google.analytics.admin.v1alpha.BigQueryLink

Static Fields

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
public static final int DAILY_EXPORT_ENABLED_FIELD_NUMBER
Field Value
Type Description
int
public static final int DATASET_LOCATION_FIELD_NUMBER
Field Value
Type Description
int
public static final int EXCLUDED_EVENTS_FIELD_NUMBER
Field Value
Type Description
int
public static final int EXPORT_STREAMS_FIELD_NUMBER
Field Value
Type Description
int
public static final int FRESH_DAILY_EXPORT_ENABLED_FIELD_NUMBER
Field Value
Type Description
int
public static final int INCLUDE_ADVERTISING_ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int PROJECT_FIELD_NUMBER
Field Value
Type Description
int
public static final int STREAMING_EXPORT_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

public static BigQueryLink getDefaultInstance()
Returns
Type Description
BigQueryLink
public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor
public static BigQueryLink.Builder newBuilder()
Returns
Type Description
BigQueryLink.Builder
public static BigQueryLink.Builder newBuilder(BigQueryLink prototype)
Parameter
Name Description
prototype BigQueryLink
Returns
Type Description
BigQueryLink.Builder
public static BigQueryLink parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigQueryLink
Exceptions
Type Description
IOException
public static BigQueryLink parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryLink
Exceptions
Type Description
IOException
public static BigQueryLink parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BigQueryLink
Exceptions
Type Description
InvalidProtocolBufferException
public static BigQueryLink parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryLink
Exceptions
Type Description
InvalidProtocolBufferException
public static BigQueryLink parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BigQueryLink
Exceptions
Type Description
InvalidProtocolBufferException
public static BigQueryLink parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryLink
Exceptions
Type Description
InvalidProtocolBufferException
public static BigQueryLink parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BigQueryLink
Exceptions
Type Description
IOException
public static BigQueryLink parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryLink
Exceptions
Type Description
IOException
public static BigQueryLink parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigQueryLink
Exceptions
Type Description
IOException
public static BigQueryLink parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryLink
Exceptions
Type Description
IOException
public static BigQueryLink parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BigQueryLink
Exceptions
Type Description
InvalidProtocolBufferException
public static BigQueryLink parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryLink
Exceptions
Type Description
InvalidProtocolBufferException
public static Parser<BigQueryLink> parser()
Returns
Type Description
Parser<BigQueryLink>

Methods

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
Timestamp

The createTime.

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

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.

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.

public BigQueryLink getDefaultInstanceForType()
Returns
Type Description
BigQueryLink
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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

public Parser<BigQueryLink> getParserForType()
Returns
Type Description
Parser<BigQueryLink>
Overrides
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.

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.

public int getSerializedSize()
Returns
Type Description
int
Overrides
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.

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.

public int hashCode()
Returns
Type Description
int
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides
public final boolean isInitialized()
Returns
Type Description
boolean
Overrides
public BigQueryLink.Builder newBuilderForType()
Returns
Type Description
BigQueryLink.Builder
protected BigQueryLink.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BigQueryLink.Builder
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides
public BigQueryLink.Builder toBuilder()
Returns
Type Description
BigQueryLink.Builder
public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException