com.google.pubsub.v1.schema

Type members

Classlikes

@SerialVersionUID(0L)
final case
class CreateSchemaRequest(parent: String, schema: Option[Schema], schemaId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CreateSchemaRequest]

Request for the CreateSchema method.

Request for the CreateSchema method.

Value Params
parent

Required. The name of the project in which to create the schema. Format is projects/{project-id}.

schema

Required. The schema object to create. This schema's name parameter is ignored. The schema object returned by CreateSchema will have a name made using the given parent and schema_id.

schemaId

The ID to use for the schema, which will become the final component of the schema's resource name. See https://cloud.google.com/pubsub/docs/admin#resource_names for resource name constraints.

Companion
object
object CreateSchemaRequest extends GeneratedMessageCompanion[CreateSchemaRequest] with JavaProtoSupport[CreateSchemaRequest, CreateSchemaRequest]
Companion
class
@SerialVersionUID(0L)
final case
class DeleteSchemaRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DeleteSchemaRequest]

Request for the DeleteSchema method.

Request for the DeleteSchema method.

Value Params
name

Required. Name of the schema to delete. Format is projects/{project}/schemas/{schema}.

Companion
object
object DeleteSchemaRequest extends GeneratedMessageCompanion[DeleteSchemaRequest] with JavaProtoSupport[DeleteSchemaRequest, DeleteSchemaRequest]
Companion
class
sealed abstract
class Encoding(val value: Int) extends GeneratedEnum

Possible encoding types for messages.

Possible encoding types for messages.

Companion
object
object Encoding extends GeneratedEnumCompanion[Encoding]
Companion
class
@SerialVersionUID(0L)
final case
class GetSchemaRequest(name: String, view: SchemaView, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[GetSchemaRequest]

Request for the GetSchema method.

Request for the GetSchema method.

Value Params
name

Required. The name of the schema to get. Format is projects/{project}/schemas/{schema}.

view

The set of fields to return in the response. If not set, returns a Schema with name and type, but not definition. Set to FULL to retrieve all fields.

Companion
object
object GetSchemaRequest extends GeneratedMessageCompanion[GetSchemaRequest] with JavaProtoSupport[GetSchemaRequest, GetSchemaRequest]
Companion
class
@SerialVersionUID(0L)
final case
class ListSchemasRequest(parent: String, view: SchemaView, pageSize: Int, pageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListSchemasRequest]

Request for the ListSchemas method.

Request for the ListSchemas method.

Value Params
pageSize

Maximum number of schemas to return.

pageToken

The value returned by the last ListSchemasResponse; indicates that this is a continuation of a prior ListSchemas call, and that the system should return the next page of data.

parent

Required. The name of the project in which to list schemas. Format is projects/{project-id}.

view

The set of Schema fields to return in the response. If not set, returns Schemas with name and type, but not definition. Set to FULL to retrieve all fields.

Companion
object
object ListSchemasRequest extends GeneratedMessageCompanion[ListSchemasRequest] with JavaProtoSupport[ListSchemasRequest, ListSchemasRequest]
Companion
class
@SerialVersionUID(0L)
final case
class ListSchemasResponse(schemas: Seq[Schema], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListSchemasResponse]

Response for the ListSchemas method.

Response for the ListSchemas method.

Value Params
nextPageToken

If not empty, indicates that there may be more schemas that match the request; this value should be passed in a new ListSchemasRequest.

schemas

The resulting schemas.

Companion
object
object ListSchemasResponse extends GeneratedMessageCompanion[ListSchemasResponse] with JavaProtoSupport[ListSchemasResponse, ListSchemasResponse]
Companion
class
@SerialVersionUID(0L)
final case
class Schema(name: String, `type`: Type, definition: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Schema]

A schema resource.

A schema resource.

Value Params
definition

The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in type.

name

Required. Name of the schema. Format is projects/{project}/schemas/{schema}.

type

The type of the schema definition.

Companion
object
object Schema extends GeneratedMessageCompanion[Schema] with JavaProtoSupport[Schema, Schema]
Companion
class
object SchemaProto extends GeneratedFileObject
sealed abstract
class SchemaView(val value: Int) extends GeneratedEnum

View of Schema object fields to be returned by GetSchema and ListSchemas.

View of Schema object fields to be returned by GetSchema and ListSchemas.

Companion
object
object SchemaView extends GeneratedEnumCompanion[SchemaView]
Companion
class
@SerialVersionUID(0L)
final case
class ValidateMessageRequest(parent: String, schemaSpec: SchemaSpec, message: ByteString, encoding: Encoding, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ValidateMessageRequest]

Request for the ValidateMessage method.

Request for the ValidateMessage method.

Value Params
encoding

The encoding expected for messages

message

Message to validate against the provided schema_spec.

parent

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.

Companion
object
object ValidateMessageRequest extends GeneratedMessageCompanion[ValidateMessageRequest] with JavaProtoSupport[ValidateMessageRequest, ValidateMessageRequest]
Companion
class
@SerialVersionUID(0L)
final case
class ValidateMessageResponse(unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ValidateMessageResponse]

Response for the ValidateMessage method. Empty for now.

Response for the ValidateMessage method. Empty for now.

Companion
object
object ValidateMessageResponse extends GeneratedMessageCompanion[ValidateMessageResponse] with JavaProtoSupport[ValidateMessageResponse, ValidateMessageResponse]
Companion
class
@SerialVersionUID(0L)
final case
class ValidateSchemaRequest(parent: String, schema: Option[Schema], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ValidateSchemaRequest]

Request for the ValidateSchema method.

Request for the ValidateSchema method.

Value Params
parent

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.

schema

Required. The schema object to validate.

Companion
object
object ValidateSchemaRequest extends GeneratedMessageCompanion[ValidateSchemaRequest] with JavaProtoSupport[ValidateSchemaRequest, ValidateSchemaRequest]
Companion
class
@SerialVersionUID(0L)
final case
class ValidateSchemaResponse(unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ValidateSchemaResponse]

Response for the ValidateSchema method. Empty for now.

Response for the ValidateSchema method. Empty for now.

Companion
object
object ValidateSchemaResponse extends GeneratedMessageCompanion[ValidateSchemaResponse] with JavaProtoSupport[ValidateSchemaResponse, ValidateSchemaResponse]
Companion
class