public final class Stream extends GeneratedMessageV3 implements StreamOrBuilder
A resource representing streaming data from a source to a destination.
Protobuf type google.cloud.datastream.v1.Stream
Static Fields
BACKFILL_ALL_FIELD_NUMBER
public static final int BACKFILL_ALL_FIELD_NUMBER
Field Value
BACKFILL_NONE_FIELD_NUMBER
public static final int BACKFILL_NONE_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
CUSTOMER_MANAGED_ENCRYPTION_KEY_FIELD_NUMBER
public static final int CUSTOMER_MANAGED_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
DESTINATION_CONFIG_FIELD_NUMBER
public static final int DESTINATION_CONFIG_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ERRORS_FIELD_NUMBER
public static final int ERRORS_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SOURCE_CONFIG_FIELD_NUMBER
public static final int SOURCE_CONFIG_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Stream getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Stream.Builder newBuilder()
Returns
newBuilder(Stream prototype)
public static Stream.Builder newBuilder(Stream prototype)
Parameter
Name | Description |
prototype | Stream
|
Returns
public static Stream parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Stream parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Stream parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Stream parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Stream parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Stream parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Stream parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Stream parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Stream parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Stream parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Stream parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Stream parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Stream> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Labels.
map<string, string> labels = 4;
Parameter
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBackfillAll()
public Stream.BackfillAllStrategy getBackfillAll()
Automatically backfill objects included in the stream source
configuration. Specific objects can be excluded.
.google.cloud.datastream.v1.Stream.BackfillAllStrategy backfill_all = 101;
Returns
getBackfillAllOrBuilder()
public Stream.BackfillAllStrategyOrBuilder getBackfillAllOrBuilder()
Automatically backfill objects included in the stream source
configuration. Specific objects can be excluded.
.google.cloud.datastream.v1.Stream.BackfillAllStrategy backfill_all = 101;
Returns
getBackfillNone()
public Stream.BackfillNoneStrategy getBackfillNone()
Do not automatically backfill any objects.
.google.cloud.datastream.v1.Stream.BackfillNoneStrategy backfill_none = 102;
Returns
getBackfillNoneOrBuilder()
public Stream.BackfillNoneStrategyOrBuilder getBackfillNoneOrBuilder()
Do not automatically backfill any objects.
.google.cloud.datastream.v1.Stream.BackfillNoneStrategy backfill_none = 102;
Returns
getBackfillStrategyCase()
public Stream.BackfillStrategyCase getBackfillStrategyCase()
Returns
getCreateTime()
public Timestamp getCreateTime()
Output only. The creation time of the stream.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time of the stream.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCustomerManagedEncryptionKey()
public String getCustomerManagedEncryptionKey()
Immutable. A reference to a KMS encryption key.
If provided, it will be used to encrypt the data.
If left blank, data will be encrypted using an internal Stream-specific
encryption key provisioned through KMS.
optional string customer_managed_encryption_key = 10 [(.google.api.field_behavior) = IMMUTABLE];
Returns
Type | Description |
String | The customerManagedEncryptionKey.
|
getCustomerManagedEncryptionKeyBytes()
public ByteString getCustomerManagedEncryptionKeyBytes()
Immutable. A reference to a KMS encryption key.
If provided, it will be used to encrypt the data.
If left blank, data will be encrypted using an internal Stream-specific
encryption key provisioned through KMS.
optional string customer_managed_encryption_key = 10 [(.google.api.field_behavior) = IMMUTABLE];
Returns
Type | Description |
ByteString | The bytes for customerManagedEncryptionKey.
|
getDefaultInstanceForType()
public Stream getDefaultInstanceForType()
Returns
getDestinationConfig()
public DestinationConfig getDestinationConfig()
Required. Destination connection profile configuration.
.google.cloud.datastream.v1.DestinationConfig destination_config = 7 [(.google.api.field_behavior) = REQUIRED];
Returns
getDestinationConfigOrBuilder()
public DestinationConfigOrBuilder getDestinationConfigOrBuilder()
Required. Destination connection profile configuration.
.google.cloud.datastream.v1.DestinationConfig destination_config = 7 [(.google.api.field_behavior) = REQUIRED];
Returns
getDisplayName()
public String getDisplayName()
Required. Display name.
string display_name = 5 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. Display name.
string display_name = 5 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
ByteString | The bytes for displayName.
|
getErrors(int index)
public Error getErrors(int index)
Output only. Errors on the Stream.
repeated .google.cloud.datastream.v1.Error errors = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Returns
getErrorsCount()
public int getErrorsCount()
Output only. Errors on the Stream.
repeated .google.cloud.datastream.v1.Error errors = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getErrorsList()
public List<Error> getErrorsList()
Output only. Errors on the Stream.
repeated .google.cloud.datastream.v1.Error errors = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getErrorsOrBuilder(int index)
public ErrorOrBuilder getErrorsOrBuilder(int index)
Output only. Errors on the Stream.
repeated .google.cloud.datastream.v1.Error errors = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Returns
getErrorsOrBuilderList()
public List<? extends ErrorOrBuilder> getErrorsOrBuilderList()
Output only. Errors on the Stream.
repeated .google.cloud.datastream.v1.Error errors = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
List<? extends com.google.cloud.datastream.v1.ErrorOrBuilder> | |
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Labels.
map<string, string> labels = 4;
Returns
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels.
map<string, string> labels = 4;
Returns
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels.
map<string, string> labels = 4;
Parameters
Returns
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels.
map<string, string> labels = 4;
Parameter
Returns
getName()
Output only. The stream's name.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The stream's name.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getParserForType()
public Parser<Stream> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceConfig()
public SourceConfig getSourceConfig()
Required. Source connection profile configuration.
.google.cloud.datastream.v1.SourceConfig source_config = 6 [(.google.api.field_behavior) = REQUIRED];
Returns
getSourceConfigOrBuilder()
public SourceConfigOrBuilder getSourceConfigOrBuilder()
Required. Source connection profile configuration.
.google.cloud.datastream.v1.SourceConfig source_config = 6 [(.google.api.field_behavior) = REQUIRED];
Returns
getState()
public Stream.State getState()
The state of the stream.
.google.cloud.datastream.v1.Stream.State state = 8;
Returns
getStateValue()
public int getStateValue()
The state of the stream.
.google.cloud.datastream.v1.Stream.State state = 8;
Returns
Type | Description |
int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last update time of the stream.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update time of the stream.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
hasBackfillAll()
public boolean hasBackfillAll()
Automatically backfill objects included in the stream source
configuration. Specific objects can be excluded.
.google.cloud.datastream.v1.Stream.BackfillAllStrategy backfill_all = 101;
Returns
Type | Description |
boolean | Whether the backfillAll field is set.
|
hasBackfillNone()
public boolean hasBackfillNone()
Do not automatically backfill any objects.
.google.cloud.datastream.v1.Stream.BackfillNoneStrategy backfill_none = 102;
Returns
Type | Description |
boolean | Whether the backfillNone field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. The creation time of the stream.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
boolean | Whether the createTime field is set.
|
hasCustomerManagedEncryptionKey()
public boolean hasCustomerManagedEncryptionKey()
Immutable. A reference to a KMS encryption key.
If provided, it will be used to encrypt the data.
If left blank, data will be encrypted using an internal Stream-specific
encryption key provisioned through KMS.
optional string customer_managed_encryption_key = 10 [(.google.api.field_behavior) = IMMUTABLE];
Returns
Type | Description |
boolean | Whether the customerManagedEncryptionKey field is set.
|
hasDestinationConfig()
public boolean hasDestinationConfig()
Required. Destination connection profile configuration.
.google.cloud.datastream.v1.DestinationConfig destination_config = 7 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
boolean | Whether the destinationConfig field is set.
|
hasSourceConfig()
public boolean hasSourceConfig()
Required. Source connection profile configuration.
.google.cloud.datastream.v1.SourceConfig source_config = 6 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
boolean | Whether the sourceConfig field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The last update time of the stream.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Stream.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Stream.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Stream.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions