- 0.61.0 (latest)
- 0.60.0
- 0.59.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface SubscriptionOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLinkedDatasetMap(String key)
public abstract 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 abstract 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. |
getCommercialInfoOrBuilder()
public abstract 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 abstract 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. |
getCreationTimeOrBuilder()
public abstract 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 abstract 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 abstract 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. |
getDestinationDataset()
public abstract 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. |
getDestinationDatasetOrBuilder()
public abstract 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 abstract 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. |
getLastModifyTimeOrBuilder()
public abstract 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 abstract Map<String,Subscription.LinkedResource> getLinkedDatasetMap()Use #getLinkedDatasetMapMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,LinkedResource> |
|
getLinkedDatasetMapCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
|
getLinkedResourcesCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getName()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Subscription.ResourceNameCase getResourceNameCase()| Returns | |
|---|---|
| Type | Description |
Subscription.ResourceNameCase |
|
getResourceType()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |