Class Subscription.Builder (0.61.0)

public static final class Subscription.Builder extends GeneratedMessageV3.Builder<Subscription.Builder> implements SubscriptionOrBuilder

A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.

Protobuf type google.cloud.bigquery.analyticshub.v1.Subscription

Static Methods

getDescriptor()

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

Methods

addAllLinkedResources(Iterable<? extends Subscription.LinkedResource> values)

public Subscription.Builder addAllLinkedResources(Iterable<? extends Subscription.LinkedResource> values)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource>
Returns
Type Description
Subscription.Builder

addLinkedResources(Subscription.LinkedResource value)

public Subscription.Builder addLinkedResources(Subscription.LinkedResource value)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Subscription.LinkedResource
Returns
Type Description
Subscription.Builder

addLinkedResources(Subscription.LinkedResource.Builder builderForValue)

public Subscription.Builder addLinkedResources(Subscription.LinkedResource.Builder builderForValue)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Subscription.LinkedResource.Builder
Returns
Type Description
Subscription.Builder

addLinkedResources(int index, Subscription.LinkedResource value)

public Subscription.Builder addLinkedResources(int index, Subscription.LinkedResource value)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Subscription.LinkedResource
Returns
Type Description
Subscription.Builder

addLinkedResources(int index, Subscription.LinkedResource.Builder builderForValue)

public Subscription.Builder addLinkedResources(int index, Subscription.LinkedResource.Builder builderForValue)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Subscription.LinkedResource.Builder
Returns
Type Description
Subscription.Builder

addLinkedResourcesBuilder()

public Subscription.LinkedResource.Builder addLinkedResourcesBuilder()

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.LinkedResource.Builder

addLinkedResourcesBuilder(int index)

public Subscription.LinkedResource.Builder addLinkedResourcesBuilder(int index)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Subscription.LinkedResource.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Subscription build()
Returns
Type Description
Subscription

buildPartial()

public Subscription buildPartial()
Returns
Type Description
Subscription

clear()

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

clearCommercialInfo()

public Subscription.Builder clearCommercialInfo()

Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

.google.cloud.bigquery.analyticshub.v1.Subscription.CommercialInfo commercial_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

clearCreationTime()

public Subscription.Builder clearCreationTime()

Output only. Timestamp when the subscription was created.

.google.protobuf.Timestamp creation_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

clearDataExchange()

public Subscription.Builder clearDataExchange()

Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456

string data_exchange = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

This builder for chaining.

clearDestinationDataset()

public Subscription.Builder clearDestinationDataset()

Optional. BigQuery destination dataset to create for the subscriber.

.google.cloud.bigquery.analyticshub.v1.DestinationDataset destination_dataset = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Subscription.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearLastModifyTime()

public Subscription.Builder clearLastModifyTime()

Output only. Timestamp when the subscription was last modified.

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

Returns
Type Description
Subscription.Builder

clearLinkedDatasetMap()

public Subscription.Builder clearLinkedDatasetMap()
Returns
Type Description
Subscription.Builder

clearLinkedResources()

public Subscription.Builder clearLinkedResources()

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

clearListing()

public Subscription.Builder clearListing()

Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789

string listing = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

This builder for chaining.

clearLogLinkedDatasetQueryUserEmail()

public Subscription.Builder clearLogLinkedDatasetQueryUserEmail()

Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.

optional bool log_linked_dataset_query_user_email = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

This builder for chaining.

clearName()

public Subscription.Builder clearName()

Output only. The resource name of the subscription. e.g. projects/myproject/locations/us/subscriptions/123.

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

Returns
Type Description
Subscription.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrganizationDisplayName()

public Subscription.Builder clearOrganizationDisplayName()

Output only. Display name of the project of this subscription.

string organization_display_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

This builder for chaining.

clearOrganizationId()

public Subscription.Builder clearOrganizationId()

Output only. Organization of the project this subscription belongs to.

string organization_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

This builder for chaining.

clearResourceName()

public Subscription.Builder clearResourceName()
Returns
Type Description
Subscription.Builder

clearResourceType()

public Subscription.Builder clearResourceType()

Output only. Listing shared asset type.

.google.cloud.bigquery.analyticshub.v1.SharedResourceType resource_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

This builder for chaining.

clearState()

public Subscription.Builder clearState()

Output only. Current state of the subscription.

.google.cloud.bigquery.analyticshub.v1.Subscription.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

This builder for chaining.

