Cloud Pub/Sub v1 API - Class SchemaService.SchemaServiceClient (3.12.0)

Version latest

• 3.12.0 (latest)
• 3.11.0
• 3.10.1
• 3.9.1
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0

public class SchemaService.SchemaServiceClient : ClientBase<SchemaService.SchemaServiceClient>

Reference documentation and code samples for the Cloud Pub/Sub v1 API class SchemaService.SchemaServiceClient.

Client for SchemaService

Inheritance

object > ClientBase > ClientBaseSchemaServiceSchemaServiceClient > SchemaService.SchemaServiceClient

Inherited Members

ClientBase<SchemaService.SchemaServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

SchemaServiceClient()

protected SchemaServiceClient()

Protected parameterless constructor to allow creation of test doubles.

SchemaServiceClient(CallInvoker)

public SchemaServiceClient(CallInvoker callInvoker)

Creates a new client for SchemaService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

SchemaServiceClient(ChannelBase)

public SchemaServiceClient(ChannelBase channel)

Creates a new client for SchemaService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

SchemaServiceClient(ClientBaseConfiguration)

protected SchemaServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CommitSchema(CommitSchemaRequest, CallOptions)

public virtual Schema CommitSchema(CommitSchemaRequest request, CallOptions options)

Commits a new schema revision to an existing schema.

Parameters
Name	Description
request	CommitSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Schema	The response received from the server.

