"description":"The Google Cloud Platform Service Broker API provides Google hosted\nimplementation of the Open Service Broker API\n(https://www.openservicebrokerapi.org/).\n",
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location":"query",
"type":"string"
},
"callback":{
"description":"JSONP",
"location":"query",
"type":"string"
},
"fields":{
"description":"Selector specifying which fields to include in a partial response.",
"location":"query",
"type":"string"
},
"key":{
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location":"query",
"type":"string"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"location":"query",
"type":"string"
},
"prettyPrint":{
"default":"true",
"description":"Returns response with indentations and line breaks.",
"location":"query",
"type":"boolean"
},
"quotaUser":{
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location":"query",
"type":"string"
},
"uploadType":{
"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location":"query",
"type":"string"
},
"upload_protocol":{
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location":"query",
"type":"string"
}
},
"protocol":"rest",
"resources":{
"projects":{
"resources":{
"brokers":{
"resources":{
"instances":{
"methods":{
"get":{
"description":"Gets the given service instance from the system.\nThis API is an extension and not part of the OSB spec.\nHence the path is a standard Google API URL.",
"description":"Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.\nOptional. If unset or 0, all the results will be returned.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"description":"Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
"location":"query",
"type":"string"
},
"parent":{
"description":"Parent must match\n`projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`.",
"description":"Lists all the instances in the brokers\nThis API is an extension and not part of the OSB spec.\nHence the path is a standard Google API URL.",
"description":"Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.\nOptional. If unset or 0, all the results will be returned.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"description":"Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
"location":"query",
"type":"string"
},
"parent":{
"description":"Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.",
"description":"Lists all the Services registered with this broker for consumption for\ngiven service registry broker, which contains an set of services.\nNote, that Service producer API is separate from Broker API.",
"description":"Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.\nOptional. If unset or 0, all the results will be returned.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"description":"Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
"location":"query",
"type":"string"
},
"parent":{
"description":"Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.",
"description":"Provisions a service instance.\nIf `request.accepts_incomplete` is false and Broker cannot execute request\nsynchronously HTTP 422 error will be returned along with\nFAILED_PRECONDITION status.\nIf `request.accepts_incomplete` is true and the Broker decides to execute\nresource asynchronously then HTTP 202 response code will be returned and a\nvalid polling operation in the response will be included.\nIf Broker executes the request synchronously and it succeeds HTTP 201\nresponse will be furnished.\nIf identical instance exists, then HTTP 200 response will be returned.\nIf an instance with identical ID but mismatching parameters exists, then\nHTTP 409 status code will be returned.",
"description":"Value indicating that API client supports asynchronous operations. If\nBroker cannot execute the request synchronously HTTP 422 code will be\nreturned to HTTP clients along with FAILED_PRECONDITION error.\nIf true and broker will execute request asynchronously 202 HTTP code will\nbe returned.\nThis broker always requires this to be true as all mutator operations are\nasynchronous.",
"location":"query",
"type":"boolean"
},
"instance_id":{
"description":"The id of the service instance. Must be unique within GCP project.\nMaximum length is 64, GUID recommended.\nRequired.",
"location":"path",
"pattern":"^[^/]+$",
"required":true,
"type":"string"
},
"parent":{
"description":"Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.",
"description":"Deprovisions a service instance.\nFor synchronous/asynchronous request details see CreateServiceInstance\nmethod.\nIf service instance does not exist HTTP 410 status will be returned.",
"description":"Gets the given service instance from the system.\nThis API is an extension and not part of the OSB spec.\nHence the path is a standard Google API URL.",
"description":"Unbinds from a service instance.\nFor synchronous/asynchronous request details see CreateServiceInstance\nmethod.\nIf binding does not exist HTTP 410 status will be returned.",
"description":"Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"flatPath":"v1alpha1/{v1alpha1Id}:getIamPolicy",
"httpMethod":"GET",
"id":"servicebroker.getIamPolicy",
"parameterOrder":[
"resource"
],
"parameters":{
"resource":{
"description":"REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location":"path",
"pattern":"^.+$",
"required":true,
"type":"string"
}
},
"path":"v1alpha1/{+resource}:getIamPolicy",
"response":{
"$ref":"GoogleIamV1__Policy"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy":{
"description":"Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"flatPath":"v1alpha1/{v1alpha1Id}:setIamPolicy",
"httpMethod":"POST",
"id":"servicebroker.setIamPolicy",
"parameterOrder":[
"resource"
],
"parameters":{
"resource":{
"description":"REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"location":"path",
"pattern":"^.+$",
"required":true,
"type":"string"
}
},
"path":"v1alpha1/{+resource}:setIamPolicy",
"request":{
"$ref":"GoogleIamV1__SetIamPolicyRequest"
},
"response":{
"$ref":"GoogleIamV1__Policy"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions":{
"description":"Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"description":"REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"description":"A JSON object that contains data for platform resources associated with\nthe binding to be created.",
"type":"object"
},
"binding_id":{
"description":"The id of the binding. Must be unique within GCP project.\nMaximum length is 64, GUID recommended.\nRequired.",
"type":"string"
},
"createTime":{
"description":"Output only.\nTimestamp for when the binding was created.",
"format":"google-datetime",
"type":"string"
},
"parameters":{
"additionalProperties":{
"description":"Properties of the object.",
"type":"any"
},
"description":"Configuration options for the service binding.",
"type":"object"
},
"plan_id":{
"description":"The ID of the plan. See `Service` and `Plan` resources for details.\nMaximum length is 64, GUID recommended.\nRequired.",
"type":"string"
},
"service_id":{
"description":"The id of the service. Must be a valid identifier of a service\ncontained in the list from a `ListServices()` call.\nMaximum length is 64, GUID recommended.\nRequired.",
"description":"Used to communicate description of the response. Usually for non-standard\nerror codes.\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors",
"type":"string"
},
"operation":{
"description":"If broker executes operation asynchronously, this is the operation ID that\ncan be polled to check the completion status of said operation.\nThis broker always executes all create/delete operations asynchronously.",
"type":"string"
},
"route_service_url":{
"description":"A URL to which the platform may proxy requests for the address sent with\nbind_resource.route",
"type":"string"
},
"syslog_drain_url":{
"description":"From where to read system logs.",
"type":"string"
},
"volume_mounts":{
"description":"An array of configuration for mounting volumes.",
"description":"Used to communicate description of the response. Usually for non-standard\nerror codes.\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors",
"type":"string"
},
"operation":{
"description":"If broker executes operation asynchronously, this is the operation ID that\ncan be polled to check the completion status of said operation.\nThis broker always will return a non-empty operation on success.",
"description":"Used to communicate description of the response. Usually for non-standard\nerror codes.\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors",
"type":"string"
},
"operation":{
"description":"If broker executes operation asynchronously, this is the operation ID that\ncan be polled to check the completion status of said operation.",
"description":"Used to communicate description of the response. Usually for non-standard\nerror codes.\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors",
"type":"string"
},
"operation":{
"description":"If broker executes operation asynchronously, this is the operation ID that\ncan be polled to check the completion status of said operation.",
"description":"Used to communicate description of the response. Usually for non-standard\nerror codes.\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors",
"type":"string"
},
"route_service_url":{
"description":"A URL to which the platform may proxy requests for the address sent with\nbind_resource.route",
"type":"string"
},
"syslog_drain_url":{
"description":"From where to read system logs.",
"type":"string"
},
"volume_mounts":{
"description":"An array of configuration for mounting volumes.",
"description":"Used to communicate description of the response. Usually for non-standard\nerror codes.\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors",
"type":"string"
},
"nextPageToken":{
"description":"This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
"description":"Used to communicate description of the response. Usually for non-standard\nerror codes.\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors",
"type":"string"
},
"nextPageToken":{
"description":"This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
"type":"string"
},
"services":{
"description":"The services available for the requested GCP project.",
"description":"Used to communicate description of the response. Usually for non-standard\nerror codes.\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors",
"type":"string"
},
"instances":{
"description":"The list of the instances in the broker.",
"description":"This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
"type":"string"
}
},
"type":"object"
},
"GoogleCloudServicebrokerV1alpha1__Operation":{
"description":"Describes a long running operation, which conforms to OpenService API.",
"description":"Optional description of the Operation state.",
"type":"string"
},
"state":{
"description":"The state of the operation.\nValid values are: \"in progress\", \"succeeded\", and \"failed\".",
"type":"string"
}
},
"type":"object"
},
"GoogleCloudServicebrokerV1alpha1__Plan":{
"description":"Plan message describes a Service Plan.",
"id":"GoogleCloudServicebrokerV1alpha1__Plan",
"properties":{
"bindable":{
"description":"Specifies whether instances of the service can be bound to applications.\nIf not specified, `Service.bindable` will be presumed.",
"type":"boolean"
},
"description":{
"description":"Textual description of the plan. Optional.",
"type":"string"
},
"free":{
"description":"Whether the service is free.",
"type":"boolean"
},
"id":{
"description":"ID is a globally unique identifier used to uniquely identify the plan.\nUser must make no presumption about the format of this field.",
"type":"string"
},
"metadata":{
"additionalProperties":{
"description":"Properties of the object.",
"type":"any"
},
"description":"A list of metadata for a service offering.\nMetadata is an arbitrary JSON object.",
"type":"object"
},
"name":{
"description":"User friendly name of the plan.\nThe name must be globally unique within GCP project.\nNote, which is different from (\"This must be globally unique within a\nplatform marketplace\").",
"type":"string"
},
"schemas":{
"additionalProperties":{
"description":"Properties of the object.",
"type":"any"
},
"description":"Schema definitions for service instances and bindings for the plan.",
"type":"object"
}
},
"type":"object"
},
"GoogleCloudServicebrokerV1alpha1__Service":{
"description":"The resource model mostly follows the Open Service Broker API, as\ndescribed here:\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md\nThough due to Google Specifics it has additional optional fields.",
"id":"GoogleCloudServicebrokerV1alpha1__Service",
"properties":{
"bindable":{
"description":"Specifies whether instances of the service can be bound to applications.\nRequired.",
"type":"boolean"
},
"binding_retrievable":{
"description":"Whether the service provides an endpoint to get service bindings.",
"description":"Information to activate Dashboard SSO feature."
},
"description":{
"description":"Textual description of the service. Required.",
"type":"string"
},
"id":{
"description":"ID is a globally unique identifier used to uniquely identify the service.\nID is an opaque string.",
"type":"string"
},
"instance_retrievable":{
"description":"Whether the service provides an endpoint to get service instances.",
"type":"boolean"
},
"metadata":{
"additionalProperties":{
"description":"Properties of the object.",
"type":"any"
},
"description":"A list of metadata for a service offering.\nMetadata is an arbitrary JSON object.",
"type":"object"
},
"name":{
"description":"User friendly service name.\nName must match [a-z0-9]+ regexp.\nThe name must be globally unique within GCP project.\nNote, which is different from (\"This must be globally unique within a\nplatform marketplace\").\nRequired.",
"type":"string"
},
"plan_updateable":{
"description":"Whether the service supports upgrade/downgrade for some plans.",
"type":"boolean"
},
"plans":{
"description":"A list of plans for this service.\nAt least one plan is required.",
"items":{
"$ref":"GoogleCloudServicebrokerV1alpha1__Plan"
},
"type":"array"
},
"tags":{
"description":"Tags provide a flexible mechanism to expose a classification, attribute, or\nbase technology of a service.",
"description":"Platform specific contextual information under which the service instance\nis to be provisioned. This replaces organization_guid and space_guid.\nBut can also contain anything.\nCurrently only used for logging context information.",
"type":"object"
},
"createTime":{
"description":"Output only.\nTimestamp for when the instance was created.",
"format":"google-datetime",
"type":"string"
},
"deploymentName":{
"description":"Output only.\nName of the Deployment Manager deployment used for provisioning of this\nservice instance.",
"type":"string"
},
"instance_id":{
"description":"The id of the service instance. Must be unique within GCP project.\nMaximum length is 64, GUID recommended.\nRequired.",
"type":"string"
},
"organization_guid":{
"description":"The platform GUID for the organization under which the service is to be\nprovisioned.\nRequired.",
"type":"string"
},
"parameters":{
"additionalProperties":{
"description":"Properties of the object.",
"type":"any"
},
"description":"Configuration options for the service instance.\nParameters is JSON object serialized to string.",
"type":"object"
},
"plan_id":{
"description":"The ID of the plan. See `Service` and `Plan` resources for details.\nMaximum length is 64, GUID recommended.\nRequired.",
"type":"string"
},
"previous_values":{
"additionalProperties":{
"description":"Properties of the object.",
"type":"any"
},
"description":"Used only in UpdateServiceInstance request to optionally specify previous\nfields.",
"type":"object"
},
"resourceName":{
"description":"Output only.\nThe resource name of the instance, e.g.\nprojects/project_id/brokers/broker_id/service_instances/instance_id",
"type":"string"
},
"service_id":{
"description":"The id of the service. Must be a valid identifier of a service\ncontained in the list from a `ListServices()` call.\nMaximum length is 64, GUID recommended.\nRequired.",
"type":"string"
},
"space_guid":{
"description":"The identifier for the project space within the platform organization.\nRequired.",
"description":"Used to communicate description of the response. Usually for non-standard\nerror codes.\nhttps://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors",
"type":"string"
},
"operation":{
"description":"If broker executes operation asynchronously, this is the operation ID that\ncan be polled to check the completion status of said operation.",
"type":"string"
}
},
"type":"object"
},
"GoogleIamV1__Binding":{
"description":"Associates `members` with a `role`.",
"description":"Unimplemented. The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description":"Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"description":"Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\n**YAML Example**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
"id":"GoogleIamV1__Policy",
"properties":{
"bindings":{
"description":"Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"items":{
"$ref":"GoogleIamV1__Binding"
},
"type":"array"
},
"etag":{
"description":"`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"format":"byte",
"type":"string"
},
"version":{
"description":"Deprecated.",
"format":"int32",
"type":"integer"
}
},
"type":"object"
},
"GoogleIamV1__SetIamPolicyRequest":{
"description":"Request message for `SetIamPolicy` method.",
"id":"GoogleIamV1__SetIamPolicyRequest",
"properties":{
"policy":{
"$ref":"GoogleIamV1__Policy",
"description":"REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
"type":"object"
},
"GoogleIamV1__TestIamPermissionsRequest":{
"description":"Request message for `TestIamPermissions` method.",
"id":"GoogleIamV1__TestIamPermissionsRequest",
"properties":{
"permissions":{
"description":"The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items":{
"type":"string"
},
"type":"array"
}
},
"type":"object"
},
"GoogleIamV1__TestIamPermissionsResponse":{
"description":"Response message for `TestIamPermissions` method.",
"id":"GoogleIamV1__TestIamPermissionsResponse",
"properties":{
"permissions":{
"description":"A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"description":"Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"id":"GoogleType__Expr",
"properties":{
"description":{
"description":"An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type":"string"
},
"expression":{
"description":"Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type":"string"
},
"location":{
"description":"An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type":"string"
},
"title":{
"description":"An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
