Analytics Hub API . projects . locations . subscriptions

Instance Methods

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Deletes a subscription.

get(name, x__xgafv=None)

Gets the details of a Subscription.

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

Lists all subscriptions in a given project and location.

list_next()

Retrieves the next page of results.

refresh(name, body=None, x__xgafv=None)

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

revoke(name, body=None, x__xgafv=None)

Revokes a given subscription.

Method Details

close()
Close httplib2 connections.
delete(name, x__xgafv=None)
Deletes a subscription.

Args:
  name: string, Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
get(name, x__xgafv=None)
Gets the details of a Subscription.

Args:
  name: string, Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.
  "creationTime": "A String", # Output only. Timestamp when the subscription was created.
  "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
  "lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
  "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
    "a_key": { # Reference to a linked resource tracked by this Subscription.
      "linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
    },
  },
  "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
  "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
  "organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
  "organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
  "state": "A String", # Output only. Current state of the subscription.
  "subscriberContact": "A String", # Output only. Email of the subscriber.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all subscriptions in a given project and location.

Args:
  parent: string, Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US (required)
  filter: string, The filter expression may be used to filter by Data Exchange or Listing.
  pageSize: integer, The maximum number of results to return in a single response page.
  pageToken: string, Page token, returned by a previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to the listing of subscriptions.
  "nextPageToken": "A String", # Next page token.
  "subscriptions": [ # The list of subscriptions.
    { # A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.
      "creationTime": "A String", # Output only. Timestamp when the subscription was created.
      "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
      "lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
      "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
        "a_key": { # Reference to a linked resource tracked by this Subscription.
          "linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
        },
      },
      "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
      "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
      "organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
      "organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
      "state": "A String", # Output only. Current state of the subscription.
      "subscriberContact": "A String", # Output only. Email of the subscriber.
    },
  ],
}
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.
        
refresh(name, body=None, x__xgafv=None)
Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

Args:
  name: string, Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123` (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for refreshing a subscription.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
revoke(name, body=None, x__xgafv=None)
Revokes a given subscription.

Args:
  name: string, Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456 (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for revoking a subscription.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response when you revoke a subscription.
}