CommitSchema(CommitSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual Schema CommitSchema(CommitSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Commits a new schema revision to an existing schema.

Parameters
Name	Description
request	CommitSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Schema	The response received from the server.

CommitSchemaAsync(CommitSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<Schema> CommitSchemaAsync(CommitSchemaRequest request, CallOptions options)

Commits a new schema revision to an existing schema.

Parameters
Name	Description
request	CommitSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

CommitSchemaAsync(CommitSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schema> CommitSchemaAsync(CommitSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Commits a new schema revision to an existing schema.

Parameters
Name	Description
request	CommitSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateSchema(CreateSchemaRequest, CallOptions)

public virtual Schema CreateSchema(CreateSchemaRequest request, CallOptions options)

Creates a schema.

Parameters
Name	Description
request	CreateSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Schema	The response received from the server.

CreateSchema(CreateSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual Schema CreateSchema(CreateSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a schema.

Parameters
Name	Description
request	CreateSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Schema	The response received from the server.

CreateSchemaAsync(CreateSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<Schema> CreateSchemaAsync(CreateSchemaRequest request, CallOptions options)

Creates a schema.

Parameters
Name	Description
request	CreateSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

CreateSchemaAsync(CreateSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schema> CreateSchemaAsync(CreateSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a schema.

Parameters
Name	Description
request	CreateSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

DeleteSchema(DeleteSchemaRequest, CallOptions)

public virtual Empty DeleteSchema(DeleteSchemaRequest request, CallOptions options)

Deletes a schema.

Parameters
Name	Description
request	DeleteSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteSchema(DeleteSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteSchema(DeleteSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a schema.

Parameters
Name	Description
request	DeleteSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteSchemaAsync(DeleteSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteSchemaAsync(DeleteSchemaRequest request, CallOptions options)

Deletes a schema.

Parameters
Name	Description
request	DeleteSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteSchemaAsync(DeleteSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteSchemaAsync(DeleteSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a schema.

Parameters
Name	Description
request	DeleteSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteSchemaRevision(DeleteSchemaRevisionRequest, CallOptions)

public virtual Schema DeleteSchemaRevision(DeleteSchemaRevisionRequest request, CallOptions options)

Deletes a specific schema revision.

Parameters
Name	Description
request	DeleteSchemaRevisionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Schema	The response received from the server.

DeleteSchemaRevision(DeleteSchemaRevisionRequest, Metadata, DateTime?, CancellationToken)

public virtual Schema DeleteSchemaRevision(DeleteSchemaRevisionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a specific schema revision.

Parameters
Name	Description
request	DeleteSchemaRevisionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Schema	The response received from the server.

DeleteSchemaRevisionAsync(DeleteSchemaRevisionRequest, CallOptions)

public virtual AsyncUnaryCall<Schema> DeleteSchemaRevisionAsync(DeleteSchemaRevisionRequest request, CallOptions options)

Deletes a specific schema revision.

Parameters
Name	Description
request	DeleteSchemaRevisionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

DeleteSchemaRevisionAsync(DeleteSchemaRevisionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schema> DeleteSchemaRevisionAsync(DeleteSchemaRevisionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a specific schema revision.

Parameters
Name	Description
request	DeleteSchemaRevisionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

GetSchema(GetSchemaRequest, CallOptions)

public virtual Schema GetSchema(GetSchemaRequest request, CallOptions options)

Gets a schema.

Parameters
Name	Description
request	GetSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Schema	The response received from the server.

GetSchema(GetSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual Schema GetSchema(GetSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a schema.

Parameters
Name	Description
request	GetSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Schema	The response received from the server.

GetSchemaAsync(GetSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<Schema> GetSchemaAsync(GetSchemaRequest request, CallOptions options)

Gets a schema.

Parameters
Name	Description
request	GetSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

GetSchemaAsync(GetSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schema> GetSchemaAsync(GetSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a schema.

Parameters
Name	Description
request	GetSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

ListSchemaRevisions(ListSchemaRevisionsRequest, CallOptions)

public virtual ListSchemaRevisionsResponse ListSchemaRevisions(ListSchemaRevisionsRequest request, CallOptions options)

Lists all schema revisions for the named schema.

Parameters
Name	Description
request	ListSchemaRevisionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListSchemaRevisionsResponse	The response received from the server.

ListSchemaRevisions(ListSchemaRevisionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSchemaRevisionsResponse ListSchemaRevisions(ListSchemaRevisionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all schema revisions for the named schema.

Parameters
Name	Description
request	ListSchemaRevisionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListSchemaRevisionsResponse	The response received from the server.

ListSchemaRevisionsAsync(ListSchemaRevisionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListSchemaRevisionsResponse> ListSchemaRevisionsAsync(ListSchemaRevisionsRequest request, CallOptions options)

Lists all schema revisions for the named schema.

Parameters
Name	Description
request	ListSchemaRevisionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListSchemaRevisionsResponse	The call object.

ListSchemaRevisionsAsync(ListSchemaRevisionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSchemaRevisionsResponse> ListSchemaRevisionsAsync(ListSchemaRevisionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all schema revisions for the named schema.

Parameters
Name	Description
request	ListSchemaRevisionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListSchemaRevisionsResponse	The call object.

ListSchemas(ListSchemasRequest, CallOptions)

public virtual ListSchemasResponse ListSchemas(ListSchemasRequest request, CallOptions options)

Lists schemas in a project.

Parameters
Name	Description
request	ListSchemasRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListSchemasResponse	The response received from the server.

ListSchemas(ListSchemasRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSchemasResponse ListSchemas(ListSchemasRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists schemas in a project.

Parameters
Name	Description
request	ListSchemasRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListSchemasResponse	The response received from the server.

ListSchemasAsync(ListSchemasRequest, CallOptions)

public virtual AsyncUnaryCall<ListSchemasResponse> ListSchemasAsync(ListSchemasRequest request, CallOptions options)

Lists schemas in a project.

Parameters
Name	Description
request	ListSchemasRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListSchemasResponse	The call object.

ListSchemasAsync(ListSchemasRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSchemasResponse> ListSchemasAsync(ListSchemasRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists schemas in a project.

Parameters
Name	Description
request	ListSchemasRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListSchemasResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override SchemaService.SchemaServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
SchemaServiceSchemaServiceClient

Overrides

ClientBase<SchemaService.SchemaServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

RollbackSchema(RollbackSchemaRequest, CallOptions)

public virtual Schema RollbackSchema(RollbackSchemaRequest request, CallOptions options)

Creates a new schema revision that is a copy of the provided revision_id.

Parameters
Name	Description
request	RollbackSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Schema	The response received from the server.

RollbackSchema(RollbackSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual Schema RollbackSchema(RollbackSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new schema revision that is a copy of the provided revision_id.

Parameters
Name	Description
request	RollbackSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Schema	The response received from the server.

RollbackSchemaAsync(RollbackSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<Schema> RollbackSchemaAsync(RollbackSchemaRequest request, CallOptions options)

Creates a new schema revision that is a copy of the provided revision_id.

Parameters
Name	Description
request	RollbackSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

RollbackSchemaAsync(RollbackSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schema> RollbackSchemaAsync(RollbackSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new schema revision that is a copy of the provided revision_id.

Parameters
Name	Description
request	RollbackSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSchema	The call object.

ValidateMessage(ValidateMessageRequest, CallOptions)

public virtual ValidateMessageResponse ValidateMessage(ValidateMessageRequest request, CallOptions options)

Validates a message against a schema.

Parameters
Name	Description
request	ValidateMessageRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ValidateMessageResponse	The response received from the server.

ValidateMessage(ValidateMessageRequest, Metadata, DateTime?, CancellationToken)

public virtual ValidateMessageResponse ValidateMessage(ValidateMessageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Validates a message against a schema.

Parameters
Name	Description
request	ValidateMessageRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ValidateMessageResponse	The response received from the server.

ValidateMessageAsync(ValidateMessageRequest, CallOptions)

public virtual AsyncUnaryCall<ValidateMessageResponse> ValidateMessageAsync(ValidateMessageRequest request, CallOptions options)

Validates a message against a schema.

Parameters
Name	Description
request	ValidateMessageRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallValidateMessageResponse	The call object.

ValidateMessageAsync(ValidateMessageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ValidateMessageResponse> ValidateMessageAsync(ValidateMessageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Validates a message against a schema.

Parameters
Name	Description
request	ValidateMessageRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallValidateMessageResponse	The call object.

ValidateSchema(ValidateSchemaRequest, CallOptions)

public virtual ValidateSchemaResponse ValidateSchema(ValidateSchemaRequest request, CallOptions options)

Validates a schema.

Parameters
Name	Description
request	ValidateSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ValidateSchemaResponse	The response received from the server.

ValidateSchema(ValidateSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual ValidateSchemaResponse ValidateSchema(ValidateSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Validates a schema.

Parameters
Name	Description
request	ValidateSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ValidateSchemaResponse	The response received from the server.

ValidateSchemaAsync(ValidateSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<ValidateSchemaResponse> ValidateSchemaAsync(ValidateSchemaRequest request, CallOptions options)

Validates a schema.

Parameters
Name	Description
request	ValidateSchemaRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallValidateSchemaResponse	The call object.

ValidateSchemaAsync(ValidateSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ValidateSchemaResponse> ValidateSchemaAsync(ValidateSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Validates a schema.

Parameters
Name	Description
request	ValidateSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallValidateSchemaResponse	The call object.