@datafire/google_serviceuser
Client library for Service User
Installation and Usage
npm install --save @datafire/google_serviceuser
let google_serviceuser = require('@datafire/google_serviceuser').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.
Actions
oauthCallback
Exchange the code passed to your redirect URI for an access_token
google_serviceuser.oauthCallback({
"code": ""
}, context)
Input
- input
object
- code required
string
- code required
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
oauthRefresh
Exchange a refresh_token for an access_token
google_serviceuser.oauthRefresh(null, context)
Input
This action has no parameters
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
services.search
Search available services.
When no filter is specified, returns all accessible services. For authenticated users, also returns all services the calling user has "servicemanagement.services.bind" permission for.
google_serviceuser.services.search({}, context)
Input
- input
object
- pageSize
integer
: Requested size of the next page of data. - pageToken
string
: Token identifying which result to start with; returned by a previous list - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - bearer_token
string
: OAuth bearer token. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - pp
boolean
: Pretty-print response. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart"). - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart").
- pageSize
Output
- output SearchServicesResponse
projects.services.disable
Disable a service so it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks.
Operation<response: google.protobuf.Empty>
google_serviceuser.projects.services.disable({
"name": ""
}, context)
Input
- input
object
- body DisableServiceRequest
- name required
string
: Name of the consumer and the service to disable for that consumer. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - bearer_token
string
: OAuth bearer token. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - pp
boolean
: Pretty-print response. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart"). - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart").
Output
- output Operation
projects.services.enable
Enable a service so it can be used with a project. See Cloud Auth Guide for more information.
Operation<response: google.protobuf.Empty>
google_serviceuser.projects.services.enable({
"name": ""
}, context)
Input
- input
object
- body EnableServiceRequest
- name required
string
: Name of the consumer and the service to enable for that consumer. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - bearer_token
string
: OAuth bearer token. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - pp
boolean
: Pretty-print response. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart"). - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart").
Output
- output Operation
projects.services.list
List enabled services for the specified consumer.
google_serviceuser.projects.services.list({
"parent": ""
}, context)
Input
- input
object
- pageSize
integer
: Requested size of the next page of data. - pageToken
string
: Token identifying which result to start with; returned by a previous list - parent required
string
: List enabled services for the specified parent. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - bearer_token
string
: OAuth bearer token. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
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. - oauth_token
string
: OAuth 2.0 token for the current user. - pp
boolean
: Pretty-print response. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart"). - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart").
- pageSize
Output
- output ListEnabledServicesResponse
Definitions
Api
- Api
object
: Api is a light-weight descriptor for an API Interface.- methods
array
: The methods of this interface, in unspecified order.- items Method
- mixins
array
: Included interfaces. See Mixin.- items Mixin
- name
string
: The fully qualified name of this interface, including package name - options
array
: Any metadata attached to the interface.- items Option
- sourceContext SourceContext
- syntax
string
(values: SYNTAX_PROTO2, SYNTAX_PROTO3): The source syntax of the service. - version
string
: A version string for this interface. If specified, must have the form
- methods
AuthProvider
- AuthProvider
object
: Configuration for an anthentication provider, including support for- audiences
string
: The list of JWT - authorizationUrl
string
: Redirect URL if JWT token is required but no present or is expired. - id
string
: The unique identifier of the auth provider. It will be referred to by - issuer
string
: Identifies the principal that issued the JWT. See - jwksUri
string
: URL of the provider's public key set to validate signature of the JWT. See
- audiences
AuthRequirement
- AuthRequirement
object
: User-defined authentication requirements, including support for- audiences
string
: NOTE: This will be deprecated soon, once AuthProvider.audiences is - providerId
string
: id from authentication provider.
- audiences
Authentication
- Authentication
object
:Authentication
defines the authentication configuration for an API.- providers
array
: Defines a set of authentication providers that a service supports.- items AuthProvider
- rules
array
: A list of authentication rules that apply to individual API methods.- items AuthenticationRule
- providers
AuthenticationRule
- AuthenticationRule
object
: Authentication rules for the service.- allowWithoutCredential
boolean
: If true, the service accepts API keys without any other credential. - customAuth CustomAuthRequirements
- oauth OAuthRequirements
- requirements
array
: Requirements for additional authentication providers.- items AuthRequirement
- selector
string
: Selects the methods to which this rule applies.
- allowWithoutCredential
AuthorizationConfig
- AuthorizationConfig
object
: Configuration of authorization.- provider
string
: The name of the authorization provider, such as
- provider
Backend
- Backend
object
:Backend
defines the backend configuration for a service.- rules
array
: A list of API backend rules that apply to individual API methods.- items BackendRule
- rules
BackendRule
- BackendRule
object
: A backend rule provides configuration for an individual API element.- address
string
: The address of the API backend. - deadline
number
: The number of seconds to wait for a response from a request. The default - minDeadline
number
: Minimum deadline in seconds needed for this method. Calls having deadline - selector
string
: Selects the methods to which this rule applies.
- address
Billing
- Billing
object
: Billing related configuration of the service.- consumerDestinations
array
: Billing configurations for sending metrics to the consumer project.- items BillingDestination
- consumerDestinations
BillingDestination
- BillingDestination
object
: Configuration of a specific billing destination (Currently only support- metrics
array
: Names of the metrics to report to this billing destination.- items
string
- items
- monitoredResource
string
: The monitored resource type. The type must be defined in
- metrics
Context
- Context
object
:Context
defines which contexts an API requests.- rules
array
: A list of RPC context rules that apply to individual API methods.- items ContextRule
- rules
ContextRule
- ContextRule
object
: A context rule provides information about the context for an individual API- allowedRequestExtensions
array
: A list of full type names or extension IDs of extensions allowed in grpc- items
string
- items
- allowedResponseExtensions
array
: A list of full type names or extension IDs of extensions allowed in grpc- items
string
- items
- provided
array
: A list of full type names of provided contexts.- items
string
- items
- requested
array
: A list of full type names of requested contexts.- items
string
- items
- selector
string
: Selects the methods to which this rule applies.
- allowedRequestExtensions
Control
- Control
object
: Selects and configures the service controller used by the service. The- environment
string
: The service control environment to use. If empty, no control plane
- environment
CustomAuthRequirements
- CustomAuthRequirements
object
: Configuration for a custom authentication provider.- provider
string
: A configuration string containing connection information for the
- provider
CustomError
- CustomError
object
: Customize service error responses. For example, list any service- rules
array
: The list of custom error rules that apply to individual API messages.- items CustomErrorRule
- types
array
: The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.- items
string
- items
- rules
CustomErrorRule
- CustomErrorRule
object
: A custom error rule.- isErrorType
boolean
: Mark this message as possible payload in error response. Otherwise, - selector
string
: Selects messages to which this rule applies.
- isErrorType
CustomHttpPattern
- CustomHttpPattern
object
: A custom pattern is used for defining custom HTTP verb.- kind
string
: The name of this custom HTTP verb. - path
string
: The path matched by this custom verb.
- kind
DisableServiceRequest
- DisableServiceRequest
object
: Request message for DisableService method.
Documentation
- Documentation
object
:Documentation
provides the information for describing a service.- documentationRootUrl
string
: The URL to the root of documentation. - overview
string
: Declares a single overview page. For example: - pages
array
: The top level pages for the documentation set.- items Page
- rules
array
: A list of documentation rules that apply to individual API elements.- items DocumentationRule
- summary
string
: A short summary of what the service does. Can only be provided by
- documentationRootUrl
DocumentationRule
- DocumentationRule
object
: A documentation rule provides information about individual API elements.- deprecationDescription
string
: Deprecation description of the selected element(s). It can be provided if an - description
string
: Description of the selected API(s). - selector
string
: The selector is a comma-separated list of patterns. Each pattern is a
- deprecationDescription
EnableServiceRequest
- EnableServiceRequest
object
: Request message for EnableService method.
Endpoint
- Endpoint
object
:Endpoint
describes a network endpoint that serves a set of APIs.- aliases
array
: DEPRECATED: This field is no longer supported. Instead of using aliases,- items
string
- items
- allowCors
boolean
: Allowing - features
array
: The list of features enabled on this endpoint.- items
string
- items
- name
string
: The canonical name of this endpoint. - target
string
: The specification of an Internet routable address of API frontend that will
- aliases
Enum
- Enum
object
: Enum type definition.- enumvalue
array
: Enum value definitions.- items EnumValue
- name
string
: Enum type name. - options
array
: Protocol buffer options.- items Option
- sourceContext SourceContext
- syntax
string
(values: SYNTAX_PROTO2, SYNTAX_PROTO3): The source syntax.
- enumvalue
EnumValue
- EnumValue
object
: Enum value definition.- name
string
: Enum value name. - number
integer
: Enum value number. - options
array
: Protocol buffer options.- items Option
- name
Experimental
- Experimental
object
: Experimental service configuration. These configuration options can- authorization AuthorizationConfig
Field
- Field
object
: A single field of a message type.- cardinality
string
(values: CARDINALITY_UNKNOWN, CARDINALITY_OPTIONAL, CARDINALITY_REQUIRED, CARDINALITY_REPEATED): The field cardinality. - defaultValue
string
: The string value of the default value of this field. Proto2 syntax only. - jsonName
string
: The field JSON name. - kind
string
(values: TYPE_UNKNOWN, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT64, TYPE_UINT64, TYPE_INT32, TYPE_FIXED64, TYPE_FIXED32, TYPE_BOOL, TYPE_STRING, TYPE_GROUP, TYPE_MESSAGE, TYPE_BYTES, TYPE_UINT32, TYPE_ENUM, TYPE_SFIXED32, TYPE_SFIXED64, TYPE_SINT32, TYPE_SINT64): The field type. - name
string
: The field name. - number
integer
: The field number. - oneofIndex
integer
: The index of the field type inType.oneofs
, for message or enumeration - options
array
: The protocol buffer options.- items Option
- packed
boolean
: Whether to use alternative packed wire representation. - typeUrl
string
: The field type URL, without the scheme, for message or enumeration
- cardinality
Http
- Http
object
: Defines the HTTP configuration for an API service. It contains a list of- fullyDecodeReservedExpansion
boolean
: When set to true, URL path parmeters will be fully URI-decoded except in - rules
array
: A list of HTTP configuration rules that apply to individual API methods.- items HttpRule
- fullyDecodeReservedExpansion
HttpRule
- HttpRule
object
:HttpRule
defines the mapping of an RPC method to one or more HTTP- additionalBindings
array
: Additional HTTP bindings for the selector. Nested bindings must- items HttpRule
- body
string
: The name of the request field whose value is mapped to the HTTP body, or - custom CustomHttpPattern
- delete
string
: Used for deleting a resource. - get
string
: Used for listing and getting information about resources. - mediaDownload MediaDownload
- mediaUpload MediaUpload
- patch
string
: Used for updating a resource. - post
string
: Used for creating a resource. - put
string
: Used for updating a resource. - selector
string
: Selects methods to which this rule applies.
- additionalBindings
LabelDescriptor
- LabelDescriptor
object
: A description of a label.- description
string
: A human-readable description for the label. - key
string
: The label key. - valueType
string
(values: STRING, BOOL, INT64): The type of data that can be assigned to the label.
- description
ListEnabledServicesResponse
- ListEnabledServicesResponse
object
: Response message forListEnabledServices
method.- nextPageToken
string
: Token that can be passed toListEnabledServices
to resume a paginated - services
array
: Services enabled for the specified parent.- items PublishedService
- nextPageToken
LogDescriptor
- LogDescriptor
object
: A description of a log type. Example in YAML format:- description
string
: A human-readable description of this log. This information appears in - displayName
string
: The human-readable name for this log. This information appears on - labels
array
: The set of labels that are available to describe a specific log entry.- items LabelDescriptor
- name
string
: The name of the log. It must be less than 512 characters long and can
- description
Logging
- Logging
object
: Logging configuration of the service.- consumerDestinations
array
: Logging configurations for sending logs to the consumer project.- items LoggingDestination
- producerDestinations
array
: Logging configurations for sending logs to the producer project.- items LoggingDestination
- consumerDestinations
LoggingDestination
- LoggingDestination
object
: Configuration of a specific logging destination (the producer project- logs
array
: Names of the logs to be sent to this destination. Each name must- items
string
- items
- monitoredResource
string
: The monitored resource type. The type must be defined in the
- logs
MediaDownload
- MediaDownload
object
: Defines the Media configuration for a service in case of a download.- completeNotification
boolean
: A boolean that determines whether a notification for the completion of a - downloadService
string
: DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED. - dropzone
string
: Name of the Scotty dropzone to use for the current API. - enabled
boolean
: Whether download is enabled. - maxDirectDownloadSize
string
: Optional maximum acceptable size for direct download. - useDirectDownload
boolean
: A boolean that determines if direct download from ESF should be used for
- completeNotification
MediaUpload
- MediaUpload
object
: Defines the Media configuration for a service in case of an upload.- completeNotification
boolean
: A boolean that determines whether a notification for the completion of an - dropzone
string
: Name of the Scotty dropzone to use for the current API. - enabled
boolean
: Whether upload is enabled. - maxSize
string
: Optional maximum acceptable size for an upload. - mimeTypes
array
: An array of mimetype patterns. Esf will only accept uploads that match one- items
string
- items
- progressNotification
boolean
: Whether to receive a notification for progress changes of media upload. - startNotification
boolean
: Whether to receive a notification on the start of media upload. - uploadService
string
: DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
- completeNotification
Method
- Method
object
: Method represents a method of an API interface.- name
string
: The simple name of this method. - options
array
: Any metadata attached to the method.- items Option
- requestStreaming
boolean
: If true, the request is streamed. - requestTypeUrl
string
: A URL of the input message type. - responseStreaming
boolean
: If true, the response is streamed. - responseTypeUrl
string
: The URL of the output message type. - syntax
string
(values: SYNTAX_PROTO2, SYNTAX_PROTO3): The source syntax of this method.
- name
MetricDescriptor
- MetricDescriptor
object
: Defines a metric type and its schema. Once a metric descriptor is created,- description
string
: A detailed description of the metric, which can be used in documentation. - displayName
string
: A concise name for the metric, which can be displayed in user interfaces. - labels
array
: The set of labels that can be used to describe a specific- items LabelDescriptor
- metricKind
string
(values: METRIC_KIND_UNSPECIFIED, GAUGE, DELTA, CUMULATIVE): Whether the metric records instantaneous values, changes to a value, etc. - name
string
: The resource name of the metric descriptor. - type
string
: The metric type, including its DNS name prefix. The type is not - unit
string
: The unit in which the metric value is reported. It is only applicable - valueType
string
(values: VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY): Whether the measurement is an integer, a floating-point number, etc.
- description
MetricRule
- MetricRule
object
: Bind API methods to metrics. Binding a method to a metric causes that- metricCosts
object
: Metrics to update when the selected methods are called, and the associated - selector
string
: Selects the methods to which this rule applies.
- metricCosts
Mixin
- Mixin
object
: Declares an API Interface to be included in this interface. The including- name
string
: The fully qualified name of the interface which is included. - root
string
: If non-empty specifies a path under which inherited HTTP paths
- name
MonitoredResourceDescriptor
- MonitoredResourceDescriptor
object
: An object that describes the schema of a MonitoredResource object using a- description
string
: Optional. A detailed description of the monitored resource type that might - displayName
string
: Optional. A concise name for the monitored resource type that might be - labels
array
: Required. A set of labels used to describe instances of this monitored- items LabelDescriptor
- name
string
: Optional. The resource name of the monitored resource descriptor: - type
string
: Required. The monitored resource type. For example, the type
- description
Monitoring
- Monitoring
object
: Monitoring configuration of the service.- consumerDestinations
array
: Monitoring configurations for sending metrics to the consumer project.- items MonitoringDestination
- producerDestinations
array
: Monitoring configurations for sending metrics to the producer project.- items MonitoringDestination
- consumerDestinations
MonitoringDestination
- MonitoringDestination
object
: Configuration of a specific monitoring destination (the producer project- metrics
array
: Names of the metrics to report to this monitoring destination.- items
string
- items
- monitoredResource
string
: The monitored resource type. The type must be defined in
- metrics
OAuthRequirements
- OAuthRequirements
object
: OAuth scopes are a way to define data and permissions on data. For example,- canonicalScopes
string
: The list of publicly documented OAuth scopes that are allowed access. An
- canonicalScopes
Operation
- Operation
object
: This resource represents a long-running operation that is the result of a- done
boolean
: If the value isfalse
, it means the operation is still in progress. - error Status
- metadata
object
: Service-specific metadata associated with the operation. It typically - name
string
: The server-assigned name, which is only unique within the same service that - response
object
: The normal response of the operation in case of success. If the original
- done
OperationMetadata
- OperationMetadata
object
: The metadata associated with a long running operation resource.- progressPercentage
integer
: Percentage of completion of this operation, ranging from 0 to 100. - resourceNames
array
: The full name of the resources that this operation is directly- items
string
- items
- startTime
string
: The start time of the operation. - steps
array
: Detailed status information for each step. The order is undetermined.- items Step
- progressPercentage
Option
- Option
object
: A protocol buffer option, which can be attached to a message, field,- name
string
: The option's name. For protobuf built-in options (options defined in - value
object
: The option's value packed in an Any message. If the value is a primitive,
- name
Page
- Page
object
: Represents a documentation page. A page can contain subpages to represent- content
string
: The Markdown content of the page. You can use(== include {path} ==)
- name
string
: The name of the page. It will be used as an identity of the page to - subpages
array
: Subpages of this page. The order of subpages specified here will be- items Page
- content
PublishedService
- PublishedService
object
: The published version of a Service that is managed by- name
string
: The resource name of the service. - service Service
- name
Quota
- Quota
object
: Quota configuration helps to achieve fairness and budgeting in service- limits
array
: List ofQuotaLimit
definitions for the service.- items QuotaLimit
- metricRules
array
: List ofMetricRule
definitions, each one mapping a selected method to one- items MetricRule
- limits
QuotaLimit
- QuotaLimit
object
:QuotaLimit
defines a specific limit that applies over a specified duration- defaultLimit
string
: Default number of tokens that can be consumed during the specified - description
string
: Optional. User-visible, extended description for this quota limit. - displayName
string
: User-visible display name for this limit. - duration
string
: Duration of this limit in textual notation. Example: "100s", "24h", "1d". - freeTier
string
: Free tier value displayed in the Developers Console for this limit. - maxLimit
string
: Maximum number of tokens that can be consumed during the specified - metric
string
: The name of the metric this quota limit applies to. The quota limits with - name
string
: Name of the quota limit. - unit
string
: Specify the unit of the quota limit. It uses the same syntax as - values
object
: Tiered limit values. You must specify this as a key:value pair, with an
- defaultLimit
SearchServicesResponse
- SearchServicesResponse
object
: Response message for SearchServices method.- nextPageToken
string
: Token that can be passed toListAvailableServices
to resume a paginated - services
array
: Services available publicly or available to the authenticated caller.- items PublishedService
- nextPageToken
Service
- Service
object
:Service
is the root object of Google service configuration schema. It- apis
array
: A list of API interfaces exported by this service. Only thename
field- items Api
- authentication Authentication
- backend Backend
- billing Billing
- configVersion
integer
: The semantic version of the service configuration. The config version - context Context
- control Control
- customError CustomError
- documentation Documentation
- endpoints
array
: Configuration for network endpoints. If this is empty, then an endpoint- items Endpoint
- enums
array
: A list of all enum types included in this API service. Enums- items Enum
- experimental Experimental
- http Http
- id
string
: A unique ID for a specific instance of this message, typically assigned - logging Logging
- logs
array
: Defines the logs used by this service.- items LogDescriptor
- metrics
array
: Defines the metrics used by this service.- items MetricDescriptor
- monitoredResources
array
: Defines the monitored resources used by this service. This is required - monitoring Monitoring
- name
string
: The DNS address at which this service is available, - producerProjectId
string
: The Google project that owns this service. - quota Quota
- sourceInfo SourceInfo
- systemParameters SystemParameters
- systemTypes
array
: A list of all proto message types included in this API service.- items Type
- title
string
: The product title for this service. - types
array
: A list of all proto message types included in this API service.- items Type
- usage Usage
- apis
SourceContext
- SourceContext
object
:SourceContext
represents information about the source of a- fileName
string
: The path-qualified name of the .proto file that contained the associated
- fileName
SourceInfo
- SourceInfo
object
: Source information used to create a Service Config- sourceFiles
array
: All files used during config generation.- items
object
- items
- sourceFiles
Status
- Status
object
: TheStatus
type defines a logical error model that is suitable for different- code
integer
: The status code, which should be an enum value of google.rpc.Code. - details
array
: A list of messages that carry the error details. There is a common set of- items
object
- items
- message
string
: A developer-facing error message, which should be in English. Any
- code
Step
- Step
object
: Represents the status of one operation step.- description
string
: The short description of the step. - status
string
(values: STATUS_UNSPECIFIED, DONE, NOT_STARTED, IN_PROGRESS, FAILED, CANCELLED): The status code.
- description
SystemParameter
- SystemParameter
object
: Define a parameter's name and location. The parameter may be passed as either- httpHeader
string
: Define the HTTP header name to use for the parameter. It is case - name
string
: Define the name of the parameter, such as "api_key" . It is case sensitive. - urlQueryParameter
string
: Define the URL query parameter name to use for the parameter. It is case
- httpHeader
SystemParameterRule
- SystemParameterRule
object
: Define a system parameter rule mapping system parameter definitions to- parameters
array
: Define parameters. Multiple names may be defined for a parameter.- items SystemParameter
- selector
string
: Selects the methods to which this rule applies. Use '*' to indicate all
- parameters
SystemParameters
- SystemParameters
object
: ### System parameter configuration- rules
array
: Define system parameters.- items SystemParameterRule
- rules
Type
- Type
object
: A protocol buffer message type.- fields
array
: The list of fields.- items Field
- name
string
: The fully qualified message name. - oneofs
array
: The list of types appearing inoneof
definitions in this type.- items
string
- items
- options
array
: The protocol buffer options.- items Option
- sourceContext SourceContext
- syntax
string
(values: SYNTAX_PROTO2, SYNTAX_PROTO3): The source syntax.
- fields
Usage
- Usage
object
: Configuration controlling usage of a service.- producerNotificationChannel
string
: The full resource name of a channel used for sending notifications to the - requirements
array
: Requirements that must be satisfied before a consumer project can use the- items
string
- items
- rules
array
: A list of usage rules that apply to individual API methods.- items UsageRule
- producerNotificationChannel
UsageRule
- UsageRule
object
: Usage configuration rules for the service.- allowUnregisteredCalls
boolean
: If true, the selected method allows unregistered calls, e.g. calls - selector
string
: Selects the methods to which this rule applies. Use '*' to indicate all - skipServiceControl
boolean
: If true, the selected method should skip service control and the control
- allowUnregisteredCalls