com.google.cloud.bigquery.analyticshub.v1

Interface SubscriptionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Subscription, Subscription.Builder

public interface SubscriptionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLinkedDatasetMap(String key) Output only.
Subscription.CommercialInfo	getCommercialInfo() Output only.
Subscription.CommercialInfoOrBuilder	getCommercialInfoOrBuilder() Output only.
com.google.protobuf.Timestamp	getCreationTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreationTimeOrBuilder() Output only.
String	getDataExchange() Output only.
com.google.protobuf.ByteString	getDataExchangeBytes() Output only.
DestinationDataset	getDestinationDataset() Optional.
DestinationDatasetOrBuilder	getDestinationDatasetOrBuilder() Optional.
com.google.protobuf.Timestamp	getLastModifyTime() Output only.
com.google.protobuf.TimestampOrBuilder	getLastModifyTimeOrBuilder() Output only.
Map<String,Subscription.LinkedResource>	getLinkedDatasetMap() Deprecated.
int	getLinkedDatasetMapCount() Output only.
Map<String,Subscription.LinkedResource>	getLinkedDatasetMapMap() Output only.
Subscription.LinkedResource	getLinkedDatasetMapOrDefault(String key, Subscription.LinkedResource defaultValue) Output only.
Subscription.LinkedResource	getLinkedDatasetMapOrThrow(String key) Output only.
Subscription.LinkedResource	getLinkedResources(int index) Output only.
int	getLinkedResourcesCount() Output only.
List<Subscription.LinkedResource>	getLinkedResourcesList() Output only.
Subscription.LinkedResourceOrBuilder	getLinkedResourcesOrBuilder(int index) Output only.
List<? extends Subscription.LinkedResourceOrBuilder>	getLinkedResourcesOrBuilderList() Output only.
String	getListing() Output only.
com.google.protobuf.ByteString	getListingBytes() Output only.
boolean	getLogLinkedDatasetQueryUserEmail() Output only.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getOrganizationDisplayName() Output only.
com.google.protobuf.ByteString	getOrganizationDisplayNameBytes() Output only.
String	getOrganizationId() Output only.
com.google.protobuf.ByteString	getOrganizationIdBytes() Output only.
Subscription.ResourceNameCase	getResourceNameCase()
SharedResourceType	getResourceType() Output only.
int	getResourceTypeValue() Output only.
Subscription.State	getState() Output only.
int	getStateValue() Output only.
String	getSubscriberContact() Output only.
com.google.protobuf.ByteString	getSubscriberContactBytes() Output only.
boolean	hasCommercialInfo() Output only.
boolean	hasCreationTime() Output only.
boolean	hasDataExchange() Output only.
boolean	hasDestinationDataset() Optional.
boolean	hasLastModifyTime() Output only.
boolean	hasListing() Output only.
boolean	hasLogLinkedDatasetQueryUserEmail() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasListing

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:

Whether the listing field is set.

getListing

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:

The listing.

getListingBytes

com.google.protobuf.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:

The bytes for listing.

hasDataExchange

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:

Whether the dataExchange field is set.

getDataExchange

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:

The dataExchange.

getDataExchangeBytes

com.google.protobuf.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:

The bytes for dataExchange.

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

hasCreationTime

boolean hasCreationTime()

 Output only. Timestamp when the subscription was created.
 

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

Returns:

Whether the creationTime field is set.

getCreationTime

com.google.protobuf.Timestamp getCreationTime()

 Output only. Timestamp when the subscription was created.
 

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

Returns:

The creationTime.

getCreationTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder()

 Output only. Timestamp when the subscription was created.
 

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

hasLastModifyTime

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:

Whether the lastModifyTime field is set.

getLastModifyTime

com.google.protobuf.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:

The lastModifyTime.

getLastModifyTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getLastModifyTimeOrBuilder()

 Output only. Timestamp when the subscription was last modified.
 

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

getOrganizationId

String getOrganizationId()

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

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

Returns:

The organizationId.

getOrganizationIdBytes

com.google.protobuf.ByteString getOrganizationIdBytes()

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

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

Returns:

The bytes for organizationId.

getOrganizationDisplayName

String getOrganizationDisplayName()

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

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

Returns:

The organizationDisplayName.

getOrganizationDisplayNameBytes

com.google.protobuf.ByteString getOrganizationDisplayNameBytes()

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

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

Returns:

The bytes for organizationDisplayName.

getStateValue

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:

The enum numeric value on the wire for state.

getState

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:

The state.

getLinkedDatasetMapCount

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];

containsLinkedDatasetMap

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];

getLinkedDatasetMap

@Deprecated
Map<String,Subscription.LinkedResource> getLinkedDatasetMap()

Deprecated.

Use getLinkedDatasetMapMap() instead.

getLinkedDatasetMapMap

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];

getLinkedDatasetMapOrDefault

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];

getLinkedDatasetMapOrThrow

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];

getSubscriberContact

String getSubscriberContact()

 Output only. Email of the subscriber.
 

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

Returns:

The subscriberContact.

getSubscriberContactBytes

com.google.protobuf.ByteString getSubscriberContactBytes()

 Output only. Email of the subscriber.
 

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

Returns:

The bytes for subscriberContact.

getLinkedResourcesList

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];

getLinkedResources

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];

getLinkedResourcesCount

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];

getLinkedResourcesOrBuilderList

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];

getLinkedResourcesOrBuilder

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];

getResourceTypeValue

int getResourceTypeValue()

 Output only. Listing shared asset type.
 

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

Returns:

The enum numeric value on the wire for resourceType.

getResourceType

SharedResourceType getResourceType()

 Output only. Listing shared asset type.
 

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

Returns:

The resourceType.

hasCommercialInfo

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:

Whether the commercialInfo field is set.

getCommercialInfo

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:

The commercialInfo.

getCommercialInfoOrBuilder

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];

hasLogLinkedDatasetQueryUserEmail

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:

Whether the logLinkedDatasetQueryUserEmail field is set.

getLogLinkedDatasetQueryUserEmail

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:

The logLinkedDatasetQueryUserEmail.

hasDestinationDataset

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:

Whether the destinationDataset field is set.

getDestinationDataset

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:

The destinationDataset.

getDestinationDatasetOrBuilder

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];

getResourceNameCase

Subscription.ResourceNameCase getResourceNameCase()