clearSubscriberContact()

public Subscription.Builder clearSubscriberContact()

Output only. Email of the subscriber.

string subscriber_contact = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.Builder

This builder for chaining.

clone()

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

containsLinkedDatasetMap(String key)

public boolean containsLinkedDatasetMap(String key)

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

map<string, .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource> linked_dataset_map = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCommercialInfo()

public Subscription.CommercialInfo getCommercialInfo()

Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

.google.cloud.bigquery.analyticshub.v1.Subscription.CommercialInfo commercial_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.CommercialInfo

The commercialInfo.

getCommercialInfoBuilder()

public Subscription.CommercialInfo.Builder getCommercialInfoBuilder()

Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

.google.cloud.bigquery.analyticshub.v1.Subscription.CommercialInfo commercial_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.CommercialInfo.Builder

getCommercialInfoOrBuilder()

public Subscription.CommercialInfoOrBuilder getCommercialInfoOrBuilder()

Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

.google.cloud.bigquery.analyticshub.v1.Subscription.CommercialInfo commercial_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.CommercialInfoOrBuilder

getCreationTime()

public Timestamp getCreationTime()

Output only. Timestamp when the subscription was created.

.google.protobuf.Timestamp creation_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The creationTime.

getCreationTimeBuilder()

public Timestamp.Builder getCreationTimeBuilder()

Output only. Timestamp when the subscription was created.

.google.protobuf.Timestamp creation_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreationTimeOrBuilder()

public TimestampOrBuilder getCreationTimeOrBuilder()

Output only. Timestamp when the subscription was created.

.google.protobuf.Timestamp creation_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataExchange()

public String getDataExchange()

Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456

string data_exchange = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The dataExchange.

getDataExchangeBytes()

public ByteString getDataExchangeBytes()

Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456

string data_exchange = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for dataExchange.

getDefaultInstanceForType()

public Subscription getDefaultInstanceForType()
Returns
Type Description
Subscription

getDescriptorForType()

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

getDestinationDataset()

public DestinationDataset getDestinationDataset()

Optional. BigQuery destination dataset to create for the subscriber.

.google.cloud.bigquery.analyticshub.v1.DestinationDataset destination_dataset = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DestinationDataset

The destinationDataset.

getDestinationDatasetBuilder()

public DestinationDataset.Builder getDestinationDatasetBuilder()

Optional. BigQuery destination dataset to create for the subscriber.

.google.cloud.bigquery.analyticshub.v1.DestinationDataset destination_dataset = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DestinationDataset.Builder

getDestinationDatasetOrBuilder()

public DestinationDatasetOrBuilder getDestinationDatasetOrBuilder()

Optional. BigQuery destination dataset to create for the subscriber.

.google.cloud.bigquery.analyticshub.v1.DestinationDataset destination_dataset = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DestinationDatasetOrBuilder

getLastModifyTime()

public Timestamp getLastModifyTime()

Output only. Timestamp when the subscription was last modified.

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

Returns
Type Description
Timestamp

The lastModifyTime.

getLastModifyTimeBuilder()

public Timestamp.Builder getLastModifyTimeBuilder()

Output only. Timestamp when the subscription was last modified.

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

Returns
Type Description
Builder

getLastModifyTimeOrBuilder()

public TimestampOrBuilder getLastModifyTimeOrBuilder()

Output only. Timestamp when the subscription was last modified.

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

Returns
Type Description
TimestampOrBuilder

getLinkedDatasetMap() (deprecated)

public Map<String,Subscription.LinkedResource> getLinkedDatasetMap()
Returns
Type Description
Map<String,LinkedResource>

getLinkedDatasetMapCount()

public int getLinkedDatasetMapCount()

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

map<string, .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource> linked_dataset_map = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getLinkedDatasetMapMap()

public Map<String,Subscription.LinkedResource> getLinkedDatasetMapMap()

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

map<string, .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource> linked_dataset_map = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Map<String,LinkedResource>

getLinkedDatasetMapOrDefault(String key, Subscription.LinkedResource defaultValue)

public Subscription.LinkedResource getLinkedDatasetMapOrDefault(String key, Subscription.LinkedResource defaultValue)

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

map<string, .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource> linked_dataset_map = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
defaultValue Subscription.LinkedResource
Returns
Type Description
Subscription.LinkedResource

getLinkedDatasetMapOrThrow(String key)

public Subscription.LinkedResource getLinkedDatasetMapOrThrow(String key)

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

