Cloud Pub/Sub v1 API - Class SchemaServiceClientImpl (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 sealed class SchemaServiceClientImpl : SchemaServiceClient

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

SchemaService client wrapper implementation, for convenient use.

Inheritance

object > SchemaServiceClient > SchemaServiceClientImpl

Inherited Members

SchemaServiceClient.DefaultEndpoint

SchemaServiceClient.DefaultScopes

SchemaServiceClient.ServiceMetadata

SchemaServiceClient.CreateAsync(CancellationToken)

SchemaServiceClient.Create()

SchemaServiceClient.ShutdownDefaultChannelsAsync()

SchemaServiceClient.CreateSchemaAsync(CreateSchemaRequest, CancellationToken)

SchemaServiceClient.CreateSchema(string, Schema, string, CallSettings)

SchemaServiceClient.CreateSchemaAsync(string, Schema, string, CallSettings)

SchemaServiceClient.CreateSchemaAsync(string, Schema, string, CancellationToken)

SchemaServiceClient.CreateSchema(ProjectName, Schema, string, CallSettings)

SchemaServiceClient.CreateSchemaAsync(ProjectName, Schema, string, CallSettings)

SchemaServiceClient.CreateSchemaAsync(ProjectName, Schema, string, CancellationToken)

SchemaServiceClient.GetSchemaAsync(GetSchemaRequest, CancellationToken)

SchemaServiceClient.GetSchema(string, CallSettings)

SchemaServiceClient.GetSchemaAsync(string, CallSettings)

SchemaServiceClient.GetSchemaAsync(string, CancellationToken)

SchemaServiceClient.GetSchema(SchemaName, CallSettings)

SchemaServiceClient.GetSchemaAsync(SchemaName, CallSettings)

SchemaServiceClient.GetSchemaAsync(SchemaName, CancellationToken)

SchemaServiceClient.ListSchemas(string, string, int?, CallSettings)

SchemaServiceClient.ListSchemasAsync(string, string, int?, CallSettings)

SchemaServiceClient.ListSchemas(ProjectName, string, int?, CallSettings)

SchemaServiceClient.ListSchemasAsync(ProjectName, string, int?, CallSettings)

SchemaServiceClient.ListSchemaRevisions(string, string, int?, CallSettings)

SchemaServiceClient.ListSchemaRevisionsAsync(string, string, int?, CallSettings)

SchemaServiceClient.ListSchemaRevisions(SchemaName, string, int?, CallSettings)

SchemaServiceClient.ListSchemaRevisionsAsync(SchemaName, string, int?, CallSettings)

SchemaServiceClient.CommitSchemaAsync(CommitSchemaRequest, CancellationToken)

SchemaServiceClient.CommitSchema(string, Schema, CallSettings)

SchemaServiceClient.CommitSchemaAsync(string, Schema, CallSettings)

SchemaServiceClient.CommitSchemaAsync(string, Schema, CancellationToken)

SchemaServiceClient.CommitSchema(SchemaName, Schema, CallSettings)

SchemaServiceClient.CommitSchemaAsync(SchemaName, Schema, CallSettings)

SchemaServiceClient.CommitSchemaAsync(SchemaName, Schema, CancellationToken)

SchemaServiceClient.RollbackSchemaAsync(RollbackSchemaRequest, CancellationToken)

SchemaServiceClient.RollbackSchema(string, string, CallSettings)

SchemaServiceClient.RollbackSchemaAsync(string, string, CallSettings)

SchemaServiceClient.RollbackSchemaAsync(string, string, CancellationToken)

SchemaServiceClient.RollbackSchema(SchemaName, string, CallSettings)

SchemaServiceClient.RollbackSchemaAsync(SchemaName, string, CallSettings)

SchemaServiceClient.RollbackSchemaAsync(SchemaName, string, CancellationToken)

SchemaServiceClient.DeleteSchemaRevisionAsync(DeleteSchemaRevisionRequest, CancellationToken)

SchemaServiceClient.DeleteSchemaRevision(string, string, CallSettings)

SchemaServiceClient.DeleteSchemaRevisionAsync(string, string, CallSettings)

SchemaServiceClient.DeleteSchemaRevisionAsync(string, string, CancellationToken)

SchemaServiceClient.DeleteSchemaRevision(SchemaName, string, CallSettings)

SchemaServiceClient.DeleteSchemaRevisionAsync(SchemaName, string, CallSettings)

SchemaServiceClient.DeleteSchemaRevisionAsync(SchemaName, string, CancellationToken)

SchemaServiceClient.DeleteSchemaAsync(DeleteSchemaRequest, CancellationToken)

SchemaServiceClient.DeleteSchema(string, CallSettings)

SchemaServiceClient.DeleteSchemaAsync(string, CallSettings)

SchemaServiceClient.DeleteSchemaAsync(string, CancellationToken)

SchemaServiceClient.DeleteSchema(SchemaName, CallSettings)

SchemaServiceClient.DeleteSchemaAsync(SchemaName, CallSettings)

SchemaServiceClient.DeleteSchemaAsync(SchemaName, CancellationToken)

SchemaServiceClient.ValidateSchemaAsync(ValidateSchemaRequest, CancellationToken)

SchemaServiceClient.ValidateSchema(string, Schema, CallSettings)

SchemaServiceClient.ValidateSchemaAsync(string, Schema, CallSettings)

SchemaServiceClient.ValidateSchemaAsync(string, Schema, CancellationToken)

SchemaServiceClient.ValidateSchema(ProjectName, Schema, CallSettings)

SchemaServiceClient.ValidateSchemaAsync(ProjectName, Schema, CallSettings)

SchemaServiceClient.ValidateSchemaAsync(ProjectName, Schema, CancellationToken)

SchemaServiceClient.ValidateMessageAsync(ValidateMessageRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Remarks

Service for doing schema-related operations.

Constructors

SchemaServiceClientImpl(SchemaServiceClient, SchemaServiceSettings, ILogger)

public SchemaServiceClientImpl(SchemaService.SchemaServiceClient grpcClient, SchemaServiceSettings settings, ILogger logger)

Constructs a client wrapper for the SchemaService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	SchemaServiceSchemaServiceClient The underlying gRPC client.
settings	SchemaServiceSettings The base SchemaServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override SchemaService.SchemaServiceClient GrpcClient { get; }

The underlying gRPC SchemaService client

Property Value
Type	Description
SchemaServiceSchemaServiceClient

Overrides

SchemaServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

SchemaServiceClient.IAMPolicyClient

Methods

CommitSchema(CommitSchemaRequest, CallSettings)

public override Schema CommitSchema(CommitSchemaRequest request, CallSettings callSettings = null)

Commits a new schema revision to an existing schema.

Parameters
Name	Description
request	CommitSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Schema	The RPC response.

Overrides

SchemaServiceClient.CommitSchema(CommitSchemaRequest, CallSettings)

CommitSchemaAsync(CommitSchemaRequest, CallSettings)

public override Task<Schema> CommitSchemaAsync(CommitSchemaRequest request, CallSettings callSettings = null)

Commits a new schema revision to an existing schema.

Parameters
Name	Description
request	CommitSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Overrides

SchemaServiceClient.CommitSchemaAsync(CommitSchemaRequest, CallSettings)

CreateSchema(CreateSchemaRequest, CallSettings)

public override Schema CreateSchema(CreateSchemaRequest request, CallSettings callSettings = null)

Creates a schema.

Parameters
Name	Description
request	CreateSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Schema	The RPC response.

Overrides

SchemaServiceClient.CreateSchema(CreateSchemaRequest, CallSettings)

CreateSchemaAsync(CreateSchemaRequest, CallSettings)

public override Task<Schema> CreateSchemaAsync(CreateSchemaRequest request, CallSettings callSettings = null)

Creates a schema.

Parameters
Name	Description
request	CreateSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Overrides

SchemaServiceClient.CreateSchemaAsync(CreateSchemaRequest, CallSettings)

DeleteSchema(DeleteSchemaRequest, CallSettings)

public override void DeleteSchema(DeleteSchemaRequest request, CallSettings callSettings = null)

Deletes a schema.

Parameters
Name	Description
request	DeleteSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

SchemaServiceClient.DeleteSchema(DeleteSchemaRequest, CallSettings)

DeleteSchemaAsync(DeleteSchemaRequest, CallSettings)

public override Task DeleteSchemaAsync(DeleteSchemaRequest request, CallSettings callSettings = null)

Deletes a schema.

Parameters
Name	Description
request	DeleteSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

SchemaServiceClient.DeleteSchemaAsync(DeleteSchemaRequest, CallSettings)

DeleteSchemaRevision(DeleteSchemaRevisionRequest, CallSettings)

public override Schema DeleteSchemaRevision(DeleteSchemaRevisionRequest request, CallSettings callSettings = null)

Deletes a specific schema revision.

Parameters
Name	Description
request	DeleteSchemaRevisionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Schema	The RPC response.

Overrides

SchemaServiceClient.DeleteSchemaRevision(DeleteSchemaRevisionRequest, CallSettings)

DeleteSchemaRevisionAsync(DeleteSchemaRevisionRequest, CallSettings)

public override Task<Schema> DeleteSchemaRevisionAsync(DeleteSchemaRevisionRequest request, CallSettings callSettings = null)

Deletes a specific schema revision.

Parameters
Name	Description
request	DeleteSchemaRevisionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Overrides

SchemaServiceClient.DeleteSchemaRevisionAsync(DeleteSchemaRevisionRequest, CallSettings)

GetSchema(GetSchemaRequest, CallSettings)

public override Schema GetSchema(GetSchemaRequest request, CallSettings callSettings = null)

Gets a schema.

Parameters
Name	Description
request	GetSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Schema	The RPC response.

Overrides

SchemaServiceClient.GetSchema(GetSchemaRequest, CallSettings)

GetSchemaAsync(GetSchemaRequest, CallSettings)

public override Task<Schema> GetSchemaAsync(GetSchemaRequest request, CallSettings callSettings = null)

Gets a schema.

Parameters
Name	Description
request	GetSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Overrides

SchemaServiceClient.GetSchemaAsync(GetSchemaRequest, CallSettings)

ListSchemaRevisions(ListSchemaRevisionsRequest, CallSettings)

public override PagedEnumerable<ListSchemaRevisionsResponse, Schema> ListSchemaRevisions(ListSchemaRevisionsRequest request, CallSettings callSettings = null)

Lists all schema revisions for the named schema.

Parameters
Name	Description
request	ListSchemaRevisionsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListSchemaRevisionsResponseSchema	A pageable sequence of Schema resources.

Overrides

SchemaServiceClient.ListSchemaRevisions(ListSchemaRevisionsRequest, CallSettings)

ListSchemaRevisionsAsync(ListSchemaRevisionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSchemaRevisionsResponse, Schema> ListSchemaRevisionsAsync(ListSchemaRevisionsRequest request, CallSettings callSettings = null)

Lists all schema revisions for the named schema.

Parameters
Name	Description
request	ListSchemaRevisionsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListSchemaRevisionsResponseSchema	A pageable asynchronous sequence of Schema resources.

Overrides

SchemaServiceClient.ListSchemaRevisionsAsync(ListSchemaRevisionsRequest, CallSettings)

ListSchemas(ListSchemasRequest, CallSettings)

public override PagedEnumerable<ListSchemasResponse, Schema> ListSchemas(ListSchemasRequest request, CallSettings callSettings = null)

Lists schemas in a project.

Parameters
Name	Description
request	ListSchemasRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListSchemasResponseSchema	A pageable sequence of Schema resources.

Overrides

SchemaServiceClient.ListSchemas(ListSchemasRequest, CallSettings)

ListSchemasAsync(ListSchemasRequest, CallSettings)

public override PagedAsyncEnumerable<ListSchemasResponse, Schema> ListSchemasAsync(ListSchemasRequest request, CallSettings callSettings = null)

Lists schemas in a project.

Parameters
Name	Description
request	ListSchemasRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListSchemasResponseSchema	A pageable asynchronous sequence of Schema resources.

Overrides

SchemaServiceClient.ListSchemasAsync(ListSchemasRequest, CallSettings)

RollbackSchema(RollbackSchemaRequest, CallSettings)

public override Schema RollbackSchema(RollbackSchemaRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	RollbackSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Schema	The RPC response.

Overrides

SchemaServiceClient.RollbackSchema(RollbackSchemaRequest, CallSettings)

RollbackSchemaAsync(RollbackSchemaRequest, CallSettings)

public override Task<Schema> RollbackSchemaAsync(RollbackSchemaRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	RollbackSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSchema	A Task containing the RPC response.

Overrides

SchemaServiceClient.RollbackSchemaAsync(RollbackSchemaRequest, CallSettings)

ValidateMessage(ValidateMessageRequest, CallSettings)

public override ValidateMessageResponse ValidateMessage(ValidateMessageRequest request, CallSettings callSettings = null)

Validates a message against a schema.

Parameters
Name	Description
request	ValidateMessageRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ValidateMessageResponse	The RPC response.

Overrides

SchemaServiceClient.ValidateMessage(ValidateMessageRequest, CallSettings)

ValidateMessageAsync(ValidateMessageRequest, CallSettings)

public override Task<ValidateMessageResponse> ValidateMessageAsync(ValidateMessageRequest request, CallSettings callSettings = null)

Validates a message against a schema.

Parameters
Name	Description
request	ValidateMessageRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskValidateMessageResponse	A Task containing the RPC response.

Overrides

SchemaServiceClient.ValidateMessageAsync(ValidateMessageRequest, CallSettings)

ValidateSchema(ValidateSchemaRequest, CallSettings)

public override ValidateSchemaResponse ValidateSchema(ValidateSchemaRequest request, CallSettings callSettings = null)

Validates a schema.

Parameters
Name	Description
request	ValidateSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ValidateSchemaResponse	The RPC response.

Overrides

SchemaServiceClient.ValidateSchema(ValidateSchemaRequest, CallSettings)

ValidateSchemaAsync(ValidateSchemaRequest, CallSettings)

public override Task<ValidateSchemaResponse> ValidateSchemaAsync(ValidateSchemaRequest request, CallSettings callSettings = null)

Validates a schema.

Parameters
Name	Description
request	ValidateSchemaRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskValidateSchemaResponse	A Task containing the RPC response.

Overrides

SchemaServiceClient.ValidateSchemaAsync(ValidateSchemaRequest, CallSettings)