Pub/Sub Lite API . admin . projects . locations . reservations

close()

Close httplib2 connections.

create(parent, body=None, reservationId=None, x__xgafv=None)

Creates a new reservation.

Args:
  parent: string, Required. The parent location in which to create the reservation. Structured like `projects/{project_number}/locations/{location}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Metadata about a reservation resource.
  "name": "A String", # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
  "throughputCapacity": "A String", # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
}

  reservationId: string, Required. The ID to use for the reservation, which will become the final component of the reservation's name. This value is structured like: `my-reservation-name`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata about a reservation resource.
  "name": "A String", # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
  "throughputCapacity": "A String", # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
}

delete(name, x__xgafv=None)

Deletes the specified reservation.

Args:
  name: string, Required. The name of the reservation to delete. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Returns the reservation configuration.

Args:
  name: string, Required. The name of the reservation whose configuration to return. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata about a reservation resource.
  "name": "A String", # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
  "throughputCapacity": "A String", # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns the list of reservations for the given project.

Args:
  parent: string, Required. The parent whose reservations are to be listed. Structured like `projects/{project_number}/locations/{location}`. (required)
  pageSize: integer, The maximum number of reservations to return. The service may return fewer than this value. If unset or zero, all reservations for the parent will be returned.
  pageToken: string, A page token, received from a previous `ListReservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReservations` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListReservations.
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
  "reservations": [ # The list of reservation in the requested parent. The order of the reservations is unspecified.
    { # Metadata about a reservation resource.
      "name": "A String", # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
      "throughputCapacity": "A String", # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates properties of the specified reservation.

Args:
  name: string, The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Metadata about a reservation resource.
  "name": "A String", # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
  "throughputCapacity": "A String", # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
}

  updateMask: string, Required. A mask specifying the reservation fields to change.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata about a reservation resource.
  "name": "A String", # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
  "throughputCapacity": "A String", # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
}