BeyondCorp API . organizations . locations . subscriptions

cancel(name, requestId=None, x__xgafv=None)

Cancels an existing BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective

Args:
  name: string, Required. Name of the resource. (required)
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BeyondCorp.CancelSubscription
  "effectiveCancellationTime": "A String", # Time when the cancellation will become effective
}

close()

Close httplib2 connections.

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

Creates a new BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.

Args:
  parent: string, Required. The resource name of the subscription location using the form: `organizations/{organization_id}/locations/{location}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
  "autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
  "billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
  "createTime": "A String", # Output only. Create time of the subscription.
  "endTime": "A String", # Output only. End time of the subscription.
  "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
  "seatCount": "A String", # Optional. Number of seats in the subscription.
  "sku": "A String", # Required. SKU of subscription.
  "startTime": "A String", # Output only. Start time of the subscription.
  "state": "A String", # Output only. The current state of the subscription.
  "subscriberType": "A String", # Output only. Type of subscriber.
  "type": "A String", # Required. Type of subscription.
}

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

Returns:
  An object of the form:

    { # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
  "autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
  "billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
  "createTime": "A String", # Output only. Create time of the subscription.
  "endTime": "A String", # Output only. End time of the subscription.
  "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
  "seatCount": "A String", # Optional. Number of seats in the subscription.
  "sku": "A String", # Required. SKU of subscription.
  "startTime": "A String", # Output only. Start time of the subscription.
  "state": "A String", # Output only. The current state of the subscription.
  "subscriberType": "A String", # Output only. Type of subscriber.
  "type": "A String", # Required. Type of subscription.
}

get(name, x__xgafv=None)

Gets details of a single Subscription.

Args:
  name: string, Required. The resource name of Subscription using the form: `organizations/{organization_id}/locations/{location}/subscriptions/{subscription_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 BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
  "autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
  "billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
  "createTime": "A String", # Output only. Create time of the subscription.
  "endTime": "A String", # Output only. End time of the subscription.
  "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
  "seatCount": "A String", # Optional. Number of seats in the subscription.
  "sku": "A String", # Required. SKU of subscription.
  "startTime": "A String", # Output only. Start time of the subscription.
  "state": "A String", # Output only. The current state of the subscription.
  "subscriberType": "A String", # Output only. Type of subscriber.
  "type": "A String", # Required. Type of subscription.
}

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

Lists Subscriptions in a given organization and location.

Args:
  parent: string, Required. The resource name of Subscription using the form: `organizations/{organization_id}/locations/{location}` (required)
  pageSize: integer, Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
  pageToken: string, Optional. The next_page_token value returned from a previous ListSubscriptionsRequest, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BeyondCorp.ListSubscriptions.
  "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list.
  "subscriptions": [ # A list of BeyondCorp Subscriptions in the organization.
    { # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
      "autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
      "billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
      "createTime": "A String", # Output only. Create time of the subscription.
      "endTime": "A String", # Output only. End time of the subscription.
      "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
      "seatCount": "A String", # Optional. Number of seats in the subscription.
      "sku": "A String", # Required. SKU of subscription.
      "startTime": "A String", # Output only. Start time of the subscription.
      "state": "A String", # Output only. The current state of the subscription.
      "subscriberType": "A String", # Output only. Type of subscriber.
      "type": "A String", # Required. Type of subscription.
    },
  ],
}

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, requestId=None, updateMask=None, x__xgafv=None)

Updates an existing BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.

Args:
  name: string, Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription. (required)
  body: object, The request body.
    The object takes the form of:

{ # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
  "autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
  "billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
  "createTime": "A String", # Output only. Create time of the subscription.
  "endTime": "A String", # Output only. End time of the subscription.
  "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
  "seatCount": "A String", # Optional. Number of seats in the subscription.
  "sku": "A String", # Required. SKU of subscription.
  "startTime": "A String", # Output only. Start time of the subscription.
  "state": "A String", # Output only. The current state of the subscription.
  "subscriberType": "A String", # Output only. Type of subscriber.
  "type": "A String", # Required. Type of subscription.
}

  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Subscription resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. Mutable fields: seat_count.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
  "autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
  "billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
  "createTime": "A String", # Output only. Create time of the subscription.
  "endTime": "A String", # Output only. End time of the subscription.
  "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
  "seatCount": "A String", # Optional. Number of seats in the subscription.
  "sku": "A String", # Required. SKU of subscription.
  "startTime": "A String", # Output only. Start time of the subscription.
  "state": "A String", # Output only. The current state of the subscription.
  "subscriberType": "A String", # Output only. Type of subscriber.
  "type": "A String", # Required. Type of subscription.
}

restart(name, requestId=None, x__xgafv=None)

Restarts an existing BeyondCorp Enterprise Subscription in a given organization, that is scheduled for cancellation. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective

Args:
  name: string, Required. Name of the resource. (required)
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BeyondCorp.RestartSubscription
}