map<string, .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource> linked_dataset_map = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
Subscription.LinkedResource

getLinkedResources(int index)

public Subscription.LinkedResource getLinkedResources(int index)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Subscription.LinkedResource

getLinkedResourcesBuilder(int index)

public Subscription.LinkedResource.Builder getLinkedResourcesBuilder(int index)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Subscription.LinkedResource.Builder

getLinkedResourcesBuilderList()

public List<Subscription.LinkedResource.Builder> getLinkedResourcesBuilderList()

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getLinkedResourcesCount()

public int getLinkedResourcesCount()

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getLinkedResourcesList()

public List<Subscription.LinkedResource> getLinkedResourcesList()

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<LinkedResource>

getLinkedResourcesOrBuilder(int index)

public Subscription.LinkedResourceOrBuilder getLinkedResourcesOrBuilder(int index)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Subscription.LinkedResourceOrBuilder

getLinkedResourcesOrBuilderList()

public List<? extends Subscription.LinkedResourceOrBuilder> getLinkedResourcesOrBuilderList()

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResourceOrBuilder>

getListing()

public String getListing()

Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789

string listing = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The listing.

getListingBytes()

public ByteString getListingBytes()

Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789

string listing = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for listing.

getLogLinkedDatasetQueryUserEmail()

public boolean getLogLinkedDatasetQueryUserEmail()

Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.

optional bool log_linked_dataset_query_user_email = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The logLinkedDatasetQueryUserEmail.

getMutableLinkedDatasetMap() (deprecated)

public Map<String,Subscription.LinkedResource> getMutableLinkedDatasetMap()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,LinkedResource>

getName()

public String getName()

Output only. The resource name of the subscription. e.g. projects/myproject/locations/us/subscriptions/123.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the subscription. e.g. projects/myproject/locations/us/subscriptions/123.

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

Returns
Type Description
ByteString

The bytes for name.

getOrganizationDisplayName()

public String getOrganizationDisplayName()

Output only. Display name of the project of this subscription.

string organization_display_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The organizationDisplayName.

getOrganizationDisplayNameBytes()

public ByteString getOrganizationDisplayNameBytes()

Output only. Display name of the project of this subscription.

string organization_display_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for organizationDisplayName.

getOrganizationId()

public String getOrganizationId()

Output only. Organization of the project this subscription belongs to.

string organization_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The organizationId.

getOrganizationIdBytes()

public ByteString getOrganizationIdBytes()

Output only. Organization of the project this subscription belongs to.

string organization_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for organizationId.

getResourceNameCase()

public Subscription.ResourceNameCase getResourceNameCase()
Returns
Type Description
Subscription.ResourceNameCase

getResourceType()

public SharedResourceType getResourceType()

Output only. Listing shared asset type.

.google.cloud.bigquery.analyticshub.v1.SharedResourceType resource_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SharedResourceType

The resourceType.

getResourceTypeValue()

public int getResourceTypeValue()

Output only. Listing shared asset type.

.google.cloud.bigquery.analyticshub.v1.SharedResourceType resource_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for resourceType.

getState()

public Subscription.State getState()

Output only. Current state of the subscription.

.google.cloud.bigquery.analyticshub.v1.Subscription.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Subscription.State

The state.

getStateValue()

public int getStateValue()

Output only. Current state of the subscription.

.google.cloud.bigquery.analyticshub.v1.Subscription.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getSubscriberContact()

public String getSubscriberContact()

Output only. Email of the subscriber.

string subscriber_contact = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The subscriberContact.

getSubscriberContactBytes()

public ByteString getSubscriberContactBytes()

Output only. Email of the subscriber.

string subscriber_contact = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for subscriberContact.

hasCommercialInfo()

public boolean hasCommercialInfo()

Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

.google.cloud.bigquery.analyticshub.v1.Subscription.CommercialInfo commercial_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the commercialInfo field is set.

hasCreationTime()

public boolean hasCreationTime()

Output only. Timestamp when the subscription was created.

.google.protobuf.Timestamp creation_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the creationTime field is set.

hasDataExchange()

public boolean hasDataExchange()

Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456

string data_exchange = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dataExchange field is set.

hasDestinationDataset()

public boolean hasDestinationDataset()

Optional. BigQuery destination dataset to create for the subscriber.

.google.cloud.bigquery.analyticshub.v1.DestinationDataset destination_dataset = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the destinationDataset field is set.

