servicemanagement/v1 library
Service Management API - v1
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.
For more information, see cloud.google.com/service-management/
Create an instance of ServiceManagementApi to access these resources:
Classes
- Advice
- Generated advice about this change, used for providing more information about how a change will affect the existing service.
- Api
- Api is a light-weight descriptor for an API Interface.
- AuditConfig
- Specifies the audit configuration for a service.
- Authentication
-
Authentication
defines the authentication configuration for API methods provided by an API service. - AuthenticationRule
- Authentication rules for the service.
- AuthProvider
- Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
- Backend
-
Backend
defines the backend configuration for a service. - BackendRule
- A backend rule provides configuration for an individual API element.
- Billing
- Billing related configuration of the service.
- BillingDestination
- Configuration of a specific billing destination (Currently only support bill against consumer project).
- Binding
-
Associates
members
, or principals, with arole
. - ChangeReport
- Change report associated with a particular service configuration.
- ClientLibrarySettings
- Details about how and where to publish client libraries.
- CommonLanguageSettings
- Required information for every language.
- ConfigChange
- Output generated from semantically comparing two versions of a service configuration.
- ConfigFile
- Generic specification of a source configuration file
- ConfigSource
-
Represents a source file which is used to generate the service configuration
defined by
google.api.Service
. - Context
-
Context
defines which contexts an API requests. - ContextRule
- A context rule provides information about the context for an individual API element.
- Control
- Selects and configures the service controller used by the service.
- CppSettings
- Settings for C++ client libraries.
- CustomError
- Customize service error responses.
- CustomErrorRule
- A custom error rule.
- CustomHttpPattern
- A custom pattern is used for defining custom HTTP verb.
- Diagnostic
- Represents a diagnostic message (error or warning)
- Documentation
-
Documentation
provides the information for describing a service. - DotnetSettings
- Settings for Dotnet client libraries.
- Enum
- Enum type definition.
- EnumValue
- Enum value definition.
- Field
- A single field of a message type.
- FieldPolicy
- Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies.
- GenerateConfigReportRequest
- Request message for GenerateConfigReport method.
- GenerateConfigReportResponse
- Response message for GenerateConfigReport method.
- GetIamPolicyRequest
-
Request message for
GetIamPolicy
method. - GoSettings
- Settings for Go client libraries.
- Http
- Defines the HTTP configuration for an API service.
- HttpRule
- gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC
- JavaSettings
- Settings for Java client libraries.
- ListOperationsResponse
- The response message for Operations.ListOperations.
- ListServiceConfigsResponse
- Response message for ListServiceConfigs method.
- ListServiceRolloutsResponse
- Response message for ListServiceRollouts method.
- ListServicesResponse
-
Response message for
ListServices
method. - LogDescriptor
- A description of a log type.
- Logging
- Logging configuration of the service.
- LoggingDestination
- Configuration of a specific logging destination (the producer project or the consumer project).
- LongRunning
- Describes settings to use when generating API methods that use the long-running operation pattern.
- ManagedService
- The full representation of a Service that is managed by Google Service Management.
- Method
- Method represents a method of an API interface.
- MethodPolicy
- Defines policies applying to an RPC method.
- MethodSettings
- Describes the generator configuration for a method.
- MetricDescriptor
- Defines a metric type and its schema.
- MetricDescriptorMetadata
- Additional annotations that can be used to guide the usage of a metric.
- MonitoredResourceDescriptor
- An object that describes the schema of a MonitoredResource object using a type name and a set of labels.
- Monitoring
- Monitoring configuration of the service.
- NodeSettings
- Settings for Node client libraries.
- Operation
- This resource represents a long-running operation that is the result of a network API call.
- OperationsResource
- Page
- Represents a documentation page.
- PhpSettings
- Settings for Php client libraries.
- Policy
- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
- Publishing
- This message configures the settings for publishing Google Cloud Client libraries generated from the service config.
- PythonSettings
- Settings for Python client libraries.
- Quota
- Quota configuration helps to achieve fairness and budgeting in service usage.
- Rollout
- A rollout resource that defines how service configuration versions are pushed to control plane systems.
- RubySettings
- Settings for Ruby client libraries.
- Service
-
Service
is the root object of Google API service configuration (service config). - ServiceManagementApi
- 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.
- ServicesConfigsResource
- ServicesConsumersResource
- ServicesResource
- ServicesRolloutsResource
- SetIamPolicyRequest
-
Request message for
SetIamPolicy
method. - SourceInfo
- Source information used to create a Service Config
- SubmitConfigSourceRequest
- Request message for SubmitConfigSource method.
- SystemParameter
- Define a parameter's name and location.
- SystemParameterRule
- Define a system parameter rule mapping system parameter definitions to methods.
- SystemParameters
- System parameter configuration A system parameter is a special kind of
- TrafficPercentStrategy
- Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions.
- Type
- A protocol buffer message type.
- Usage
- Configuration controlling usage of a service.
Typedefs
- AuditLogConfig = $AuditLogConfig
- Provides the configuration for logging a type of permissions.
- AuthRequirement = $AuthRequirement
- User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
- DeleteServiceStrategy = $Empty
- Strategy used to delete a service.
- DocumentationRule = $DocumentationRule
- A documentation rule provides information about individual API elements.
- Endpoint = $Endpoint
-
Endpoint
describes a network address of a service that serves a set of APIs. - Expr = $Expr
- Represents a textual expression in the Common Expression Language (CEL) syntax.
- GetPolicyOptions = $GetPolicyOptions
- Encapsulates settings provided to GetIamPolicy.
- JwtLocation = $JwtLocation
- Specifies a location to extract JWT from an API request.
- LabelDescriptor = $LabelDescriptor
- A description of a label.
- MetricRule = $MetricRule
- Bind API methods to metrics.
- Mixin = $Mixin
- Declares an API Interface to be included in this interface.
- MonitoringDestination = $MonitoringDestination
- Configuration of a specific monitoring destination (the producer project or the consumer project).
- OAuthRequirements = $OAuthRequirements
- OAuth scopes are a way to define data and permissions on data.
- Option = $Option
- A protocol buffer option, which can be attached to a message, field, enumeration, etc.
- QuotaLimit = $QuotaLimit
-
QuotaLimit
defines a specific limit that applies over a specified duration for a limit type. - SourceContext = $SourceContext
-
SourceContext
represents information about the source of a protobuf element, like the file in which it is defined. - Status = $Status
-
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. - TestIamPermissionsRequest = $TestIamPermissionsRequest00
-
Request message for
TestIamPermissions
method. - TestIamPermissionsResponse = $PermissionsResponse
-
Response message for
TestIamPermissions
method. - UsageRule = $UsageRule
- Usage configuration rules for the service.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.