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

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, skipBacklog=None, subscriptionId=None, x__xgafv=None)

Creates a new subscription.

delete(name, x__xgafv=None)

Deletes the specified subscription.

get(name, x__xgafv=None)

Returns the subscription configuration.

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

Returns the list of subscriptions for the given project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

Updates properties of the specified subscription.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, skipBacklog=None, subscriptionId=None, x__xgafv=None)
Creates a new subscription.

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

{ # Metadata about a subscription resource.
  "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery.
    "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription.
  },
  "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
  "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
}

  skipBacklog: boolean, If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.
  subscriptionId: string, Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-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 subscription resource.
  "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery.
    "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription.
  },
  "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
  "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
}
delete(name, x__xgafv=None)
Deletes the specified subscription.

Args:
  name: string, Required. The name of the subscription to delete. (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); } The JSON representation for `Empty` is empty JSON object `{}`.
}
get(name, x__xgafv=None)
Returns the subscription configuration.

Args:
  name: string, Required. The name of the subscription whose configuration to return. (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 subscription resource.
  "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery.
    "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription.
  },
  "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
  "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of subscriptions for the given project.

Args:
  parent: string, Required. The parent whose subscriptions are to be listed. Structured like `projects/{project_number}/locations/{location}`. (required)
  pageSize: integer, The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned.
  pageToken: string, A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` 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 ListSubscriptions.
  "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.
  "subscriptions": [ # The list of subscriptions in the requested parent. The order of the subscriptions is unspecified.
    { # Metadata about a subscription resource.
      "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery.
        "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription.
      },
      "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
      "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    },
  ],
}
list_next(previous_request, previous_response)
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 subscription.

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

{ # Metadata about a subscription resource.
  "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery.
    "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription.
  },
  "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
  "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
}

  updateMask: string, Required. A mask specifying the subscription 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 subscription resource.
  "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery.
    "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription.
  },
  "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
  "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
}