hasLastModifyTime()

public boolean hasLastModifyTime()

Output only. Timestamp when the subscription was last modified.

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

Returns
Type Description
boolean

Whether the lastModifyTime field is set.

hasListing()

public boolean hasListing()

Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789

string listing = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the listing field is set.

hasLogLinkedDatasetQueryUserEmail()

public boolean hasLogLinkedDatasetQueryUserEmail()

Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.

optional bool log_linked_dataset_query_user_email = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the logLinkedDatasetQueryUserEmail field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommercialInfo(Subscription.CommercialInfo value)

public Subscription.Builder mergeCommercialInfo(Subscription.CommercialInfo value)

Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

.google.cloud.bigquery.analyticshub.v1.Subscription.CommercialInfo commercial_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Subscription.CommercialInfo
Returns
Type Description
Subscription.Builder

mergeCreationTime(Timestamp value)

public Subscription.Builder mergeCreationTime(Timestamp value)

Output only. Timestamp when the subscription was created.

.google.protobuf.Timestamp creation_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Subscription.Builder

mergeDestinationDataset(DestinationDataset value)

public Subscription.Builder mergeDestinationDataset(DestinationDataset value)

Optional. BigQuery destination dataset to create for the subscriber.

.google.cloud.bigquery.analyticshub.v1.DestinationDataset destination_dataset = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DestinationDataset
Returns
Type Description
Subscription.Builder

