Module io.helidon.microprofile.grpc.client

Package io.helidon.microprofile.grpc.client

Interface ClientServiceDescriptor.Rules

All Known Implementing Classes:

ClientServiceDescriptor.Builder

Enclosing class:

ClientServiceDescriptor

public static interface ClientServiceDescriptor.Rules

Fluent configuration interface for the ClientServiceDescriptor.

Method Summary

Modifier and Type	Method	Description
ClientServiceDescriptor.Rules	bidirectional(String name)	Register bi-directional streaming method for the service.
ClientServiceDescriptor.Rules	bidirectional(String name, Consumer<ClientMethodDescriptor.Rules> configurer)	Register bi-directional streaming method for the service.
ClientServiceDescriptor.Rules	callCredentials(io.grpc.CallCredentials callCredentials)	Register the CallCredentials to be used for this service.
ClientServiceDescriptor.Rules	callCredentials(String name, io.grpc.CallCredentials callCredentials)	Register the CallCredentials to be used for the specified method in this service.
ClientServiceDescriptor.Rules	clientStreaming(String name)	Register client streaming method for the service.
ClientServiceDescriptor.Rules	clientStreaming(String name, Consumer<ClientMethodDescriptor.Rules> configurer)	Register client streaming method for the service.
ClientServiceDescriptor.Rules	intercept(int priority, io.grpc.ClientInterceptor... interceptors)	Add one or more ClientInterceptor instances that will intercept calls to this service.
ClientServiceDescriptor.Rules	intercept(io.grpc.ClientInterceptor... interceptors)	Register one or more interceptors for the service.
ClientServiceDescriptor.Rules	intercept(String methodName, int priority, io.grpc.ClientInterceptor... interceptors)	Register one or more interceptors for a named method of the service.
ClientServiceDescriptor.Rules	intercept(String methodName, io.grpc.ClientInterceptor... interceptors)	Register one or more interceptors for a named method of the service.
ClientServiceDescriptor.Rules	marshallerSupplier(MarshallerSupplier marshallerSupplier)	Register the MarshallerSupplier for the service.
String	name()	Obtain the name fo the service this configuration configures.
ClientServiceDescriptor.Rules	name(String name)	Set the name for the service.
ClientServiceDescriptor.Rules	proto(com.google.protobuf.Descriptors.FileDescriptor proto)	Register the proto file for the service.
ClientServiceDescriptor.Rules	serverStreaming(String name)	Register server streaming method for the service.
ClientServiceDescriptor.Rules	serverStreaming(String name, Consumer<ClientMethodDescriptor.Rules> configurer)	Register server streaming method for the service.
ClientServiceDescriptor.Rules	unary(String name)	Register unary method for the service.
ClientServiceDescriptor.Rules	unary(String name, Consumer<ClientMethodDescriptor.Rules> configurer)	Register unary method for the service.

Method Details

name

String name()

Obtain the name fo the service this configuration configures.

Returns:

the name fo the service this configuration configures

name

ClientServiceDescriptor.Rules name(String name)

Set the name for the service.

Parameters:

name - the name of service

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

Throws:

NullPointerException - if the getName is null

IllegalArgumentException - if the getName is a blank String

proto

ClientServiceDescriptor.Rules proto(com.google.protobuf.Descriptors.FileDescriptor proto)

Register the proto file for the service.

Parameters:

proto - the service proto

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

marshallerSupplier

ClientServiceDescriptor.Rules marshallerSupplier(MarshallerSupplier marshallerSupplier)

Register the MarshallerSupplier for the service.

Parameters:

marshallerSupplier - the MarshallerSupplier for the service

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

intercept

ClientServiceDescriptor.Rules intercept(io.grpc.ClientInterceptor... interceptors)

Register one or more interceptors for the service.

Parameters:

interceptors - the interceptor(s) to register

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

intercept

ClientServiceDescriptor.Rules intercept(int priority,
 io.grpc.ClientInterceptor... interceptors)

Add one or more ClientInterceptor instances that will intercept calls to this service.

The added interceptors will be applied using the specified priority.

Parameters:

priority - the priority to assign to the interceptors

interceptors - one or more ClientInterceptors to add

Returns:

this builder to allow fluent method chaining

intercept

ClientServiceDescriptor.Rules intercept(String methodName,
 io.grpc.ClientInterceptor... interceptors)

Register one or more interceptors for a named method of the service.

Parameters:

methodName - the name of the method to intercept

interceptors - the interceptor(s) to register

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

Throws:

IllegalArgumentException - if no method exists for the specified getName

intercept

ClientServiceDescriptor.Rules intercept(String methodName,
 int priority,
 io.grpc.ClientInterceptor... interceptors)

Register one or more interceptors for a named method of the service.

The added interceptors will be applied using the specified priority.

Parameters:

methodName - the name of the method to intercept

priority - the priority to assign to the interceptors

interceptors - the interceptor(s) to register

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

Throws:

IllegalArgumentException - if no method exists for the specified name

unary

ClientServiceDescriptor.Rules unary(String name)

Register unary method for the service.

Parameters:

name - The getName of the method

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

unary

ClientServiceDescriptor.Rules unary(String name,
 Consumer<ClientMethodDescriptor.Rules> configurer)

Register unary method for the service.

Parameters:

name - the name of the method

configurer - the method configurer

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

serverStreaming

ClientServiceDescriptor.Rules serverStreaming(String name)

Register server streaming method for the service.

Parameters:

name - The name of the method

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

serverStreaming

ClientServiceDescriptor.Rules serverStreaming(String name,
 Consumer<ClientMethodDescriptor.Rules> configurer)

Register server streaming method for the service.

Parameters:

name - the name of the method

configurer - the method configurer

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

clientStreaming

ClientServiceDescriptor.Rules clientStreaming(String name)

Register client streaming method for the service.

Parameters:

name - The name of the method

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

clientStreaming

ClientServiceDescriptor.Rules clientStreaming(String name,
 Consumer<ClientMethodDescriptor.Rules> configurer)

Register client streaming method for the service.

Parameters:

name - the name of the method

configurer - the method configurer

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

bidirectional

ClientServiceDescriptor.Rules bidirectional(String name)

Register bi-directional streaming method for the service.

Parameters:

name - The name of the method

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

bidirectional

ClientServiceDescriptor.Rules bidirectional(String name,
 Consumer<ClientMethodDescriptor.Rules> configurer)

Register bi-directional streaming method for the service.

Parameters:

name - the name of the method

configurer - the method configurer

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

callCredentials

ClientServiceDescriptor.Rules callCredentials(io.grpc.CallCredentials callCredentials)

Register the CallCredentials to be used for this service.

Parameters:

callCredentials - the CallCredentials to set.

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining

callCredentials

ClientServiceDescriptor.Rules callCredentials(String name,
 io.grpc.CallCredentials callCredentials)

Register the CallCredentials to be used for the specified method in this service. This overrides any CallCredentials set on this ClientServiceDescriptor

Parameters:

name - the method name

callCredentials - the CallCredentials to set.

Returns:

this ClientServiceDescriptor.Rules instance for fluent call chaining