grpc の API リファレンス

grpc (grpc/grpc) の公開 API 173 件 —— クラス 110、関数 4、メソッド 59。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: grpc/grpc

種別	件数
クラス	110
関数	4
メソッド	59

API 一覧

classpy_xds_protos.envoy.service.load_stats.v2.lrs_pb2_grpc.LoadReportingService

[#protodoc-title: Load reporting service]

classpy_xds_protos.envoy.service.load_stats.v2.lrs_pb2_grpc.LoadReportingServiceServicer

[#protodoc-title: Load reporting service]

classpy_xds_protos.envoy.service.load_stats.v2.lrs_pb2_grpc.LoadReportingServiceStub

[#protodoc-title: Load reporting service]

classpy_xds_protos.envoy.service.ratelimit.v2.rls_pb2_grpc.RateLimitService

[#protodoc-title: Rate Limit Service (RLS)]

classpy_xds_protos.envoy.service.ratelimit.v2.rls_pb2_grpc.RateLimitServiceServicer

[#protodoc-title: Rate Limit Service (RLS)]

classpy_xds_protos.envoy.service.ratelimit.v2.rls_pb2_grpc.RateLimitServiceStub

[#protodoc-title: Rate Limit Service (RLS)]

classpy_xds_protos.envoy.service.ratelimit.v3.rls_pb2_grpc.RateLimitService

[#protodoc-title: Rate limit service (RLS)]

classpy_xds_protos.envoy.service.ratelimit.v3.rls_pb2_grpc.RateLimitServiceServicer

[#protodoc-title: Rate limit service (RLS)]

classpy_xds_protos.envoy.service.ratelimit.v3.rls_pb2_grpc.RateLimitServiceStub

[#protodoc-title: Rate limit service (RLS)]

classpy_xds_protos.envoy.service.secret.v3.sds_pb2_grpc.SecretDiscoveryService

[#protodoc-title: Secret Discovery Service (SDS)]

classsrc.boringssl.gen_build_yaml.Grpc

Adapter for boring-SSL json sources files.

classsrc.python.grpcio.commands.BuildExt

Custom build_ext command to enable compiler-specific flags.

classsrc.python.grpcio.commands.BuildProjectMetadata

Command to generate project metadata in a module.

classsrc.python.grpcio.commands.BuildPy

Custom project build command.

classsrc.python.grpcio.commands.Clean

Command to clean build artifacts.

classsrc.python.grpcio.commands.CommandError

Simple exception class for GRPC custom commands.

classsrc.python.grpcio.commands.Gather

Command to gather project dependencies.

classsrc.python.grpcio.commands.SphinxDocumentation

Command to generate documentation via sphinx.

classsrc.python.grpcio.grpc.AuthMetadataContext

Provides information to call credentials metadata plugins.

classsrc.python.grpcio.grpc.AuthMetadataPlugin

A specification for custom authentication.

classsrc.python.grpcio.grpc.AuthMetadataPluginCallback

Callback object received by a metadata plugin.

classsrc.python.grpcio.grpc.Call

Invocation-side utility object for an RPC.

methodsrc.python.grpcio.grpc.Call.details()

Accesses the details sent by the server.

classsrc.python.grpcio.grpc.Channel

Affords RPC invocation via generic methods on client-side.

classsrc.python.grpcio.grpc.ChannelConnectivity

Mirrors grpc_connectivity_state in the gRPC Core.

classsrc.python.grpcio.grpc.ClientCallDetails

Describes an RPC to be invoked.

classsrc.python.grpcio.grpc.Compression

Indicates the compression method to be used for an RPC.

classsrc.python.grpcio.grpc.Future

A representation of a computation in another control flow.

methodsrc.python.grpcio.grpc.Future.cancel()

Attempts to cancel the computation.

classsrc.python.grpcio.grpc.FutureTimeoutError

Indicates that a method call on a Future timed out.

classsrc.python.grpcio.grpc.GenericRpcHandler

An implementation of arbitrarily many RPC methods.

classsrc.python.grpcio.grpc.HandlerCallDetails

Describes an RPC that has just arrived for service.

classsrc.python.grpcio.grpc.LocalConnectionType

Types of local connection for local credential creation.

classsrc.python.grpcio.grpc.RpcContext

Provides RPC-related information and action.

methodsrc.python.grpcio.grpc.RpcContext.cancel()

Cancels the RPC.

classsrc.python.grpcio.grpc.RpcMethodHandler

An implementation of a single RPC method.

classsrc.python.grpcio.grpc.Server

Services RPCs.

methodsrc.python.grpcio.grpc.Server.start()

Starts this Server.

methodsrc.python.grpcio.grpc.Server.stop(grace)

Stops this Server.

classsrc.python.grpcio.grpc.ServerInterceptor

Affords intercepting incoming RPCs on the service-side.

classsrc.python.grpcio.grpc.ServiceRpcHandler

An implementation of RPC methods belonging to a service.

methodsrc.python.grpcio.grpc.ServiceRpcHandler.service_name()

Returns this service's name.

classsrc.python.grpcio.grpc.ServicerContext

A context object passed to method implementations.

methodsrc.python.grpcio.grpc.ServicerContext.auth_context()

Gets the auth context for the call.

methodsrc.python.grpcio.grpc.ServicerContext.peer_identities()

Gets one or more peer identity(s).

classsrc.python.grpcio.grpc.Status

Describes the status of an RPC.

classsrc.python.grpcio.grpc.StatusCode

Mirrors grpc_status_code in the gRPC Core.

classsrc.python.grpcio.grpc.StreamStreamClientInterceptor

Affords intercepting stream-stream invocations.

classsrc.python.grpcio.grpc.StreamStreamMultiCallable

Affords invoking a stream-stream RPC on client-side.

classsrc.python.grpcio.grpc.StreamUnaryClientInterceptor

Affords intercepting stream-unary invocations.

classsrc.python.grpcio.grpc.StreamUnaryMultiCallable

Affords invoking a stream-unary RPC from client-side.

classsrc.python.grpcio.grpc.UnaryStreamClientInterceptor

Affords intercepting unary-stream invocations.

classsrc.python.grpcio.grpc.UnaryStreamMultiCallable

Affords invoking a unary-stream RPC from client-side.

classsrc.python.grpcio.grpc.UnaryUnaryClientInterceptor

Affords intercepting unary-unary invocations.

classsrc.python.grpcio.grpc.UnaryUnaryMultiCallable

Affords invoking a unary-unary RPC from client-side.

classsrc.python.grpcio.grpc._auth.AccessTokenAuthMetadataPlugin

Metadata wrapper for raw access token credentials.

classsrc.python.grpcio.grpc._channel.Channel

A cygrpc.Channel-backed implementation of grpc.Channel.

funcsrc.python.grpcio.grpc._common.validate_port_binding_result(address:str, port:int) -> int

Validates if the port binding succeed.

classsrc.python.grpcio.grpc._observability.ObservabilityPlugin

Abstract base class for observability plugin.

method

src.python.grpcio.grpc._observability.ObservabilityPlugin.create_client_call_tracer(method_name:bytes, target:bytes) -> ClientCallTracerCapsule

Creates a ClientCallTracerCapsule.

method

src.python.grpcio.grpc._observability.ObservabilityPlugin.create_server_call_tracer_factory(*xds:bool=False) -> Optional[ServerCallTracerFactoryCapsule]

Creates a ServerCallTracerFactoryCapsule.

method

src.python.grpcio.grpc._observability.ObservabilityPlugin.record_rpc_latency(method:str, target:str, rpc_latency:float, status_code:Any) -> None

Record the latency of the RPC.

methodsrc.python.grpcio.grpc._observability.ObservabilityPlugin.save_registered_method(method_name:bytes) -> None

Saves the method name to registered_method list.

methodsrc.python.grpcio.grpc._observability.ObservabilityPlugin.set_stats(enable:bool) -> None

Enable or disable stats(metrics).

methodsrc.python.grpcio.grpc._observability.ObservabilityPlugin.set_tracing(enable:bool) -> None

Enable or disable tracing.

classsrc.python.grpcio.grpc._observability.ServerCallTracerFactory

An encapsulation of a ServerCallTracerFactory.

funcsrc.python.grpcio.grpc._observability.set_plugin(observability_plugin:Optional[ObservabilityPlugin]) -> None

Save ObservabilityPlugin to _observability module.

funcsrc.python.grpcio.grpc._utilities.first_version_is_lower(version1:str, version2:str) -> bool

Compares two versions in the format '1.60.1' or '1.60.1.dev0'.

classsrc.python.grpcio.grpc.aio._base_call.Call

The abstract base class of an RPC on the client-side.

methodsrc.python.grpcio.grpc.aio._base_call.Call.code() -> grpc.StatusCode

Accesses the status code sent by the server.

methodsrc.python.grpcio.grpc.aio._base_call.Call.details() -> str

Accesses the details sent by the server.

methodsrc.python.grpcio.grpc.aio._base_call.Call.initial_metadata() -> Metadata

Accesses the initial metadata sent by the server.

methodsrc.python.grpcio.grpc.aio._base_call.Call.trailing_metadata() -> Metadata

Accesses the trailing metadata sent by the server.

classsrc.python.grpcio.grpc.aio._base_call.RpcContext

Provides RPC-related information and action.

methodsrc.python.grpcio.grpc.aio._base_call.RpcContext.add_done_callback(callback:DoneCallbackType) -> None

Registers a callback to be called on RPC termination.

methodsrc.python.grpcio.grpc.aio._base_call.RpcContext.cancel() -> bool

Cancels the RPC.

methodsrc.python.grpcio.grpc.aio._base_call.RpcContext.cancelled() -> bool

Return True if the RPC is cancelled.

methodsrc.python.grpcio.grpc.aio._base_call.RpcContext.done() -> bool

Return True if the RPC is done.

methodsrc.python.grpcio.grpc.aio._base_call.StreamStreamCall.read() -> Union[EOFType, ResponseType]

Reads one message from the stream.

methodsrc.python.grpcio.grpc.aio._base_call.StreamStreamCall.write(request:RequestType) -> None

Writes one message to the stream.

methodsrc.python.grpcio.grpc.aio._base_call.StreamUnaryCall.write(request:RequestType) -> None

Writes one message to the stream.

methodsrc.python.grpcio.grpc.aio._base_call.UnaryStreamCall.read() -> Union[EOFType, ResponseType]

Reads one message from the stream.

classsrc.python.grpcio.grpc.aio._base_channel.Channel

Enables asynchronous RPC invocation as a client.

methodsrc.python.grpcio.grpc.aio._base_channel.Channel.get_state(try_to_connect:bool=False) -> grpc.ChannelConnectivity

Checks the connectivity state of a channel.

method

src.python.grpcio.grpc.aio._base_channel.Channel.wait_for_state_change(last_observed_state:grpc.ChannelConnectivity) -> None

Waits for a change in connectivity state.

classsrc.python.grpcio.grpc.aio._base_channel.UnaryUnaryMultiCallable

Enables asynchronous invocation of a unary-call RPC.

classsrc.python.grpcio.grpc.aio._base_server.Server

Serves RPCs.

method

src.python.grpcio.grpc.aio._base_server.Server.add_generic_rpc_handlers(generic_rpc_handlers:Sequence[grpc.GenericRpcHandler]) -> None

Registers GenericRpcHandlers with this Server.

methodsrc.python.grpcio.grpc.aio._base_server.Server.add_insecure_port(address:str) -> int

Opens an insecure port for accepting RPCs.

method

src.python.grpcio.grpc.aio._base_server.Server.add_secure_port(address:str, server_credentials:grpc.ServerCredentials) -> int

Opens a secure port for accepting RPCs.

methodsrc.python.grpcio.grpc.aio._base_server.Server.start() -> None

Starts this Server.

methodsrc.python.grpcio.grpc.aio._base_server.Server.stop(grace:Optional[float]) -> None

Stops this Server.

methodsrc.python.grpcio.grpc.aio._base_server.Server.wait_for_termination(timeout:Optional[float]=None) -> bool

Continues current coroutine once the server stops.

classsrc.python.grpcio.grpc.aio._base_server.ServicerContext

A context object passed to method implementations.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.add_done_callback(callback:DoneCallbackType) -> None

Registers a callback to be called on RPC termination.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.auth_context() -> Mapping[str, Iterable[bytes]]

Gets the auth context for the call.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.cancelled() -> bool

Return True if the RPC is cancelled.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.done() -> bool

Return True if the RPC is done.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.invocation_metadata() -> Optional[MetadataType]

Accesses the metadata sent by the client.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.peer_identities() -> Optional[Iterable[bytes]]

Gets one or more peer identity(s).

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.peer_identity_key() -> Optional[str]

The auth property used to identify the peer.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.read() -> RequestType

Reads one message from the RPC.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.send_initial_metadata(initial_metadata:MetadataType) -> None

Sends the initial metadata value to the client.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.set_trailing_metadata(trailing_metadata:MetadataType) -> None

Sends the trailing metadata for the RPC.

methodsrc.python.grpcio.grpc.aio._base_server.ServicerContext.write(message:ResponseType) -> None

Writes one message to the RPC.

classsrc.python.grpcio.grpc.aio._call.Call

Base implementation of client RPC Call object.

classsrc.python.grpcio.grpc.aio._call.StreamStreamCall

Object for managing stream-stream RPC calls.

classsrc.python.grpcio.grpc.aio._call.StreamUnaryCall

Object for managing stream-unary RPC calls.

classsrc.python.grpcio.grpc.aio._call.UnaryStreamCall

Object for managing unary-stream RPC calls.

classsrc.python.grpcio.grpc.aio._call.UnaryUnaryCall

Object for managing unary-unary RPC calls.

classsrc.python.grpcio.grpc.aio._interceptor.ClientCallDetails

Describes an RPC to be invoked.

classsrc.python.grpcio.grpc.aio._interceptor.ClientInterceptor

Base class used for all Aio Client Interceptor classes

classsrc.python.grpcio.grpc.aio._interceptor.InterceptedCall

Base implementation for all intercepted call arities.

classsrc.python.grpcio.grpc.aio._interceptor.ServerInterceptor

Affords intercepting incoming RPCs on the service-side.

classsrc.python.grpcio.grpc.aio._interceptor.StreamStreamClientInterceptor

Affords intercepting stream-stream invocations.

classsrc.python.grpcio.grpc.aio._interceptor.StreamUnaryClientInterceptor

Affords intercepting stream-unary invocations.

classsrc.python.grpcio.grpc.aio._interceptor.UnaryStreamClientInterceptor

Affords intercepting unary-stream invocations.

classsrc.python.grpcio.grpc.aio._interceptor.UnaryUnaryCallResponse

Final UnaryUnaryCall class finished with a response.

classsrc.python.grpcio.grpc.aio._interceptor.UnaryUnaryClientInterceptor

Affords intercepting unary-unary invocations.

methodsrc.python.grpcio.grpc.aio._metadata.Metadata.delete_all(key:MetadataKey) -> None

Delete all mappings for <key>.

classsrc.python.grpcio.grpc.aio._server.Server

Serves RPCs.

method

src.python.grpcio.grpc.aio._server.Server.add_generic_rpc_handlers(generic_rpc_handlers:Sequence[grpc.GenericRpcHandler]) -> None

Registers GenericRpcHandlers with this Server.

methodsrc.python.grpcio.grpc.aio._server.Server.add_insecure_port(address:str) -> int

Opens an insecure port for accepting RPCs.

methodsrc.python.grpcio.grpc.aio._server.Server.add_secure_port(address:str, server_credentials:grpc.ServerCredentials) -> int

Opens a secure port for accepting RPCs.

methodsrc.python.grpcio.grpc.aio._server.Server.start() -> None

Starts this Server.

methodsrc.python.grpcio.grpc.aio._server.Server.stop(grace:Optional[float]) -> None

Stops this Server.

methodsrc.python.grpcio.grpc.aio._server.Server.wait_for_termination(timeout:Optional[float]=None) -> bool

Block current coroutine until the server stops.

classsrc.python.grpcio.grpc.beta.interfaces.Server

Services RPCs.

methodsrc.python.grpcio.grpc.beta.interfaces.Server.stop(grace)

Stops this Server's service of RPCs.

classsrc.python.grpcio.grpc.experimental.ChannelOptions

Indicates a channel option unique to gRPC Python.

classsrc.python.grpcio.grpc.experimental.ExperimentalApiWarning

A warning that an API is experimental.

classsrc.python.grpcio.grpc.framework.common.cardinality.Cardinality

Describes the streaming semantics of an RPC method.

classsrc.python.grpcio.grpc.framework.foundation.abandonment.Abandoned

Indicates that some computation is being abandoned.

classsrc.python.grpcio.grpc.framework.foundation.callable_util.Outcome

A sum type describing the outcome of some call.

classsrc.python.grpcio.grpc.framework.foundation.future.TimeoutError

Indicates that a particular call timed out.

methodsrc.python.grpcio.grpc.framework.foundation.stream.Consumer.consume(value)

Accepts a value.

classsrc.python.grpcio.grpc.framework.interfaces.base.base.OperationContext

Provides operation-related information and action.

classsrc.python.grpcio.grpc.framework.interfaces.base.base.Outcome

The outcome of an operation.

classsrc.python.grpcio.grpc.framework.interfaces.base.base.Outcome.Kind

Ways in which an operation can terminate.

classsrc.python.grpcio.grpc.framework.interfaces.base.base.Servicer

Interface for service implementations.

methodsrc.python.grpcio.grpc.framework.interfaces.base.base.Servicer.service(group, method, context, output_operator)

Services an operation.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.Abortion

A value describing RPC abortion.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.Abortion.Kind

Types of RPC abortion.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.AbortionError

Common super type for exceptions indicating RPC abortion.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.Call

Invocation-side utility object for an RPC.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.CancellationError

Indicates that an RPC has been cancelled.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.ExpirationError

Indicates that an RPC has expired ("timed out").

classsrc.python.grpcio.grpc.framework.interfaces.face.face.GenericStub

Affords RPC invocation via generic methods.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.MultiMethodImplementation

A general type able to service many methods.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.NetworkError

Indicates that some error occurred on the network.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.RpcContext

Provides RPC-related information and action.

methodsrc.python.grpcio.grpc.framework.interfaces.face.face.RpcContext.cancel()

Cancels the RPC.

classsrc.python.grpcio.grpc.framework.interfaces.face.face.ServicerContext

A context object passed to method implementations.

classsrc.python.grpcio_channelz.grpc_channelz.v1._servicer.ChannelzServicer

Servicer handling RPCs for service statuses.

funcsrc.python.grpcio_csds.grpc_csds.add_csds_servicer(server)

method

src.python.grpcio_health_checking.grpc_health.v1._async.HealthServicer.set(service:str, status:_health_pb2.HealthCheckResponse.ServingStatus) -> None

Sets the status of a service.

classsrc.python.grpcio_health_checking.grpc_health.v1.health.HealthServicer

Servicer handling RPCs for service statuses.

classsrc.python.grpcio_observability.grpc_observability._observability.Exporter

Abstract base class for census data exporters.

classsrc.python.grpcio_observability.grpc_observability._observability.StatsData

A data class representing stats data.

classsrc.python.grpcio_observability.grpc_observability._observability.TracingData

A data class representing tracing data.

classsrc.python.grpcio_observability.grpc_observability._open_census_exporter.StackDriverAsyncTransport

Wrapper class used to pass wait_period.

classsrc.python.grpcio_reflection.grpc_reflection.v1alpha._async.ReflectionServicer

Servicer handling RPCs for service statuses.

classsrc.python.grpcio_reflection.grpc_reflection.v1alpha._base.BaseReflectionServicer

Base class for reflection servicer.

classsrc.python.grpcio_reflection.grpc_reflection.v1alpha.reflection.ReflectionServicer

Servicer handling RPCs for service statuses.

classsrc.python.grpcio_status.status_commands.Preprocess

Command to copy LICENSE from root directory.

classsrc.python.grpcio_testing.grpc_testing.Server

A server with which to test a system that services RPCs.

classsrc.python.grpcio_testing.grpc_testing.Time

A simulation of time.

methodsrc.python.grpcio_testing.grpc_testing.Time.sleep_until(time)

Blocks until some test time.

methodsrc.python.grpcio_testing.grpc_testing.Time.time()

Accesses the current test time.

classsrc.python.grpcio_testing.testing_commands.Preprocess

Command to copy LICENSE from root directory.

classsrc.python.grpcio_tests.commands.BuildPy

Custom project build command.

classsrc.python.grpcio_tests.commands.TestLite

Command to run tests without fetching or building anything.

classsrc.python.grpcio_tests.commands.TestPy3Only

Command to run tests for Python 3+ features.

この情報について

掲載しているシグネチャは grpc/grpc の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る