ServiceManagement

import { ServiceManagement } from "https://googleapis.deno.dev/v1/servicemanagement:v1.ts";

Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.

class ServiceManagement {

constructor(client?: CredentialsClient, baseUrl?: string);

async operationsGet(name: string): Promise<Operation>;

async operationsList(opts?: OperationsListOptions): Promise<ListOperationsResponse>;

async servicesConfigsCreate(serviceName: string, req: Service): Promise<Service>;

async servicesConfigsGet(

configId: string,

serviceName: string,

opts?: ServicesConfigsGetOptions,

): Promise<Service>;

async servicesConfigsList(serviceName: string, opts?: ServicesConfigsListOptions): Promise<ListServiceConfigsResponse>;

async servicesConfigsSubmit(serviceName: string, req: SubmitConfigSourceRequest): Promise<Operation>;

async servicesConsumersGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async servicesConsumersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async servicesConsumersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async servicesCreate(req: ManagedService): Promise<Operation>;

async servicesDelete(serviceName: string): Promise<Operation>;

async servicesGenerateConfigReport(req: GenerateConfigReportRequest): Promise<GenerateConfigReportResponse>;

async servicesGet(serviceName: string): Promise<ManagedService>;

async servicesGetConfig(serviceName: string, opts?: ServicesGetConfigOptions): Promise<Service>;

async servicesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async servicesList(opts?: ServicesListOptions): Promise<ListServicesResponse>;

async servicesRolloutsCreate(serviceName: string, req: Rollout): Promise<Operation>;

async servicesRolloutsGet(rolloutId: string, serviceName: string): Promise<Rollout>;

async servicesRolloutsList(serviceName: string, opts?: ServicesRolloutsListOptions): Promise<ListServiceRolloutsResponse>;

async servicesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async servicesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async servicesUndelete(serviceName: string): Promise<Operation>;

}

§Constructors

new ServiceManagement(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

operationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

operationsList(opts?: OperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists service operations that match the specified filter in the request.

servicesConfigsCreate(serviceName: string, req: Service): Promise<Service>

[src]

Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

servicesConfigsGet(configId: string, serviceName: string, opts?: ServicesConfigsGetOptions): Promise<Service>

[src]

Gets a service configuration (version) for a managed service.

@param configId

Required. The id of the service configuration resource. This field must be specified for the server to return all fields, including SourceInfo.

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

servicesConfigsList(serviceName: string, opts?: ServicesConfigsListOptions): Promise<ListServiceConfigsResponse>

[src]

Lists the history of the service configuration for a managed service, from the newest to the oldest.

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

servicesConfigsSubmit(serviceName: string, req: SubmitConfigSourceRequest): Promise<Operation>

[src]

Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout. Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually. Operation

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

servicesConsumersGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

servicesConsumersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

servicesConsumersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

servicesCreate(req: ManagedService): Promise<Operation>

[src]

Creates a new managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion. One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project. Operation

servicesDelete(serviceName: string): Promise<Operation>

[src]

Deletes a managed service. This method will change the service to the Soft-Delete state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted. Operation

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

servicesGenerateConfigReport(req: GenerateConfigReportRequest): Promise<GenerateConfigReportResponse>

[src]

Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.

servicesGet(serviceName: string): Promise<ManagedService>

[src]

Gets a managed service. Authentication is required unless the service is public.

@param serviceName

Required. The name of the service. See the ServiceManager overview for naming requirements. For example: example.googleapis.com.

servicesGetConfig(serviceName: string, opts?: ServicesGetConfigOptions): Promise<Service>

[src]

Gets a service configuration (version) for a managed service.

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

servicesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

servicesList(opts?: ServicesListOptions): Promise<ListServicesResponse>

[src]

Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.

servicesRolloutsCreate(serviceName: string, req: Rollout): Promise<Operation>

[src]

Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

servicesRolloutsGet(rolloutId: string, serviceName: string): Promise<Rollout>

[src]

Gets a service configuration rollout.

@param rolloutId

Required. The id of the rollout resource.

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

servicesRolloutsList(serviceName: string, opts?: ServicesRolloutsListOptions): Promise<ListServiceRolloutsResponse>

[src]

Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

servicesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

servicesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

servicesUndelete(serviceName: string): Promise<Operation>

[src]

Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days. Operation

@param serviceName

Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.