package schema
- Alphabetic
- Public
- Protected
Type Members
- final case class CommitSchemaRequest(name: String = "", schema: Option[Schema] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CommitSchemaRequest] with Product with Serializable
Request for CommitSchema method.
Request for CommitSchema method.
- name
Required. The name of the schema we are revising. Format is
projects/{project}/schemas/{schema}
.- schema
Required. The schema revision to commit.
- Annotations
- @SerialVersionUID()
- final case class CreateSchemaRequest(parent: String = "", schema: Option[Schema] = _root_.scala.None, schemaId: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CreateSchemaRequest] with Product with Serializable
Request for the CreateSchema method.
Request for the CreateSchema method.
- 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 aname
made using the givenparent
andschema_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/pubsub-basics#resource_names for resource name constraints.
- Annotations
- @SerialVersionUID()
- final case class DeleteSchemaRequest(name: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteSchemaRequest] with Product with Serializable
Request for the
DeleteSchema
method.Request for the
DeleteSchema
method.- name
Required. Name of the schema to delete. Format is
projects/{project}/schemas/{schema}
.
- Annotations
- @SerialVersionUID()
- final case class DeleteSchemaRevisionRequest(name: String = "", revisionId: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteSchemaRevisionRequest] with Product with Serializable
Request for the
DeleteSchemaRevision
method.Request for the
DeleteSchemaRevision
method.- name
Required. The name of the schema revision to be deleted, with a revision ID explicitly included. Example:
projects/123/schemas/my-schema@c7cfa2a8
- revisionId
Optional. This field is deprecated and should not be used for specifying the revision ID. The revision ID should be specified via the
name
parameter.
- Annotations
- @SerialVersionUID()
- sealed abstract class Encoding extends GeneratedEnum
Possible encoding types for messages.
- final case class GetSchemaRequest(name: String = "", view: SchemaView = com.google.pubsub.v1.schema.SchemaView.SCHEMA_VIEW_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetSchemaRequest] with Product with Serializable
Request for the GetSchema method.
Request for the GetSchema method.
- 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 all fields filled out. Set to
BASIC
to omit thedefinition
.
- Annotations
- @SerialVersionUID()
- final case class ListSchemaRevisionsRequest(name: String = "", view: SchemaView = com.google.pubsub.v1.schema.SchemaView.SCHEMA_VIEW_UNSPECIFIED, pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSchemaRevisionsRequest] with Product with Serializable
Request for the
ListSchemaRevisions
method.Request for the
ListSchemaRevisions
method.- name
Required. The name of the schema to list revisions for.
- view
The set of Schema fields to return in the response. If not set, returns Schemas with
name
andtype
, but notdefinition
. Set toFULL
to retrieve all fields.- pageSize
The maximum number of revisions to return per page.
- pageToken
The page token, received from a previous ListSchemaRevisions call. Provide this to retrieve the subsequent page.
- Annotations
- @SerialVersionUID()
- final case class ListSchemaRevisionsResponse(schemas: Seq[Schema] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSchemaRevisionsResponse] with Product with Serializable
Response for the
ListSchemaRevisions
method.Response for the
ListSchemaRevisions
method.- schemas
The revisions of the schema.
- nextPageToken
A token that can be sent as
page_token
to retrieve the next page. If this field is empty, there are no subsequent pages.
- Annotations
- @SerialVersionUID()
- final case class ListSchemasRequest(parent: String = "", view: SchemaView = com.google.pubsub.v1.schema.SchemaView.SCHEMA_VIEW_UNSPECIFIED, pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSchemasRequest] with Product with Serializable
Request for the
ListSchemas
method.Request for the
ListSchemas
method.- 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
andtype
, but notdefinition
. Set toFULL
to retrieve all fields.- pageSize
Maximum number of schemas to return.
- pageToken
The value returned by the last
ListSchemasResponse
; indicates that this is a continuation of a priorListSchemas
call, and that the system should return the next page of data.
- Annotations
- @SerialVersionUID()
- final case class ListSchemasResponse(schemas: Seq[Schema] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSchemasResponse] with Product with Serializable
Response for the
ListSchemas
method.Response for the
ListSchemas
method.- schemas
The resulting schemas.
- nextPageToken
If not empty, indicates that there may be more schemas that match the request; this value should be passed in a new
ListSchemasRequest
.
- Annotations
- @SerialVersionUID()
- final case class RollbackSchemaRequest(name: String = "", revisionId: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RollbackSchemaRequest] with Product with Serializable
Request for the
RollbackSchema
method.Request for the
RollbackSchema
method.- name
Required. The schema being rolled back with revision id.
- revisionId
Required. The revision ID to roll back to. It must be a revision of the same schema. Example: c7cfa2a8
- Annotations
- @SerialVersionUID()
- final case class Schema(name: String = "", type: Type = com.google.pubsub.v1.schema.Schema.Type.TYPE_UNSPECIFIED, definition: String = "", revisionId: String = "", revisionCreateTime: Option[Timestamp] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Schema] with Product with Serializable
A schema resource.
A schema resource.
- name
Required. Name of the schema. Format is
projects/{project}/schemas/{schema}
.- type
The type of the schema definition.
- 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
.- revisionId
Output only. Immutable. The revision ID of the schema.
- revisionCreateTime
Output only. The timestamp that the revision was created.
- Annotations
- @SerialVersionUID()
- trait SchemaService extends AnyRef
Service for doing schema-related operations.
Service for doing schema-related operations.
- Annotations
- @PekkoGrpcGenerated()
- trait SchemaServiceClient extends SchemaService with SchemaServiceClientPowerApi with PekkoGrpcClient
- Annotations
- @PekkoGrpcGenerated()
- trait SchemaServiceClientPowerApi extends AnyRef
- Annotations
- @PekkoGrpcGenerated()
- sealed abstract class SchemaView extends GeneratedEnum
View of Schema object fields to be returned by GetSchema and ListSchemas.
- final case class ValidateMessageRequest(parent: String = "", schemaSpec: SchemaSpec = com.google.pubsub.v1.schema.ValidateMessageRequest.SchemaSpec.Empty, message: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, encoding: Encoding = com.google.pubsub.v1.schema.Encoding.ENCODING_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ValidateMessageRequest] with Product with Serializable
Request for the
ValidateMessage
method.Request for the
ValidateMessage
method.- parent
Required. The name of the project in which to validate schemas. Format is
projects/{project-id}
.- message
Message to validate against the provided
schema_spec
.- encoding
The encoding expected for messages
- Annotations
- @SerialVersionUID()
- final case class ValidateMessageResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ValidateMessageResponse] with Product with Serializable
Response for the
ValidateMessage
method.Response for the
ValidateMessage
method. Empty for now.- Annotations
- @SerialVersionUID()
- final case class ValidateSchemaRequest(parent: String = "", schema: Option[Schema] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ValidateSchemaRequest] with Product with Serializable
Request for the
ValidateSchema
method.Request for the
ValidateSchema
method.- parent
Required. The name of the project in which to validate schemas. Format is
projects/{project-id}
.- schema
Required. The schema object to validate.
- Annotations
- @SerialVersionUID()
- final case class ValidateSchemaResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ValidateSchemaResponse] with Product with Serializable
Response for the
ValidateSchema
method.Response for the
ValidateSchema
method. Empty for now.- Annotations
- @SerialVersionUID()
Value Members
- object CommitSchemaRequest extends GeneratedMessageCompanion[CommitSchemaRequest]
- object CreateSchemaRequest extends GeneratedMessageCompanion[CreateSchemaRequest]
- object DeleteSchemaRequest extends GeneratedMessageCompanion[DeleteSchemaRequest]
- object DeleteSchemaRevisionRequest extends GeneratedMessageCompanion[DeleteSchemaRevisionRequest]
- object Encoding extends GeneratedEnumCompanion[Encoding]
- object GetSchemaRequest extends GeneratedMessageCompanion[GetSchemaRequest]
- object ListSchemaRevisionsRequest extends GeneratedMessageCompanion[ListSchemaRevisionsRequest]
- object ListSchemaRevisionsResponse extends GeneratedMessageCompanion[ListSchemaRevisionsResponse]
- object ListSchemasRequest extends GeneratedMessageCompanion[ListSchemasRequest]
- object ListSchemasResponse extends GeneratedMessageCompanion[ListSchemasResponse]
- object RollbackSchemaRequest extends GeneratedMessageCompanion[RollbackSchemaRequest]
- object Schema extends GeneratedMessageCompanion[Schema]
- object SchemaProto extends GeneratedFileObject
- object SchemaService extends ServiceDescription
- Annotations
- @PekkoGrpcGenerated()
- object SchemaServiceClient
- Annotations
- @PekkoGrpcGenerated()
- object SchemaView extends GeneratedEnumCompanion[SchemaView]
- object ValidateMessageRequest extends GeneratedMessageCompanion[ValidateMessageRequest]
- object ValidateMessageResponse extends GeneratedMessageCompanion[ValidateMessageResponse]
- object ValidateSchemaRequest extends GeneratedMessageCompanion[ValidateSchemaRequest]
- object ValidateSchemaResponse extends GeneratedMessageCompanion[ValidateSchemaResponse]