com.google.pubsub.v1.schema
Members list
Type members
Classlikes
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- CommitSchemaRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[CommitSchemaRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
CommitSchemaRequest.type
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 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/admin#resource_names for resource name constraints.
Attributes
- Companion
- object
- Source
- CreateSchemaRequest.scala
- Supertypes
-
trait Updatable[CreateSchemaRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- CreateSchemaRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[CreateSchemaRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
CreateSchemaRequest.type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- DeleteSchemaRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[DeleteSchemaRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
DeleteSchemaRequest.type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- DeleteSchemaRevisionRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[DeleteSchemaRevisionRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Possible encoding types for messages.
Possible encoding types for messages.
Attributes
- Companion
- object
- Source
- Encoding.scala
- Supertypes
- Known subtypes
-
object BINARY.typeobject ENCODING_UNSPECIFIED.typeobject JSON.typetrait Recognizedclass Unrecognized
Attributes
- Companion
- class
- Source
- Encoding.scala
- Supertypes
-
trait Sumtrait Mirrortrait GeneratedEnumCompanion[Encoding]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
Encoding.type
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 thedefinition
.
Attributes
- Companion
- object
- Source
- GetSchemaRequest.scala
- Supertypes
-
trait Updatable[GetSchemaRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- GetSchemaRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[GetSchemaRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
GetSchemaRequest.type
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
andtype
, but notdefinition
. Set toFULL
to retrieve all fields.
Attributes
- Companion
- object
- Source
- ListSchemaRevisionsRequest.scala
- Supertypes
-
trait Updatable[ListSchemaRevisionsRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListSchemaRevisionsRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListSchemaRevisionsRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListSchemaRevisionsResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListSchemaRevisionsResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
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 priorListSchemas
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
andtype
, but notdefinition
. Set toFULL
to retrieve all fields.
Attributes
- Companion
- object
- Source
- ListSchemasRequest.scala
- Supertypes
-
trait Updatable[ListSchemasRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListSchemasRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListSchemasRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
ListSchemasRequest.type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListSchemasResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListSchemasResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
ListSchemasResponse.type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- RollbackSchemaRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[RollbackSchemaRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
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
Attributes
- Companion
- class
- Source
- Schema.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[Schema]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
Schema.type
Attributes
- Source
- SchemaProto.scala
- Supertypes
-
class GeneratedFileObjectclass Objecttrait Matchableclass Any
- Self type
-
SchemaProto.type
Service for doing schema-related operations.
Service for doing schema-related operations.
Attributes
- Companion
- object
- Source
- SchemaService.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- trait
- Source
- SchemaService.scala
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
SchemaService.type
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
- Known subtypes
-
object BASIC.typeobject FULL.typetrait Recognizedobject SCHEMA_VIEW_UNSPECIFIED.typeclass Unrecognized
Attributes
- Companion
- class
- Source
- SchemaView.scala
- Supertypes
-
trait Sumtrait Mirrortrait GeneratedEnumCompanion[SchemaView]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
SchemaView.type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ValidateMessageRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ValidateMessageRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Response for the ValidateMessage
method.
Response for the ValidateMessage
method. Empty for now.
Attributes
- Companion
- object
- Source
- ValidateMessageResponse.scala
- Supertypes
-
trait Updatable[ValidateMessageResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ValidateMessageResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ValidateMessageResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ValidateSchemaRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ValidateSchemaRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Response for the ValidateSchema
method.
Response for the ValidateSchema
method. Empty for now.
Attributes
- Companion
- object
- Source
- ValidateSchemaResponse.scala
- Supertypes
-
trait Updatable[ValidateSchemaResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ValidateSchemaResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ValidateSchemaResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type