UNPKG

googleapis

Version:
903 lines (902 loc) 69 kB
/** * Copyright 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library'; import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common'; import { GaxiosPromise } from 'gaxios'; export declare namespace servicebroker_v1alpha1 { interface Options extends GlobalOptions { version: 'v1alpha1'; } interface StandardParameters { /** * V1 error format. */ '$.xgafv'?: string; /** * OAuth access token. */ access_token?: string; /** * Data format for response. */ alt?: string; /** * JSONP */ callback?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * 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. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * 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. */ quotaUser?: string; /** * Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** * Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; } /** * Service Broker API * * The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/). * * @example * const {google} = require('googleapis'); * const servicebroker = google.servicebroker('v1alpha1'); * * @namespace servicebroker * @type {Function} * @version v1alpha1 * @variation v1alpha1 * @param {object=} options Options for Servicebroker */ class Servicebroker { context: APIRequestContext; projects: Resource$Projects; v1alpha1: Resource$V1alpha1; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * Describes the binding. */ interface Schema$GoogleCloudServicebrokerV1alpha1__Binding { /** * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ binding_id?: string; /** * A JSON object that contains data for platform resources associated with the binding to be created. */ bind_resource?: { [key: string]: any; }; /** * Output only. Timestamp for when the binding was created. */ createTime?: string; /** * Configuration options for the service binding. */ parameters?: { [key: string]: any; }; /** * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ plan_id?: string; /** * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ service_id?: string; } /** * Response for the `CreateBinding()` method. */ interface Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse { /** * Credentials to use the binding. */ credentials?: { [key: string]: any; }; /** * 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 */ description?: string; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always executes all create/delete operations asynchronously. */ operation?: string; /** * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ route_service_url?: string; /** * From where to read system logs. */ syslog_drain_url?: string; /** * An array of configuration for mounting volumes. */ volume_mounts?: Array<{ [key: string]: any; }>; } /** * Response for the `CreateServiceInstance()` method. */ interface Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse { /** * 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 */ description?: string; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always will return a non-empty operation on success. */ operation?: string; } /** * Message containing information required to activate Dashboard SSO feature. */ interface Schema$GoogleCloudServicebrokerV1alpha1__DashboardClient { /** * The id of the Oauth client that the dashboard will use. */ id?: string; /** * A URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token. */ redirect_uri?: string; /** * A secret for the dashboard client. */ secret?: string; } /** * Response for the `DeleteBinding()` method. */ interface Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse { /** * 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 */ description?: string; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ operation?: string; } /** * Response for the `DeleteServiceInstance()` method. */ interface Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse { /** * 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 */ description?: string; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ operation?: string; } /** * Response for the `GetBinding()` method. */ interface Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse { /** * Credentials to use the binding. */ credentials?: { [key: string]: any; }; /** * 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 */ description?: string; /** * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ route_service_url?: string; /** * From where to read system logs. */ syslog_drain_url?: string; /** * An array of configuration for mounting volumes. */ volume_mounts?: Array<{ [key: string]: any; }>; } /** * The response for the `ListBindings()` method. */ interface Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse { /** * The list of the bindings in the instance. */ bindings?: Schema$GoogleCloudServicebrokerV1alpha1__Binding[]; /** * 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 */ description?: 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 */ nextPageToken?: string; } /** * Response message for the `ListCatalog()` method. */ interface Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse { /** * 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 */ description?: 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 */ nextPageToken?: string; /** * The services available for the requested GCP project. */ services?: Schema$GoogleCloudServicebrokerV1alpha1__Service[]; } /** * The response for the `ListServiceInstances()` method. */ interface Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse { /** * 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 */ description?: string; /** * The list of the instances in the broker. */ instances?: Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance[]; /** * 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 */ nextPageToken?: string; } /** * Describes a long running operation, which conforms to OpenService API. */ interface Schema$GoogleCloudServicebrokerV1alpha1__Operation { /** * Optional description of the Operation state. */ description?: string; /** * The state of the operation. Valid values are: &quot;in progress&quot;, &quot;succeeded&quot;, and &quot;failed&quot;. */ state?: string; } /** * Plan message describes a Service Plan. */ interface Schema$GoogleCloudServicebrokerV1alpha1__Plan { /** * Specifies whether instances of the service can be bound to applications. If not specified, `Service.bindable` will be presumed. */ bindable?: boolean; /** * Textual description of the plan. Optional. */ description?: string; /** * Whether the service is free. */ free?: boolean; /** * ID is a globally unique identifier used to uniquely identify the plan. User must make no presumption about the format of this field. */ id?: string; /** * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ metadata?: { [key: string]: any; }; /** * User friendly name of the plan. The name must be globally unique within GCP project. Note, which is different from (&quot;This must be globally unique within a platform marketplace&quot;). */ name?: string; /** * Schema definitions for service instances and bindings for the plan. */ schemas?: { [key: string]: any; }; } /** * 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. */ interface Schema$GoogleCloudServicebrokerV1alpha1__Service { /** * Specifies whether instances of the service can be bound to applications. Required. */ bindable?: boolean; /** * Whether the service provides an endpoint to get service bindings. */ binding_retrievable?: boolean; /** * Information to activate Dashboard SSO feature. */ dashboard_client?: Schema$GoogleCloudServicebrokerV1alpha1__DashboardClient; /** * Textual description of the service. Required. */ description?: string; /** * ID is a globally unique identifier used to uniquely identify the service. ID is an opaque string. */ id?: string; /** * Whether the service provides an endpoint to get service instances. */ instance_retrievable?: boolean; /** * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ metadata?: { [key: string]: any; }; /** * 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 (&quot;This must be globally unique within a platform marketplace&quot;). Required. */ name?: string; /** * A list of plans for this service. At least one plan is required. */ plans?: Schema$GoogleCloudServicebrokerV1alpha1__Plan[]; /** * Whether the service supports upgrade/downgrade for some plans. */ plan_updateable?: boolean; /** * Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service. */ tags?: string[]; } /** * Message describing inputs to Provision and Update Service instance requests. */ interface Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance { /** * Platform specific contextual information under which the service instance is to be provisioned. This replaces organization_guid and space_guid. But can also contain anything. Currently only used for logging context information. */ context?: { [key: string]: any; }; /** * Output only. Timestamp for when the instance was created. */ createTime?: string; /** * Output only. Name of the Deployment Manager deployment used for provisioning of this service instance. */ deploymentName?: string; /** * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ instance_id?: string; /** * The platform GUID for the organization under which the service is to be provisioned. Required. */ organization_guid?: string; /** * Configuration options for the service instance. Parameters is JSON object serialized to string. */ parameters?: { [key: string]: any; }; /** * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ plan_id?: string; /** * Used only in UpdateServiceInstance request to optionally specify previous fields. */ previous_values?: { [key: string]: any; }; /** * Output only. The resource name of the instance, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id */ resourceName?: string; /** * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ service_id?: string; /** * The identifier for the project space within the platform organization. Required. */ space_guid?: string; } /** * Response for the `UpdateServiceInstance()` method. */ interface Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse { /** * 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 */ description?: string; /** * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ operation?: string; } /** * Associates `members` with a `role`. */ interface Schema$GoogleIamV1__Binding { /** * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$GoogleType__Expr; /** * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/owner&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-other-app@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/viewer&quot;, &quot;members&quot;: [&quot;user:sean@example.com&quot;] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer&#39;s guide](https://cloud.google.com/iam/docs). */ interface Schema$GoogleIamV1__Policy { /** * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$GoogleIamV1__Binding[]; /** * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. */ etag?: string; /** * Deprecated. */ version?: number; } /** * Request message for `SetIamPolicy` method. */ interface Schema$GoogleIamV1__SetIamPolicyRequest { /** * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$GoogleIamV1__Policy; } /** * Request message for `TestIamPermissions` method. */ interface Schema$GoogleIamV1__TestIamPermissionsRequest { /** * The set of permissions to check for the `resource`. Permissions with wildcards (such as &#39;*&#39; or &#39;storage.*&#39;) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } /** * Response message for `TestIamPermissions` method. */ interface Schema$GoogleIamV1__TestIamPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** * Represents an expression text. Example: title: &quot;User account presence&quot; description: &quot;Determines whether the request has a user account&quot; expression: &quot;size(request.user) &gt; 0&quot; */ interface Schema$GoogleType__Expr { /** * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } class Resource$Projects { context: APIRequestContext; brokers: Resource$Projects$Brokers; constructor(context: APIRequestContext); } class Resource$Projects$Brokers { context: APIRequestContext; instances: Resource$Projects$Brokers$Instances; service_instances: Resource$Projects$Brokers$Service_instances; v2: Resource$Projects$Brokers$V2; constructor(context: APIRequestContext); } class Resource$Projects$Brokers$Instances { context: APIRequestContext; service_bindings: Resource$Projects$Brokers$Instances$Service_bindings; constructor(context: APIRequestContext); /** * servicebroker.projects.brokers.instances.get * @desc Gets the given service instance from the system. This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. * @alias servicebroker.projects.brokers.instances.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The resource name of the instance to return. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Brokers$Instances$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>; get(params: Params$Resource$Projects$Brokers$Instances$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>): void; get(params: Params$Resource$Projects$Brokers$Instances$Get, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>): void; get(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>): void; } interface Params$Resource$Projects$Brokers$Instances$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The resource name of the instance to return. */ name?: string; } class Resource$Projects$Brokers$Instances$Service_bindings { context: APIRequestContext; constructor(context: APIRequestContext); /** * servicebroker.projects.brokers.instances.service_bindings.list * @desc Lists all the bindings in the instance * @alias servicebroker.projects.brokers.instances.service_bindings.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize 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. * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Brokers$Instances$Service_bindings$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse>; list(params: Params$Resource$Projects$Brokers$Instances$Service_bindings$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse>): void; list(params: Params$Resource$Projects$Brokers$Instances$Service_bindings$List, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse>): void; list(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse>): void; } interface Params$Resource$Projects$Brokers$Instances$Service_bindings$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * 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. */ pageSize?: number; /** * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. */ parent?: string; } class Resource$Projects$Brokers$Service_instances { context: APIRequestContext; constructor(context: APIRequestContext); /** * servicebroker.projects.brokers.service_instances.list * @desc Lists all the instances in the brokers This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. * @alias servicebroker.projects.brokers.service_instances.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize 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. * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Brokers$Service_instances$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse>; list(params: Params$Resource$Projects$Brokers$Service_instances$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse>): void; list(params: Params$Resource$Projects$Brokers$Service_instances$List, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse>): void; list(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse>): void; } interface Params$Resource$Projects$Brokers$Service_instances$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * 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. */ pageSize?: number; /** * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. */ parent?: string; } class Resource$Projects$Brokers$V2 { context: APIRequestContext; catalog: Resource$Projects$Brokers$V2$Catalog; service_instances: Resource$Projects$Brokers$V2$Service_instances; constructor(context: APIRequestContext); } class Resource$Projects$Brokers$V2$Catalog { context: APIRequestContext; constructor(context: APIRequestContext); /** * servicebroker.projects.brokers.v2.catalog.list * @desc 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. * @alias servicebroker.projects.brokers.v2.catalog.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize 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. * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Brokers$V2$Catalog$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse>; list(params: Params$Resource$Projects$Brokers$V2$Catalog$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse>): void; list(params: Params$Resource$Projects$Brokers$V2$Catalog$List, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse>): void; list(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse>): void; } interface Params$Resource$Projects$Brokers$V2$Catalog$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * 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. */ pageSize?: number; /** * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. */ parent?: string; } class Resource$Projects$Brokers$V2$Service_instances { context: APIRequestContext; service_bindings: Resource$Projects$Brokers$V2$Service_instances$Service_bindings; constructor(context: APIRequestContext); /** * servicebroker.projects.brokers.v2.service_instances.create * @desc Provisions a service instance. If `request.accepts_incomplete` is false and Broker cannot execute request synchronously HTTP 422 error will be returned along with FAILED_PRECONDITION status. If `request.accepts_incomplete` is true and the Broker decides to execute resource asynchronously then HTTP 202 response code will be returned and a valid polling operation in the response will be included. If Broker executes the request synchronously and it succeeds HTTP 201 response will be furnished. If identical instance exists, then HTTP 200 response will be returned. If an instance with identical ID but mismatching parameters exists, then HTTP 409 status code will be returned. * @alias servicebroker.projects.brokers.v2.service_instances.create * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.acceptsIncomplete Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous. * @param {string} params.instance_id The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. * @param {().GoogleCloudServicebrokerV1alpha1__ServiceInstance} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse>; create(params: Params$Resource$Projects$Brokers$V2$Service_instances$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse>): void; create(params: Params$Resource$Projects$Brokers$V2$Service_instances$Create, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse>): void; create(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse>): void; /** * servicebroker.projects.brokers.v2.service_instances.delete * @desc Deprovisions a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If service instance does not exist HTTP 410 status will be returned. * @alias servicebroker.projects.brokers.v2.service_instances.delete * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. * @param {string} params.instanceId The instance id to deprovision. * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. * @param {string=} params.planId The plan id of the service instance. * @param {string=} params.serviceId The service id of the service instance. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse>; delete(params: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse>): void; delete(params: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse>): void; delete(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse>): void; /** * servicebroker.projects.brokers.v2.service_instances.get * @desc Gets the given service instance from the system. This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. * @alias servicebroker.projects.brokers.v2.service_instances.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The resource name of the instance to return. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>; get(params: Params$Resource$Projects$Brokers$V2$Service_instances$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>): void; get(params: Params$Resource$Projects$Brokers$V2$Service_instances$Get, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>): void; get(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance>): void; /** * servicebroker.projects.brokers.v2.service_instances.getLast_operation * @desc Returns the state of the last operation for the service instance. Only last (or current) operation can be polled. * @alias servicebroker.projects.brokers.v2.service_instances.getLast_operation * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.instanceId The instance id for which to return the last operation status. * @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value. * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. * @param {string=} params.planId Plan id. * @param {string=} params.serviceId Service id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ getLast_operation(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1alpha1__Operation>; getLast_operation(params: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__Operation>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__Operation>): void; getLast_operation(params: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__Operation>): void; getLast_operation(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__Operation>): void; /** * servicebroker.projects.brokers.v2.service_instances.patch * @desc Updates an existing service instance. See CreateServiceInstance for possible response codes. * @alias servicebroker.projects.brokers.v2.service_instances.patch * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. * @param {string} params.instance_id The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. * @param {().GoogleCloudServicebrokerV1alpha1__ServiceInstance} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse>; patch(params: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse>): void; patch(params: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse>): void; patch(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse>): void; } interface Params$Resource$Projects$Brokers$V2$Service_instances$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous. */ acceptsIncomplete?: boolean; /** * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ instance_id?: string; /** * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. */ parent?: string; /** * Request body metadata */ requestBody?: Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance; } interface Params$Resource$Projects$Brokers$V2$Service_instances$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * See CreateServiceInstanceRequest for details. */ acceptsIncomplete?: boolean; /** * The instance id to deprovision. */ instanceId?: string; /** * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. */ parent?: string; /** * The plan id of the service instance. */ planId?: string; /** * The service id of the service instance. */ serviceId?: string; } interface Params$Resource$Projects$Brokers$V2$Service_instances$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The resource name of the instance to return. */ name?: string; } interface Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The instance id for which to return the last operation status. */ instanceId?: string; /** * If `operation` was returned during mutation operation, this field must be populated with the provided value. */ operation?: string; /** * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. */ parent?: string; /** * Plan id. */ planId?: string; /** * Service id. */ serviceId?: string; } interface Params$Resource$Projects$Brokers$V2$Service_instances$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * See CreateServiceInstanceRequest for details. */