http4s-grpc-google-cloud-pubsub-v1
1.108.0+0.0.6
API
Generated with
http4s-grpc-google-cloud-pubsub-v1/com.google.pubsub.v1/com.google.pubsub.v1.schema

com.google.pubsub.v1.schema

package com.google.pubsub.v1.schema

Members list

Type members

Classlikes

final case class CommitSchemaRequest(name: String, schema: Option[Schema], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CommitSchemaRequest]

Request for CommitSchema method.

Request for CommitSchema method.

Value parameters

name

Required. The name of the schema we are revising. Format is projects/{project}/schemas/{schema}.

schema

Required. The schema revision to commit.

Attributes

Companion
object
Source
CommitSchemaRequest.scala
Supertypes
trait Updatable[CommitSchemaRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CommitSchemaRequest extends GeneratedMessageCompanion[CommitSchemaRequest]

Attributes

Companion
class
Source
CommitSchemaRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CommitSchemaRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CreateSchemaRequest(parent: String, schema: Option[Schema], schemaId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CreateSchemaRequest]

Request for the CreateSchema method.

Request for the CreateSchema method.

Value parameters

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.

Attributes

Companion
object
Source
CreateSchemaRequest.scala
Supertypes
trait Updatable[CreateSchemaRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CreateSchemaRequest extends GeneratedMessageCompanion[CreateSchemaRequest]

Attributes

Companion
class
Source
CreateSchemaRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateSchemaRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DeleteSchemaRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DeleteSchemaRequest]

Request for the DeleteSchema method.

Request for the DeleteSchema method.

Value parameters

name

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

Attributes

Companion
object
Source
DeleteSchemaRequest.scala
Supertypes
trait Updatable[DeleteSchemaRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeleteSchemaRequest extends GeneratedMessageCompanion[DeleteSchemaRequest]

Attributes

Companion
class
Source
DeleteSchemaRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteSchemaRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DeleteSchemaRevisionRequest(name: String, revisionId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DeleteSchemaRevisionRequest]

Request for the DeleteSchemaRevision method.

Request for the DeleteSchemaRevision method.

Value parameters

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.

Attributes

Companion
object
Source
DeleteSchemaRevisionRequest.scala
Supertypes
trait Updatable[DeleteSchemaRevisionRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeleteSchemaRevisionRequest extends GeneratedMessageCompanion[DeleteSchemaRevisionRequest]

Attributes

Companion
class
Source
DeleteSchemaRevisionRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteSchemaRevisionRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class Encoding(val value: Int) extends GeneratedEnum

Possible encoding types for messages.

Possible encoding types for messages.

Attributes

Companion
object
Source
Encoding.scala
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object BINARY.type
object ENCODING_UNSPECIFIED.type
object JSON.type
trait Recognized
class Unrecognized
object Encoding extends GeneratedEnumCompanion[Encoding]

Attributes

Companion
class
Source
Encoding.scala
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[Encoding]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Encoding.type
final case class GetSchemaRequest(name: String, view: SchemaView, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetSchemaRequest]

Request for the GetSchema method.

Request for the GetSchema method.

Value parameters

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 the definition.

Attributes

Companion
object
Source
GetSchemaRequest.scala
Supertypes
trait Updatable[GetSchemaRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetSchemaRequest extends GeneratedMessageCompanion[GetSchemaRequest]

Attributes

Companion
class
Source
GetSchemaRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetSchemaRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ListSchemaRevisionsRequest(name: String, view: SchemaView, pageSize: Int, pageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListSchemaRevisionsRequest]

Request for the ListSchemaRevisions method.

Request for the ListSchemaRevisions method.

Value parameters

name

Required. The name of the schema to list revisions for.

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.

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.

Attributes

Companion
object
Source
ListSchemaRevisionsRequest.scala
Supertypes
trait Updatable[ListSchemaRevisionsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListSchemaRevisionsRequest extends GeneratedMessageCompanion[ListSchemaRevisionsRequest]

Attributes

Companion
class
Source
ListSchemaRevisionsRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListSchemaRevisionsRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ListSchemaRevisionsResponse(schemas: Seq[Schema], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListSchemaRevisionsResponse]

Response for the ListSchemaRevisions method.

Response for the ListSchemaRevisions method.

Value parameters

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.

schemas

The revisions of the schema.

Attributes

Companion
object
Source
ListSchemaRevisionsResponse.scala
Supertypes
trait Updatable[ListSchemaRevisionsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListSchemaRevisionsResponse extends GeneratedMessageCompanion[ListSchemaRevisionsResponse]

Attributes

Companion
class
Source
ListSchemaRevisionsResponse.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListSchemaRevisionsResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ListSchemasRequest(parent: String, view: SchemaView, pageSize: Int, pageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListSchemasRequest]

Request for the ListSchemas method.

Request for the ListSchemas method.

Value parameters

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.

Attributes

Companion
object
Source
ListSchemasRequest.scala
Supertypes
trait Updatable[ListSchemasRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListSchemasRequest extends GeneratedMessageCompanion[ListSchemasRequest]

Attributes

Companion
class
Source
ListSchemasRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListSchemasRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ListSchemasResponse(schemas: Seq[Schema], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListSchemasResponse]

Response for the ListSchemas method.

Response for the ListSchemas method.

Value parameters

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.

Attributes

Companion
object
Source
ListSchemasResponse.scala
Supertypes
trait Updatable[ListSchemasResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListSchemasResponse extends GeneratedMessageCompanion[ListSchemasResponse]

Attributes

Companion
class
Source
ListSchemasResponse.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListSchemasResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RollbackSchemaRequest(name: String, revisionId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RollbackSchemaRequest]

Request for the RollbackSchema method.

Request for the RollbackSchema method.

Value parameters

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

Attributes

Companion
object
Source
RollbackSchemaRequest.scala
Supertypes
trait Updatable[RollbackSchemaRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RollbackSchemaRequest extends GeneratedMessageCompanion[RollbackSchemaRequest]

Attributes

Companion
class
Source
RollbackSchemaRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RollbackSchemaRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class Schema(name: String, `type`: Type, definition: String, revisionId: String, revisionCreateTime: Option[Timestamp], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Schema]

A schema resource.

A schema resource.

Value parameters

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}.

revisionCreateTime

Output only. The timestamp that the revision was created.

revisionId

Output only. Immutable. The revision ID of the schema.

type

The type of the schema definition.

Attributes

Companion
object
Source
Schema.scala
Supertypes
trait Updatable[Schema]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Schema extends GeneratedMessageCompanion[Schema]

Attributes

Companion
class
Source
Schema.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Schema]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Schema.type
object SchemaProto extends GeneratedFileObject

Attributes

Source
SchemaProto.scala
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
trait SchemaService[F[_]]

Service for doing schema-related operations.

Service for doing schema-related operations.

Attributes

Companion
object
Source
SchemaService.scala
Supertypes
class Object
trait Matchable
class Any
object SchemaService

Attributes

Companion
trait
Source
SchemaService.scala
Supertypes
class Object
trait Matchable
class Any
Self type
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.

Attributes

Companion
object
Source
SchemaView.scala
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object BASIC.type
object FULL.type
trait Recognized
class Unrecognized
object SchemaView extends GeneratedEnumCompanion[SchemaView]

Attributes

Companion
class
Source
SchemaView.scala
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[SchemaView]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
SchemaView.type
final case class ValidateMessageRequest(parent: String, schemaSpec: SchemaSpec, message: ByteString, encoding: Encoding, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ValidateMessageRequest]

Request for the ValidateMessage method.

Request for the ValidateMessage method.

Value parameters

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}.

Attributes

Companion
object
Source
ValidateMessageRequest.scala
Supertypes
trait Updatable[ValidateMessageRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ValidateMessageRequest extends GeneratedMessageCompanion[ValidateMessageRequest]

Attributes

Companion
class
Source
ValidateMessageRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ValidateMessageRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ValidateMessageResponse(unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ValidateMessageResponse]

Response for the ValidateMessage method.

Response for the ValidateMessage method. Empty for now.

Attributes

Companion
object
Source
ValidateMessageResponse.scala
Supertypes
trait Updatable[ValidateMessageResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ValidateMessageResponse extends GeneratedMessageCompanion[ValidateMessageResponse]

Attributes

Companion
class
Source
ValidateMessageResponse.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ValidateMessageResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ValidateSchemaRequest(parent: String, schema: Option[Schema], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ValidateSchemaRequest]

Request for the ValidateSchema method.

Request for the ValidateSchema method.

Value parameters

parent

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

schema

Required. The schema object to validate.

Attributes

Companion
object
Source
ValidateSchemaRequest.scala
Supertypes
trait Updatable[ValidateSchemaRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ValidateSchemaRequest extends GeneratedMessageCompanion[ValidateSchemaRequest]

Attributes

Companion
class
Source
ValidateSchemaRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ValidateSchemaRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ValidateSchemaResponse(unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ValidateSchemaResponse]

Response for the ValidateSchema method.

Response for the ValidateSchema method. Empty for now.

Attributes

Companion
object
Source
ValidateSchemaResponse.scala
Supertypes
trait Updatable[ValidateSchemaResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ValidateSchemaResponse extends GeneratedMessageCompanion[ValidateSchemaResponse]

Attributes

Companion
class
Source
ValidateSchemaResponse.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ValidateSchemaResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Generated with