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 |
|---|
| Type | Description |
int | |
BACKFILL_NONE_FIELD_NUMBER
public static final int BACKFILL_NONE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CUSTOMER_MANAGED_ENCRYPTION_KEY_FIELD_NUMBER
public static final int CUSTOMER_MANAGED_ENCRYPTION_KEY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESTINATION_CONFIG_FIELD_NUMBER
public static final int DESTINATION_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ERRORS_FIELD_NUMBER
public static final int ERRORS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SOURCE_CONFIG_FIELD_NUMBER
public static final int SOURCE_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Stream getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Stream.Builder newBuilder()
newBuilder(Stream prototype)
public static Stream.Builder newBuilder(Stream prototype)
| Parameter |
|---|
| Name | Description |
prototype | Stream
|
public static Stream parseDelimitedFrom(InputStream input)
public static Stream parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Stream parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Stream parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Stream parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Stream parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Stream parseFrom(CodedInputStream input)
public static Stream parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Stream parseFrom(InputStream input)
public static Stream parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Stream parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Stream parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Stream> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Labels.
map<string, string> labels = 4;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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;
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;
getBackfillNone()
public Stream.BackfillNoneStrategy getBackfillNone()
Do not automatically backfill any objects.
.google.cloud.datastream.v1.Stream.BackfillNoneStrategy backfill_none = 102;
getBackfillNoneOrBuilder()
public Stream.BackfillNoneStrategyOrBuilder getBackfillNoneOrBuilder()
Do not automatically backfill any objects.
.google.cloud.datastream.v1.Stream.BackfillNoneStrategy backfill_none = 102;
getBackfillStrategyCase()
public Stream.BackfillStrategyCase getBackfillStrategyCase()
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 |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time of the stream.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
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()
getDestinationConfig()
public DestinationConfig getDestinationConfig()
Required. Destination connection profile configuration.
.google.cloud.datastream.v1.DestinationConfig destination_config = 7 [(.google.api.field_behavior) = REQUIRED];
getDestinationConfigOrBuilder()
public DestinationConfigOrBuilder getDestinationConfigOrBuilder()
Required. Destination connection profile configuration.
.google.cloud.datastream.v1.DestinationConfig destination_config = 7 [(.google.api.field_behavior) = REQUIRED];
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 |
|---|
| Name | Description |
index | int
|
| Returns |
|---|
| Type | Description |
Error | |
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 |
|---|
| Type | Description |
int | |
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];
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 |
|---|
| Name | Description |
index | int
|
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()
getLabelsCount()
public int getLabelsCount()
Labels.
map<string, string> labels = 4;
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels.
map<string, string> labels = 4;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels.
map<string, string> labels = 4;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels.
map<string, string> labels = 4;
| Parameter |
|---|
| Name | Description |
key | String
|
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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Stream> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSourceConfig()
public SourceConfig getSourceConfig()
Required. Source connection profile configuration.
.google.cloud.datastream.v1.SourceConfig source_config = 6 [(.google.api.field_behavior) = REQUIRED];
getSourceConfigOrBuilder()
public SourceConfigOrBuilder getSourceConfigOrBuilder()
Required. Source connection profile configuration.
.google.cloud.datastream.v1.SourceConfig source_config = 6 [(.google.api.field_behavior) = REQUIRED];
getState()
public Stream.State getState()
The state of the stream.
.google.cloud.datastream.v1.Stream.State state = 8;
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()
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 |
|---|
| Type | Description |
Timestamp | The updateTime.
|
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];
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 |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Stream.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Stream.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Stream.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
