Service Broker API . projects . brokers . v2 . catalog

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

Lists all the Services registered with this broker for consumption for
given service registry broker, which contains an set of services.
Note, that Service producer API is separate from Broker API.

Args:
  parent: string, Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. (required)
  pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
returned by a previous list request to get the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, Specifies the number of results to return per page. If there are fewer
elements than the specified number, returns all elements.
Optional. If unset or 0, all the results will be returned.

Returns:
  An object of the form:

    { # Response message for the `ListCatalog()` method.
    "services": [ # The services available for the requested GCP project.
      { # The resource model mostly follows the Open Service Broker API, as
          # described here:
          # https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md
          # Though due to Google Specifics it has additional optional fields.
        "plans": [ # A list of plans for this service.
            # At least one plan is required.
          { # Plan message describes a Service Plan.
            "description": "A String", # Textual description of the plan. Optional.
            "free": True or False, # Whether the service is free.
            "name": "A String", # User friendly name of the plan.
                # The name must be globally unique within GCP project.
                # Note, which is different from ("This must be globally unique within a
                # platform marketplace").
            "bindable": True or False, # Specifies whether instances of the service can be bound to applications.
                # If not specified, `Service.bindable` will be presumed.
            "schemas": { # Schema definitions for service instances and bindings for the plan.
              "a_key": "", # Properties of the object.
            },
            "id": "A String", # ID is a globally unique identifier used to uniquely identify the plan.
                # User must make no presumption about the format of this field.
            "metadata": { # A list of metadata for a service offering.
                # Metadata is an arbitrary JSON object.
              "a_key": "", # Properties of the object.
            },
          },
        ],
        "binding_retrievable": True or False, # Whether the service provides an endpoint to get service bindings.
        "tags": [ # Tags provide a flexible mechanism to expose a classification, attribute, or
            # base technology of a service.
          "A String",
        ],
        "metadata": { # A list of metadata for a service offering.
            # Metadata is an arbitrary JSON object.
          "a_key": "", # Properties of the object.
        },
        "dashboard_client": { # Message containing information required to activate Dashboard SSO feature. # Information to activate Dashboard SSO feature.
          "secret": "A String", # A secret for the dashboard client.
          "redirect_uri": "A String", # A URI for the service dashboard.
              # Validated by the OAuth token server when the dashboard requests a token.
          "id": "A String", # The id of the Oauth client that the dashboard will use.
        },
        "name": "A String", # User friendly service name.
            # Name must match [a-z0-9]+ regexp.
            # The name must be globally unique within GCP project.
            # Note, which is different from ("This must be globally unique within a
            # platform marketplace").
            # Required.
        "plan_updateable": True or False, # Whether the service supports upgrade/downgrade for some plans.
        "bindings_retrievable": True or False, # Whether the service provides an endpoint to get service bindings.
        "bindable": True or False, # Specifies whether instances of the service can be bound to applications.
            # Required.
        "instances_retrievable": True or False, # Whether the service provides an endpoint to get service instances.
        "id": "A String", # ID is a globally unique identifier used to uniquely identify the service.
            # ID is an opaque string.
        "description": "A String", # Textual description of the service. Required.
      },
    ],
    "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
        # If the number of results is larger than `pageSize`, use the `nextPageToken`
        # as a value for the query parameter `pageToken` in the next list request.
        # Subsequent list requests will have their own `nextPageToken` to continue
        # paging through the results
    "description": "A String", # Used to communicate description of the response. Usually for non-standard
        # error codes.
        # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
  }

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.