Class SchemaSettings (1.133.0)

public final class SchemaSettings extends GeneratedMessageV3 implements SchemaSettingsOrBuilder

Settings for validating messages published against a schema.

Protobuf type google.pubsub.v1.SchemaSettings

Static Fields

ENCODING_FIELD_NUMBER

public static final int ENCODING_FIELD_NUMBER
Field Value
Type Description
int

FIRST_REVISION_ID_FIELD_NUMBER

public static final int FIRST_REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

LAST_REVISION_ID_FIELD_NUMBER

public static final int LAST_REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SchemaSettings getDefaultInstance()
Returns
Type Description
SchemaSettings

getDescriptor()

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

newBuilder()

public static SchemaSettings.Builder newBuilder()
Returns
Type Description
SchemaSettings.Builder

newBuilder(SchemaSettings prototype)

public static SchemaSettings.Builder newBuilder(SchemaSettings prototype)
Parameter
Name Description
prototype SchemaSettings
Returns
Type Description
SchemaSettings.Builder

parseDelimitedFrom(InputStream input)

public static SchemaSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SchemaSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SchemaSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SchemaSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SchemaSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SchemaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SchemaSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SchemaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SchemaSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SchemaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SchemaSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SchemaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SchemaSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SchemaSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SchemaSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SchemaSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SchemaSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SchemaSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SchemaSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SchemaSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SchemaSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SchemaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SchemaSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SchemaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SchemaSettings> parser()
Returns
Type Description
Parser<SchemaSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SchemaSettings getDefaultInstanceForType()
Returns
Type Description
SchemaSettings

getEncoding()

public Encoding getEncoding()

Optional. The encoding of messages validated against schema.

.google.pubsub.v1.Encoding encoding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Encoding

The encoding.

getEncodingValue()

public int getEncodingValue()

Optional. The encoding of messages validated against schema.

.google.pubsub.v1.Encoding encoding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for encoding.

getFirstRevisionId()

public String getFirstRevisionId()

Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.

string first_revision_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The firstRevisionId.

getFirstRevisionIdBytes()

public ByteString getFirstRevisionIdBytes()

Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.

string first_revision_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for firstRevisionId.

getLastRevisionId()

public String getLastRevisionId()

Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.

string last_revision_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The lastRevisionId.

getLastRevisionIdBytes()

public ByteString getLastRevisionIdBytes()

Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.

string last_revision_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for lastRevisionId.

getParserForType()

public Parser<SchemaSettings> getParserForType()
Returns
Type Description
Parser<SchemaSettings>
Overrides

getSchema()

public String getSchema()

Required. The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be deleted-schema if the schema has been deleted.

string schema = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The schema.

getSchemaBytes()

public ByteString getSchemaBytes()

Required. The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be deleted-schema if the schema has been deleted.

string schema = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for schema.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SchemaSettings.Builder newBuilderForType()
Returns
Type Description
SchemaSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SchemaSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SchemaSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SchemaSettings.Builder toBuilder()
Returns
Type Description
SchemaSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException