Discovery Engine v1 API - Class SchemaService.SchemaServiceClient (1.2.0)

Version 1.2.0

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

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

Reference documentation and code samples for the Discovery Engine 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.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.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

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

CreateSchema(CreateSchemaRequest, CallOptions)

public virtual Operation CreateSchema(CreateSchemaRequest request, CallOptions options)

Creates a [Schema][google.cloud.discoveryengine.v1.Schema].

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

Returns
Type	Description
Operation	The response received from the server.

CreateSchema(CreateSchemaRequest, Metadata, DateTime?, CancellationToken)

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

Creates a [Schema][google.cloud.discoveryengine.v1.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	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
Operation	The response received from the server.

CreateSchemaAsync(CreateSchemaRequest, CallOptions)

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

Creates a [Schema][google.cloud.discoveryengine.v1.Schema].

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateSchemaAsync(CreateSchemaRequest, Metadata, DateTime?, CancellationToken)

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

Creates a [Schema][google.cloud.discoveryengine.v1.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	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
AsyncUnaryCallOperation	The call object.

DeleteSchema(DeleteSchemaRequest, CallOptions)

public virtual Operation DeleteSchema(DeleteSchemaRequest request, CallOptions options)

Deletes a [Schema][google.cloud.discoveryengine.v1.Schema].

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

Returns
Type	Description
Operation	The response received from the server.

DeleteSchema(DeleteSchemaRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a [Schema][google.cloud.discoveryengine.v1.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	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
Operation	The response received from the server.

DeleteSchemaAsync(DeleteSchemaRequest, CallOptions)

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

Deletes a [Schema][google.cloud.discoveryengine.v1.Schema].

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteSchemaAsync(DeleteSchemaRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a [Schema][google.cloud.discoveryengine.v1.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	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
AsyncUnaryCallOperation	The call object.

GetSchema(GetSchemaRequest, CallOptions)

public virtual Schema GetSchema(GetSchemaRequest request, CallOptions options)

Gets a [Schema][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.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	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][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.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	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.

ListSchemas(ListSchemasRequest, CallOptions)

public virtual ListSchemasResponse ListSchemas(ListSchemasRequest request, CallOptions options)

Gets a list of [Schema][google.cloud.discoveryengine.v1.Schema]s.

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)

Gets a list of [Schema][google.cloud.discoveryengine.v1.Schema]s.

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	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)

Gets a list of [Schema][google.cloud.discoveryengine.v1.Schema]s.

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)

Gets a list of [Schema][google.cloud.discoveryengine.v1.Schema]s.

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	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)

UpdateSchema(UpdateSchemaRequest, CallOptions)

public virtual Operation UpdateSchema(UpdateSchemaRequest request, CallOptions options)

Updates a [Schema][google.cloud.discoveryengine.v1.Schema].

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

Returns
Type	Description
Operation	The response received from the server.

UpdateSchema(UpdateSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateSchema(UpdateSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a [Schema][google.cloud.discoveryengine.v1.Schema].

Parameters
Name	Description
request	UpdateSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Operation	The response received from the server.

UpdateSchemaAsync(UpdateSchemaRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateSchemaAsync(UpdateSchemaRequest request, CallOptions options)

Updates a [Schema][google.cloud.discoveryengine.v1.Schema].

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateSchemaAsync(UpdateSchemaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateSchemaAsync(UpdateSchemaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a [Schema][google.cloud.discoveryengine.v1.Schema].

Parameters
Name	Description
request	UpdateSchemaRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.