mergeFrom(Subscription other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeLastModifyTime(Timestamp value)

public Subscription.Builder mergeLastModifyTime(Timestamp value)

Output only. Timestamp when the subscription was last modified.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Subscription.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLinkedDatasetMap(Map<String,Subscription.LinkedResource> values)

public Subscription.Builder putAllLinkedDatasetMap(Map<String,Subscription.LinkedResource> values)

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

map<string, .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource> linked_dataset_map = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Map<String,LinkedResource>
Returns
Type Description
Subscription.Builder

putLinkedDatasetMap(String key, Subscription.LinkedResource value)

public Subscription.Builder putLinkedDatasetMap(String key, Subscription.LinkedResource value)

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

map<string, .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource> linked_dataset_map = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
value Subscription.LinkedResource
Returns
Type Description
Subscription.Builder

putLinkedDatasetMapBuilderIfAbsent(String key)

public Subscription.LinkedResource.Builder putLinkedDatasetMapBuilderIfAbsent(String key)

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

map<string, .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource> linked_dataset_map = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
Subscription.LinkedResource.Builder

removeLinkedDatasetMap(String key)

public Subscription.Builder removeLinkedDatasetMap(String key)

Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset

For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.

map<string, .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource> linked_dataset_map = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
Subscription.Builder

removeLinkedResources(int index)

public Subscription.Builder removeLinkedResources(int index)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Subscription.Builder

setCommercialInfo(Subscription.CommercialInfo value)

public Subscription.Builder setCommercialInfo(Subscription.CommercialInfo value)

Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

.google.cloud.bigquery.analyticshub.v1.Subscription.CommercialInfo commercial_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Subscription.CommercialInfo
Returns
Type Description
Subscription.Builder

setCommercialInfo(Subscription.CommercialInfo.Builder builderForValue)

public Subscription.Builder setCommercialInfo(Subscription.CommercialInfo.Builder builderForValue)

Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

.google.cloud.bigquery.analyticshub.v1.Subscription.CommercialInfo commercial_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Subscription.CommercialInfo.Builder
Returns
Type Description
Subscription.Builder

setCreationTime(Timestamp value)

public Subscription.Builder setCreationTime(Timestamp value)

Output only. Timestamp when the subscription was created.

.google.protobuf.Timestamp creation_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Subscription.Builder

setCreationTime(Timestamp.Builder builderForValue)

public Subscription.Builder setCreationTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the subscription was created.

.google.protobuf.Timestamp creation_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Subscription.Builder

setDataExchange(String value)

public Subscription.Builder setDataExchange(String value)

Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456

string data_exchange = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The dataExchange to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setDataExchangeBytes(ByteString value)

public Subscription.Builder setDataExchangeBytes(ByteString value)

Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456

string data_exchange = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for dataExchange to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setDestinationDataset(DestinationDataset value)

public Subscription.Builder setDestinationDataset(DestinationDataset value)

Optional. BigQuery destination dataset to create for the subscriber.

.google.cloud.bigquery.analyticshub.v1.DestinationDataset destination_dataset = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DestinationDataset
Returns
Type Description
Subscription.Builder

setDestinationDataset(DestinationDataset.Builder builderForValue)

public Subscription.Builder setDestinationDataset(DestinationDataset.Builder builderForValue)

Optional. BigQuery destination dataset to create for the subscriber.

.google.cloud.bigquery.analyticshub.v1.DestinationDataset destination_dataset = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DestinationDataset.Builder
Returns
Type Description
Subscription.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setLastModifyTime(Timestamp value)

public Subscription.Builder setLastModifyTime(Timestamp value)

Output only. Timestamp when the subscription was last modified.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Subscription.Builder

setLastModifyTime(Timestamp.Builder builderForValue)

public Subscription.Builder setLastModifyTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the subscription was last modified.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Subscription.Builder

setLinkedResources(int index, Subscription.LinkedResource value)

public Subscription.Builder setLinkedResources(int index, Subscription.LinkedResource value)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Subscription.LinkedResource
Returns
Type Description
Subscription.Builder

setLinkedResources(int index, Subscription.LinkedResource.Builder builderForValue)

public Subscription.Builder setLinkedResources(int index, Subscription.LinkedResource.Builder builderForValue)

Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

repeated .google.cloud.bigquery.analyticshub.v1.Subscription.LinkedResource linked_resources = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Subscription.LinkedResource.Builder
Returns
Type Description
Subscription.Builder

setListing(String value)

public Subscription.Builder setListing(String value)

Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789

string listing = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The listing to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setListingBytes(ByteString value)

public Subscription.Builder setListingBytes(ByteString value)

Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789

string listing = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for listing to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setLogLinkedDatasetQueryUserEmail(boolean value)

public Subscription.Builder setLogLinkedDatasetQueryUserEmail(boolean value)

Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.

optional bool log_linked_dataset_query_user_email = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The logLinkedDatasetQueryUserEmail to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setName(String value)

public Subscription.Builder setName(String value)

Output only. The resource name of the subscription. e.g. projects/myproject/locations/us/subscriptions/123.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Subscription.Builder setNameBytes(ByteString value)

Output only. The resource name of the subscription. e.g. projects/myproject/locations/us/subscriptions/123.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setOrganizationDisplayName(String value)

public Subscription.Builder setOrganizationDisplayName(String value)

Output only. Display name of the project of this subscription.

string organization_display_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The organizationDisplayName to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setOrganizationDisplayNameBytes(ByteString value)

public Subscription.Builder setOrganizationDisplayNameBytes(ByteString value)

Output only. Display name of the project of this subscription.

string organization_display_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for organizationDisplayName to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setOrganizationId(String value)

public Subscription.Builder setOrganizationId(String value)

Output only. Organization of the project this subscription belongs to.

string organization_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The organizationId to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setOrganizationIdBytes(ByteString value)

public Subscription.Builder setOrganizationIdBytes(ByteString value)

Output only. Organization of the project this subscription belongs to.

string organization_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for organizationId to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

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

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

setResourceType(SharedResourceType value)

public Subscription.Builder setResourceType(SharedResourceType value)

Output only. Listing shared asset type.

.google.cloud.bigquery.analyticshub.v1.SharedResourceType resource_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SharedResourceType

The resourceType to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setResourceTypeValue(int value)

public Subscription.Builder setResourceTypeValue(int value)

Output only. Listing shared asset type.

.google.cloud.bigquery.analyticshub.v1.SharedResourceType resource_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

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

Returns
Type Description
Subscription.Builder

This builder for chaining.

setState(Subscription.State value)

public Subscription.Builder setState(Subscription.State value)

Output only. Current state of the subscription.

.google.cloud.bigquery.analyticshub.v1.Subscription.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Subscription.State

The state to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setStateValue(int value)

public Subscription.Builder setStateValue(int value)

Output only. Current state of the subscription.

.google.cloud.bigquery.analyticshub.v1.Subscription.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

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

Returns
Type Description
Subscription.Builder

This builder for chaining.

setSubscriberContact(String value)

public Subscription.Builder setSubscriberContact(String value)

Output only. Email of the subscriber.

string subscriber_contact = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The subscriberContact to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setSubscriberContactBytes(ByteString value)

public Subscription.Builder setSubscriberContactBytes(ByteString value)

Output only. Email of the subscriber.

string subscriber_contact = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for subscriberContact to set.

Returns
Type Description
Subscription.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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