App Engine Admin API . projects . locations . applications . services

Instance Methods

close()

Close httplib2 connections.

get(projectsId, locationsId, applicationsId, servicesId, x__xgafv=None)

Gets the current configuration of the specified service.

list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the services in the application.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(projectsId, locationsId, applicationsId, servicesId, x__xgafv=None)
Gets the current configuration of the specified service.

Args:
  projectsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. (required)
  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
  servicesId: string, Part of `name`. See documentation of `projectsId`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
  "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
  "labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
    "a_key": "A String",
  },
  "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
  "networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
    "ingressTrafficAllowed": "A String", # The ingress settings for version or service.
  },
  "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
    "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
      "a_key": 3.14,
    },
    "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
  },
}
list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the services in the application.

Args:
  projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
  locationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
  applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
  pageSize: integer, Maximum results to return per page.
  pageToken: string, Continuation token for fetching the next page of results.
  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 Services.ListServices.
  "nextPageToken": "A String", # Continuation token for fetching the next page of results.
  "services": [ # The services belonging to the requested application.
    { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
      "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
      "labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
        "a_key": "A String",
      },
      "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
      "networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
        "ingressTrafficAllowed": "A String", # The ingress settings for version or service.
      },
      "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
        "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
          "a_key": 3.14,
        },
        "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
      },
    },
  ],
}
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.