Class AdminClient (1.9.0)

AdminClient(
    region: google.cloud.pubsublite.types.location.CloudRegion,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[str] = None,
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

An admin client for Pub/Sub Lite. Only operates on a single region.

Methods

AdminClient

AdminClient(
    region: google.cloud.pubsublite.types.location.CloudRegion,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[str] = None,
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Create a new AdminClient.

Parameters
Name Description
region CloudRegion

The cloud region to connect to.

credentials typing.Optional[google.auth.credentials.Credentials]

The credentials to use when connecting.

transport typing.Optional[str]

The transport to use.

client_options typing.Optional[google.api_core.client_options.ClientOptions]

The client options to use when connecting. If used, must explicitly set api_endpoint.

create_reservation

create_reservation(
    reservation: google.cloud.pubsublite_v1.types.common.Reservation,
) -> google.cloud.pubsublite_v1.types.common.Reservation

Create a reservation, returns the created reservation.

create_subscription

create_subscription(
    subscription: google.cloud.pubsublite_v1.types.common.Subscription,
    target: typing