Home | History | Annotate | Download | only in dyn
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="servicemanagement_v1.html">Google Service Management API</a> . <a href="servicemanagement_v1.services.html">services</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="servicemanagement_v1.services.configs.html">configs()</a></code>
     79 </p>
     80 <p class="firstline">Returns the configs Resource.</p>
     81 
     82 <p class="toc_element">
     83   <code><a href="servicemanagement_v1.services.consumers.html">consumers()</a></code>
     84 </p>
     85 <p class="firstline">Returns the consumers Resource.</p>
     86 
     87 <p class="toc_element">
     88   <code><a href="servicemanagement_v1.services.rollouts.html">rollouts()</a></code>
     89 </p>
     90 <p class="firstline">Returns the rollouts Resource.</p>
     91 
     92 <p class="toc_element">
     93   <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
     94 <p class="firstline">Creates a new managed service.</p>
     95 <p class="toc_element">
     96   <code><a href="#delete">delete(serviceName, x__xgafv=None)</a></code></p>
     97 <p class="firstline">Deletes a managed service. This method will change the service to the</p>
     98 <p class="toc_element">
     99   <code><a href="#disable">disable(serviceName, body, x__xgafv=None)</a></code></p>
    100 <p class="firstline">Disables a service for a project, so it can no longer be</p>
    101 <p class="toc_element">
    102   <code><a href="#enable">enable(serviceName, body, x__xgafv=None)</a></code></p>
    103 <p class="firstline">Enables a service for a project, so it can be used</p>
    104 <p class="toc_element">
    105   <code><a href="#generateConfigReport">generateConfigReport(body, x__xgafv=None)</a></code></p>
    106 <p class="firstline">Generates and returns a report (errors, warnings and changes from</p>
    107 <p class="toc_element">
    108   <code><a href="#get">get(serviceName, x__xgafv=None)</a></code></p>
    109 <p class="firstline">Gets a managed service. Authentication is required unless the service is</p>
    110 <p class="toc_element">
    111   <code><a href="#getConfig">getConfig(serviceName, configId=None, x__xgafv=None, view=None)</a></code></p>
    112 <p class="firstline">Gets a service configuration (version) for a managed service.</p>
    113 <p class="toc_element">
    114   <code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
    115 <p class="firstline">Gets the access control policy for a resource.</p>
    116 <p class="toc_element">
    117   <code><a href="#list">list(producerProjectId=None, pageSize=None, pageToken=None, consumerId=None, x__xgafv=None)</a></code></p>
    118 <p class="firstline">Lists managed services.</p>
    119 <p class="toc_element">
    120   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
    121 <p class="firstline">Retrieves the next page of results.</p>
    122 <p class="toc_element">
    123   <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
    124 <p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
    125 <p class="toc_element">
    126   <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
    127 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
    128 <p class="toc_element">
    129   <code><a href="#undelete">undelete(serviceName, x__xgafv=None)</a></code></p>
    130 <p class="firstline">Revives a previously deleted managed service. The method restores the</p>
    131 <h3>Method Details</h3>
    132 <div class="method">
    133     <code class="details" id="create">create(body, x__xgafv=None)</code>
    134   <pre>Creates a new managed service.
    135 Please note one producer project can own no more than 20 services.
    136 
    137 Operation<response: ManagedService>
    138 
    139 Args:
    140   body: object, The request body. (required)
    141     The object takes the form of:
    142 
    143 { # The full representation of a Service that is managed by
    144     # Google Service Management.
    145   "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
    146       # for naming requirements.
    147   "producerProjectId": "A String", # ID of the project that produces and owns this service.
    148 }
    149 
    150   x__xgafv: string, V1 error format.
    151     Allowed values
    152       1 - v1 error format
    153       2 - v2 error format
    154 
    155 Returns:
    156   An object of the form:
    157 
    158     { # This resource represents a long-running operation that is the result of a
    159       # network API call.
    160     "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
    161         # programming environments, including REST APIs and RPC APIs. It is used by
    162         # [gRPC](https://github.com/grpc). The error model is designed to be:
    163         #
    164         # - Simple to use and understand for most users
    165         # - Flexible enough to meet unexpected needs
    166         #
    167         # # Overview
    168         #
    169         # The `Status` message contains three pieces of data: error code, error message,
    170         # and error details. The error code should be an enum value of
    171         # google.rpc.Code, but it may accept additional error codes if needed.  The
    172         # error message should be a developer-facing English message that helps
    173         # developers *understand* and *resolve* the error. If a localized user-facing
    174         # error message is needed, put the localized message in the error details or
    175         # localize it in the client. The optional error details may contain arbitrary
    176         # information about the error. There is a predefined set of error detail types
    177         # in the package `google.rpc` that can be used for common error conditions.
    178         #
    179         # # Language mapping
    180         #
    181         # The `Status` message is the logical representation of the error model, but it
    182         # is not necessarily the actual wire format. When the `Status` message is
    183         # exposed in different client libraries and different wire protocols, it can be
    184         # mapped differently. For example, it will likely be mapped to some exceptions
    185         # in Java, but more likely mapped to some error codes in C.
    186         #
    187         # # Other uses
    188         #
    189         # The error model and the `Status` message can be used in a variety of
    190         # environments, either with or without APIs, to provide a
    191         # consistent developer experience across different environments.
    192         #
    193         # Example uses of this error model include:
    194         #
    195         # - Partial errors. If a service needs to return partial errors to the client,
    196         #     it may embed the `Status` in the normal response to indicate the partial
    197         #     errors.
    198         #
    199         # - Workflow errors. A typical workflow has multiple steps. Each step may
    200         #     have a `Status` message for error reporting.
    201         #
    202         # - Batch operations. If a client uses batch request and batch response, the
    203         #     `Status` message should be used directly inside batch response, one for
    204         #     each error sub-response.
    205         #
    206         # - Asynchronous operations. If an API call embeds asynchronous operation
    207         #     results in its response, the status of those operations should be
    208         #     represented directly using the `Status` message.
    209         #
    210         # - Logging. If some API errors are stored in logs, the message `Status` could
    211         #     be used directly after any stripping needed for security/privacy reasons.
    212       "message": "A String", # A developer-facing error message, which should be in English. Any
    213           # user-facing error message should be localized and sent in the
    214           # google.rpc.Status.details field, or localized by the client.
    215       "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    216       "details": [ # A list of messages that carry the error details.  There will be a
    217           # common set of message types for APIs to use.
    218         {
    219           "a_key": "", # Properties of the object. Contains field @type with type URL.
    220         },
    221       ],
    222     },
    223     "done": True or False, # If the value is `false`, it means the operation is still in progress.
    224         # If true, the operation is completed, and either `error` or `response` is
    225         # available.
    226     "response": { # The normal response of the operation in case of success.  If the original
    227         # method returns no data on success, such as `Delete`, the response is
    228         # `google.protobuf.Empty`.  If the original method is standard
    229         # `Get`/`Create`/`Update`, the response should be the resource.  For other
    230         # methods, the response should have the type `XxxResponse`, where `Xxx`
    231         # is the original method name.  For example, if the original method name
    232         # is `TakeSnapshot()`, the inferred response type is
    233         # `TakeSnapshotResponse`.
    234       "a_key": "", # Properties of the object. Contains field @type with type URL.
    235     },
    236     "name": "A String", # The server-assigned name, which is only unique within the same service that
    237         # originally returns it. If you use the default HTTP mapping, the
    238         # `name` should have the format of `operations/some/unique/name`.
    239     "metadata": { # Service-specific metadata associated with the operation.  It typically
    240         # contains progress information and common metadata such as create time.
    241         # Some services might not provide such metadata.  Any method that returns a
    242         # long-running operation should document the metadata type, if any.
    243       "a_key": "", # Properties of the object. Contains field @type with type URL.
    244     },
    245   }</pre>
    246 </div>
    247 
    248 <div class="method">
    249     <code class="details" id="delete">delete(serviceName, x__xgafv=None)</code>
    250   <pre>Deletes a managed service. This method will change the service to the
    251 `Soft-Delete` state for 30 days. Within this period, service producers may
    252 call UndeleteService to restore the service.
    253 After 30 days, the service will be permanently deleted.
    254 
    255 Operation<response: google.protobuf.Empty>
    256 
    257 Args:
    258   serviceName: string, The name of the service.  See the [overview](/service-management/overview)
    259 for naming requirements.  For example: `example.googleapis.com`. (required)
    260   x__xgafv: string, V1 error format.
    261     Allowed values
    262       1 - v1 error format
    263       2 - v2 error format
    264 
    265 Returns:
    266   An object of the form:
    267 
    268     { # This resource represents a long-running operation that is the result of a
    269       # network API call.
    270     "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
    271         # programming environments, including REST APIs and RPC APIs. It is used by
    272         # [gRPC](https://github.com/grpc). The error model is designed to be:
    273         #
    274         # - Simple to use and understand for most users
    275         # - Flexible enough to meet unexpected needs
    276         #
    277         # # Overview
    278         #
    279         # The `Status` message contains three pieces of data: error code, error message,
    280         # and error details. The error code should be an enum value of
    281         # google.rpc.Code, but it may accept additional error codes if needed.  The
    282         # error message should be a developer-facing English message that helps
    283         # developers *understand* and *resolve* the error. If a localized user-facing
    284         # error message is needed, put the localized message in the error details or
    285         # localize it in the client. The optional error details may contain arbitrary
    286         # information about the error. There is a predefined set of error detail types
    287         # in the package `google.rpc` that can be used for common error conditions.
    288         #
    289         # # Language mapping
    290         #
    291         # The `Status` message is the logical representation of the error model, but it
    292         # is not necessarily the actual wire format. When the `Status` message is
    293         # exposed in different client libraries and different wire protocols, it can be
    294         # mapped differently. For example, it will likely be mapped to some exceptions
    295         # in Java, but more likely mapped to some error codes in C.
    296         #
    297         # # Other uses
    298         #
    299         # The error model and the `Status` message can be used in a variety of
    300         # environments, either with or without APIs, to provide a
    301         # consistent developer experience across different environments.
    302         #
    303         # Example uses of this error model include:
    304         #
    305         # - Partial errors. If a service needs to return partial errors to the client,
    306         #     it may embed the `Status` in the normal response to indicate the partial
    307         #     errors.
    308         #
    309         # - Workflow errors. A typical workflow has multiple steps. Each step may
    310         #     have a `Status` message for error reporting.
    311         #
    312         # - Batch operations. If a client uses batch request and batch response, the
    313         #     `Status` message should be used directly inside batch response, one for
    314         #     each error sub-response.
    315         #
    316         # - Asynchronous operations. If an API call embeds asynchronous operation
    317         #     results in its response, the status of those operations should be
    318         #     represented directly using the `Status` message.
    319         #
    320         # - Logging. If some API errors are stored in logs, the message `Status` could
    321         #     be used directly after any stripping needed for security/privacy reasons.
    322       "message": "A String", # A developer-facing error message, which should be in English. Any
    323           # user-facing error message should be localized and sent in the
    324           # google.rpc.Status.details field, or localized by the client.
    325       "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    326       "details": [ # A list of messages that carry the error details.  There will be a
    327           # common set of message types for APIs to use.
    328         {
    329           "a_key": "", # Properties of the object. Contains field @type with type URL.
    330         },
    331       ],
    332     },
    333     "done": True or False, # If the value is `false`, it means the operation is still in progress.
    334         # If true, the operation is completed, and either `error` or `response` is
    335         # available.
    336     "response": { # The normal response of the operation in case of success.  If the original
    337         # method returns no data on success, such as `Delete`, the response is
    338         # `google.protobuf.Empty`.  If the original method is standard
    339         # `Get`/`Create`/`Update`, the response should be the resource.  For other
    340         # methods, the response should have the type `XxxResponse`, where `Xxx`
    341         # is the original method name.  For example, if the original method name
    342         # is `TakeSnapshot()`, the inferred response type is
    343         # `TakeSnapshotResponse`.
    344       "a_key": "", # Properties of the object. Contains field @type with type URL.
    345     },
    346     "name": "A String", # The server-assigned name, which is only unique within the same service that
    347         # originally returns it. If you use the default HTTP mapping, the
    348         # `name` should have the format of `operations/some/unique/name`.
    349     "metadata": { # Service-specific metadata associated with the operation.  It typically
    350         # contains progress information and common metadata such as create time.
    351         # Some services might not provide such metadata.  Any method that returns a
    352         # long-running operation should document the metadata type, if any.
    353       "a_key": "", # Properties of the object. Contains field @type with type URL.
    354     },
    355   }</pre>
    356 </div>
    357 
    358 <div class="method">
    359     <code class="details" id="disable">disable(serviceName, body, x__xgafv=None)</code>
    360   <pre>Disables a service for a project, so it can no longer be
    361 be used for the project. It prevents accidental usage that may cause
    362 unexpected billing charges or security leaks.
    363 
    364 Operation<response: DisableServiceResponse>
    365 
    366 Args:
    367   serviceName: string, Name of the service to disable. Specifying an unknown service name
    368 will cause the request to fail. (required)
    369   body: object, The request body. (required)
    370     The object takes the form of:
    371 
    372 { # Request message for DisableService method.
    373     "consumerId": "A String", # The identity of consumer resource which service disablement will be
    374         # applied to.
    375         # 
    376         # The Google Service Management implementation accepts the following
    377         # forms:
    378         # - "project:<project_id>"
    379         # 
    380         # Note: this is made compatible with
    381         # google.api.servicecontrol.v1.Operation.consumer_id.
    382   }
    383 
    384   x__xgafv: string, V1 error format.
    385     Allowed values
    386       1 - v1 error format
    387       2 - v2 error format
    388 
    389 Returns:
    390   An object of the form:
    391 
    392     { # This resource represents a long-running operation that is the result of a
    393       # network API call.
    394     "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
    395         # programming environments, including REST APIs and RPC APIs. It is used by
    396         # [gRPC](https://github.com/grpc). The error model is designed to be:
    397         #
    398         # - Simple to use and understand for most users
    399         # - Flexible enough to meet unexpected needs
    400         #
    401         # # Overview
    402         #
    403         # The `Status` message contains three pieces of data: error code, error message,
    404         # and error details. The error code should be an enum value of
    405         # google.rpc.Code, but it may accept additional error codes if needed.  The
    406         # error message should be a developer-facing English message that helps
    407         # developers *understand* and *resolve* the error. If a localized user-facing
    408         # error message is needed, put the localized message in the error details or
    409         # localize it in the client. The optional error details may contain arbitrary
    410         # information about the error. There is a predefined set of error detail types
    411         # in the package `google.rpc` that can be used for common error conditions.
    412         #
    413         # # Language mapping
    414         #
    415         # The `Status` message is the logical representation of the error model, but it
    416         # is not necessarily the actual wire format. When the `Status` message is
    417         # exposed in different client libraries and different wire protocols, it can be
    418         # mapped differently. For example, it will likely be mapped to some exceptions
    419         # in Java, but more likely mapped to some error codes in C.
    420         #
    421         # # Other uses
    422         #
    423         # The error model and the `Status` message can be used in a variety of
    424         # environments, either with or without APIs, to provide a
    425         # consistent developer experience across different environments.
    426         #
    427         # Example uses of this error model include:
    428         #
    429         # - Partial errors. If a service needs to return partial errors to the client,
    430         #     it may embed the `Status` in the normal response to indicate the partial
    431         #     errors.
    432         #
    433         # - Workflow errors. A typical workflow has multiple steps. Each step may
    434         #     have a `Status` message for error reporting.
    435         #
    436         # - Batch operations. If a client uses batch request and batch response, the
    437         #     `Status` message should be used directly inside batch response, one for
    438         #     each error sub-response.
    439         #
    440         # - Asynchronous operations. If an API call embeds asynchronous operation
    441         #     results in its response, the status of those operations should be
    442         #     represented directly using the `Status` message.
    443         #
    444         # - Logging. If some API errors are stored in logs, the message `Status` could
    445         #     be used directly after any stripping needed for security/privacy reasons.
    446       "message": "A String", # A developer-facing error message, which should be in English. Any
    447           # user-facing error message should be localized and sent in the
    448           # google.rpc.Status.details field, or localized by the client.
    449       "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    450       "details": [ # A list of messages that carry the error details.  There will be a
    451           # common set of message types for APIs to use.
    452         {
    453           "a_key": "", # Properties of the object. Contains field @type with type URL.
    454         },
    455       ],
    456     },
    457     "done": True or False, # If the value is `false`, it means the operation is still in progress.
    458         # If true, the operation is completed, and either `error` or `response` is
    459         # available.
    460     "response": { # The normal response of the operation in case of success.  If the original
    461         # method returns no data on success, such as `Delete`, the response is
    462         # `google.protobuf.Empty`.  If the original method is standard
    463         # `Get`/`Create`/`Update`, the response should be the resource.  For other
    464         # methods, the response should have the type `XxxResponse`, where `Xxx`
    465         # is the original method name.  For example, if the original method name
    466         # is `TakeSnapshot()`, the inferred response type is
    467         # `TakeSnapshotResponse`.
    468       "a_key": "", # Properties of the object. Contains field @type with type URL.
    469     },
    470     "name": "A String", # The server-assigned name, which is only unique within the same service that
    471         # originally returns it. If you use the default HTTP mapping, the
    472         # `name` should have the format of `operations/some/unique/name`.
    473     "metadata": { # Service-specific metadata associated with the operation.  It typically
    474         # contains progress information and common metadata such as create time.
    475         # Some services might not provide such metadata.  Any method that returns a
    476         # long-running operation should document the metadata type, if any.
    477       "a_key": "", # Properties of the object. Contains field @type with type URL.
    478     },
    479   }</pre>
    480 </div>
    481 
    482 <div class="method">
    483     <code class="details" id="enable">enable(serviceName, body, x__xgafv=None)</code>
    484   <pre>Enables a service for a project, so it can be used
    485 for the project. See
    486 [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for
    487 more information.
    488 
    489 Operation<response: EnableServiceResponse>
    490 
    491 Args:
    492   serviceName: string, Name of the service to enable. Specifying an unknown service name will
    493 cause the request to fail. (required)
    494   body: object, The request body. (required)
    495     The object takes the form of:
    496 
    497 { # Request message for EnableService method.
    498     "consumerId": "A String", # The identity of consumer resource which service enablement will be
    499         # applied to.
    500         # 
    501         # The Google Service Management implementation accepts the following
    502         # forms:
    503         # - "project:<project_id>"
    504         # 
    505         # Note: this is made compatible with
    506         # google.api.servicecontrol.v1.Operation.consumer_id.
    507   }
    508 
    509   x__xgafv: string, V1 error format.
    510     Allowed values
    511       1 - v1 error format
    512       2 - v2 error format
    513 
    514 Returns:
    515   An object of the form:
    516 
    517     { # This resource represents a long-running operation that is the result of a
    518       # network API call.
    519     "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
    520         # programming environments, including REST APIs and RPC APIs. It is used by
    521         # [gRPC](https://github.com/grpc). The error model is designed to be:
    522         #
    523         # - Simple to use and understand for most users
    524         # - Flexible enough to meet unexpected needs
    525         #
    526         # # Overview
    527         #
    528         # The `Status` message contains three pieces of data: error code, error message,
    529         # and error details. The error code should be an enum value of
    530         # google.rpc.Code, but it may accept additional error codes if needed.  The
    531         # error message should be a developer-facing English message that helps
    532         # developers *understand* and *resolve* the error. If a localized user-facing
    533         # error message is needed, put the localized message in the error details or
    534         # localize it in the client. The optional error details may contain arbitrary
    535         # information about the error. There is a predefined set of error detail types
    536         # in the package `google.rpc` that can be used for common error conditions.
    537         #
    538         # # Language mapping
    539         #
    540         # The `Status` message is the logical representation of the error model, but it
    541         # is not necessarily the actual wire format. When the `Status` message is
    542         # exposed in different client libraries and different wire protocols, it can be
    543         # mapped differently. For example, it will likely be mapped to some exceptions
    544         # in Java, but more likely mapped to some error codes in C.
    545         #
    546         # # Other uses
    547         #
    548         # The error model and the `Status` message can be used in a variety of
    549         # environments, either with or without APIs, to provide a
    550         # consistent developer experience across different environments.
    551         #
    552         # Example uses of this error model include:
    553         #
    554         # - Partial errors. If a service needs to return partial errors to the client,
    555         #     it may embed the `Status` in the normal response to indicate the partial
    556         #     errors.
    557         #
    558         # - Workflow errors. A typical workflow has multiple steps. Each step may
    559         #     have a `Status` message for error reporting.
    560         #
    561         # - Batch operations. If a client uses batch request and batch response, the
    562         #     `Status` message should be used directly inside batch response, one for
    563         #     each error sub-response.
    564         #
    565         # - Asynchronous operations. If an API call embeds asynchronous operation
    566         #     results in its response, the status of those operations should be
    567         #     represented directly using the `Status` message.
    568         #
    569         # - Logging. If some API errors are stored in logs, the message `Status` could
    570         #     be used directly after any stripping needed for security/privacy reasons.
    571       "message": "A String", # A developer-facing error message, which should be in English. Any
    572           # user-facing error message should be localized and sent in the
    573           # google.rpc.Status.details field, or localized by the client.
    574       "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    575       "details": [ # A list of messages that carry the error details.  There will be a
    576           # common set of message types for APIs to use.
    577         {
    578           "a_key": "", # Properties of the object. Contains field @type with type URL.
    579         },
    580       ],
    581     },
    582     "done": True or False, # If the value is `false`, it means the operation is still in progress.
    583         # If true, the operation is completed, and either `error` or `response` is
    584         # available.
    585     "response": { # The normal response of the operation in case of success.  If the original
    586         # method returns no data on success, such as `Delete`, the response is
    587         # `google.protobuf.Empty`.  If the original method is standard
    588         # `Get`/`Create`/`Update`, the response should be the resource.  For other
    589         # methods, the response should have the type `XxxResponse`, where `Xxx`
    590         # is the original method name.  For example, if the original method name
    591         # is `TakeSnapshot()`, the inferred response type is
    592         # `TakeSnapshotResponse`.
    593       "a_key": "", # Properties of the object. Contains field @type with type URL.
    594     },
    595     "name": "A String", # The server-assigned name, which is only unique within the same service that
    596         # originally returns it. If you use the default HTTP mapping, the
    597         # `name` should have the format of `operations/some/unique/name`.
    598     "metadata": { # Service-specific metadata associated with the operation.  It typically
    599         # contains progress information and common metadata such as create time.
    600         # Some services might not provide such metadata.  Any method that returns a
    601         # long-running operation should document the metadata type, if any.
    602       "a_key": "", # Properties of the object. Contains field @type with type URL.
    603     },
    604   }</pre>
    605 </div>
    606 
    607 <div class="method">
    608     <code class="details" id="generateConfigReport">generateConfigReport(body, x__xgafv=None)</code>
    609   <pre>Generates and returns a report (errors, warnings and changes from
    610 existing configurations) associated with
    611 GenerateConfigReportRequest.new_value
    612 
    613 If GenerateConfigReportRequest.old_value is specified,
    614 GenerateConfigReportRequest will contain a single ChangeReport based on the
    615 comparison between GenerateConfigReportRequest.new_value and
    616 GenerateConfigReportRequest.old_value.
    617 If GenerateConfigReportRequest.old_value is not specified, this method
    618 will compare GenerateConfigReportRequest.new_value with the last pushed
    619 service configuration.
    620 
    621 Args:
    622   body: object, The request body. (required)
    623     The object takes the form of:
    624 
    625 { # Request message for GenerateConfigReport method.
    626     "newConfig": { # Service configuration for which we want to generate the report.
    627         # For this version of API, the supported types are
    628         # google.api.servicemanagement.v1.ConfigRef,
    629         # google.api.servicemanagement.v1.ConfigSource,
    630         # and google.api.Service
    631       "a_key": "", # Properties of the object. Contains field @type with type URL.
    632     },
    633     "oldConfig": { # Service configuration against which the comparison will be done.
    634         # For this version of API, the supported types are
    635         # google.api.servicemanagement.v1.ConfigRef,
    636         # google.api.servicemanagement.v1.ConfigSource,
    637         # and google.api.Service
    638       "a_key": "", # Properties of the object. Contains field @type with type URL.
    639     },
    640   }
    641 
    642   x__xgafv: string, V1 error format.
    643     Allowed values
    644       1 - v1 error format
    645       2 - v2 error format
    646 
    647 Returns:
    648   An object of the form:
    649 
    650     { # Response message for GenerateConfigReport method.
    651     "serviceName": "A String", # Name of the service this report belongs to.
    652     "changeReports": [ # list of ChangeReport, each corresponding to comparison between two
    653         # service configurations.
    654       { # Change report associated with a particular service configuration.
    655           #
    656           # It contains a list of ConfigChanges based on the comparison between
    657           # two service configurations.
    658         "configChanges": [ # List of changes between two service configurations.
    659             # The changes will be alphabetically sorted based on the identifier
    660             # of each change.
    661             # A ConfigChange identifier is a dot separated path to the configuration.
    662             # Example: visibility.rules[selector='LibraryService.CreateBook'].restriction
    663           { # Output generated from semantically comparing two versions of a service
    664               # configuration.
    665               #
    666               # Includes detailed information about a field that have changed with
    667               # applicable advice about potential consequences for the change, such as
    668               # backwards-incompatibility.
    669             "advices": [ # Collection of advice provided for this change, useful for determining the
    670                 # possible impact of this change.
    671               { # Generated advice about this change, used for providing more
    672                   # information about how a change will affect the existing service.
    673                 "description": "A String", # Useful description for why this advice was applied and what actions should
    674                     # be taken to mitigate any implied risks.
    675               },
    676             ],
    677             "changeType": "A String", # The type for this change, either ADDED, REMOVED, or MODIFIED.
    678             "newValue": "A String", # Value of the changed object in the new Service configuration,
    679                 # in JSON format. This field will not be populated if ChangeType == REMOVED.
    680             "oldValue": "A String", # Value of the changed object in the old Service configuration,
    681                 # in JSON format. This field will not be populated if ChangeType == ADDED.
    682             "element": "A String", # Object hierarchy path to the change, with levels separated by a '.'
    683                 # character. For repeated fields, an applicable unique identifier field is
    684                 # used for the index (usually selector, name, or id). For maps, the term
    685                 # 'key' is used. If the field has no unique identifier, the numeric index
    686                 # is used.
    687                 # Examples:
    688                 # - visibility.rules[selector=="google.LibraryService.CreateBook"].restriction
    689                 # - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
    690                 # - logging.producer_destinations[0]
    691           },
    692         ],
    693       },
    694     ],
    695     "id": "A String", # ID of the service configuration this report belongs to.
    696     "diagnostics": [ # Errors / Linter warnings associated with the service definition this
    697         # report
    698         # belongs to.
    699       { # Represents a diagnostic message (error or warning)
    700         "message": "A String", # Message describing the error or warning.
    701         "location": "A String", # File name and line number of the error or warning.
    702         "kind": "A String", # The kind of diagnostic information provided.
    703       },
    704     ],
    705   }</pre>
    706 </div>
    707 
    708 <div class="method">
    709     <code class="details" id="get">get(serviceName, x__xgafv=None)</code>
    710   <pre>Gets a managed service. Authentication is required unless the service is
    711 public.
    712 
    713 Args:
    714   serviceName: string, The name of the service.  See the `ServiceManager` overview for naming
    715 requirements.  For example: `example.googleapis.com`. (required)
    716   x__xgafv: string, V1 error format.
    717     Allowed values
    718       1 - v1 error format
    719       2 - v2 error format
    720 
    721 Returns:
    722   An object of the form:
    723 
    724     { # The full representation of a Service that is managed by
    725       # Google Service Management.
    726     "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
    727         # for naming requirements.
    728     "producerProjectId": "A String", # ID of the project that produces and owns this service.
    729   }</pre>
    730 </div>
    731 
    732 <div class="method">
    733     <code class="details" id="getConfig">getConfig(serviceName, configId=None, x__xgafv=None, view=None)</code>
    734   <pre>Gets a service configuration (version) for a managed service.
    735 
    736 Args:
    737   serviceName: string, The name of the service.  See the [overview](/service-management/overview)
    738 for naming requirements.  For example: `example.googleapis.com`. (required)
    739   configId: string, The id of the service configuration resource.
    740   x__xgafv: string, V1 error format.
    741     Allowed values
    742       1 - v1 error format
    743       2 - v2 error format
    744   view: string, Specifies which parts of the Service Config should be returned in the
    745 response.
    746 
    747 Returns:
    748   An object of the form:
    749 
    750     { # `Service` is the root object of Google service configuration schema. It
    751       # describes basic information about a service, such as the name and the
    752       # title, and delegates other aspects to sub-sections. Each sub-section is
    753       # either a proto message or a repeated proto message that configures a
    754       # specific aspect, such as auth. See each proto message definition for details.
    755       #
    756       # Example:
    757       #
    758       #     type: google.api.Service
    759       #     config_version: 3
    760       #     name: calendar.googleapis.com
    761       #     title: Google Calendar API
    762       #     apis:
    763       #     - name: google.calendar.v3.Calendar
    764       #     authentication:
    765       #       providers:
    766       #       - id: google_calendar_auth
    767       #         jwks_uri: https://www.googleapis.com/oauth2/v1/certs
    768       #         issuer: https://securetoken.google.com
    769       #       rules:
    770       #       - selector: "*"
    771       #         requirements:
    772       #           provider_id: google_calendar_auth
    773     "control": { # Selects and configures the service controller used by the service.  The # Configuration for the service control plane.
    774         # service controller handles features like abuse, quota, billing, logging,
    775         # monitoring, etc.
    776       "environment": "A String", # The service control environment to use. If empty, no control plane
    777           # feature (like quota and billing) will be enabled.
    778     },
    779     "monitoredResources": [ # Defines the monitored resources used by this service. This is required
    780         # by the Service.monitoring and Service.logging configurations.
    781       { # An object that describes the schema of a MonitoredResource object using a
    782           # type name and a set of labels.  For example, the monitored resource
    783           # descriptor for Google Compute Engine VM instances has a type of
    784           # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
    785           # `"zone"` to identify particular VM instances.
    786           #
    787           # Different APIs can support different monitored resource types. APIs generally
    788           # provide a `list` method that returns the monitored resource descriptors used
    789           # by the API.
    790         "type": "A String", # Required. The monitored resource type. For example, the type
    791             # `"cloudsql_database"` represents databases in Google Cloud SQL.
    792             # The maximum length of this value is 256 characters.
    793         "labels": [ # Required. A set of labels used to describe instances of this monitored
    794             # resource type. For example, an individual Google Cloud SQL database is
    795             # identified by values for the labels `"database_id"` and `"zone"`.
    796           { # A description of a label.
    797             "valueType": "A String", # The type of data that can be assigned to the label.
    798             "description": "A String", # A human-readable description for the label.
    799             "key": "A String", # The label key.
    800           },
    801         ],
    802         "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
    803             # displayed in user interfaces. It should be a Title Cased Noun Phrase,
    804             # without any article or other determiners. For example,
    805             # `"Google Cloud SQL Database"`.
    806         "name": "A String", # Optional. The resource name of the monitored resource descriptor:
    807             # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
    808             # {type} is the value of the `type` field in this object and
    809             # {project_id} is a project ID that provides API-specific context for
    810             # accessing the type.  APIs that do not use project information can use the
    811             # resource name format `"monitoredResourceDescriptors/{type}"`.
    812         "description": "A String", # Optional. A detailed description of the monitored resource type that might
    813             # be used in documentation.
    814       },
    815     ],
    816     "logs": [ # Defines the logs used by this service.
    817       { # A description of a log type. Example in YAML format:
    818           #
    819           #     - name: library.googleapis.com/activity_history
    820           #       description: The history of borrowing and returning library items.
    821           #       display_name: Activity
    822           #       labels:
    823           #       - key: /customer_id
    824           #         description: Identifier of a library customer
    825         "labels": [ # The set of labels that are available to describe a specific log entry.
    826             # Runtime requests that contain labels not specified here are
    827             # considered invalid.
    828           { # A description of a label.
    829             "valueType": "A String", # The type of data that can be assigned to the label.
    830             "description": "A String", # A human-readable description for the label.
    831             "key": "A String", # The label key.
    832           },
    833         ],
    834         "displayName": "A String", # The human-readable name for this log. This information appears on
    835             # the user interface and should be concise.
    836         "name": "A String", # The name of the log. It must be less than 512 characters long and can
    837             # include the following characters: upper- and lower-case alphanumeric
    838             # characters [A-Za-z0-9], and punctuation characters including
    839             # slash, underscore, hyphen, period [/_-.].
    840         "description": "A String", # A human-readable description of this log. This information appears in
    841             # the documentation and can contain details.
    842       },
    843     ],
    844     "systemParameters": { # ### System parameter configuration # System parameter configuration.
    845         #
    846         # A system parameter is a special kind of parameter defined by the API
    847         # system, not by an individual API. It is typically mapped to an HTTP header
    848         # and/or a URL query parameter. This configuration specifies which methods
    849         # change the names of the system parameters.
    850       "rules": [ # Define system parameters.
    851           #
    852           # The parameters defined here will override the default parameters
    853           # implemented by the system. If this field is missing from the service
    854           # config, default system parameters will be used. Default system parameters
    855           # and names is implementation-dependent.
    856           #
    857           # Example: define api key for all methods
    858           #
    859           #     system_parameters
    860           #       rules:
    861           #         - selector: "*"
    862           #           parameters:
    863           #             - name: api_key
    864           #               url_query_parameter: api_key
    865           #
    866           #
    867           # Example: define 2 api key names for a specific method.
    868           #
    869           #     system_parameters
    870           #       rules:
    871           #         - selector: "/ListShelves"
    872           #           parameters:
    873           #             - name: api_key
    874           #               http_header: Api-Key1
    875           #             - name: api_key
    876           #               http_header: Api-Key2
    877           #
    878           # **NOTE:** All service configuration rules follow "last one wins" order.
    879         { # Define a system parameter rule mapping system parameter definitions to
    880             # methods.
    881           "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
    882               # For a given method call, only one of them should be used. If multiple
    883               # names are used the behavior is implementation-dependent.
    884               # If none of the specified names are present the behavior is
    885               # parameter-dependent.
    886             { # Define a parameter's name and location. The parameter may be passed as either
    887                 # an HTTP header or a URL query parameter, and if both are passed the behavior
    888                 # is implementation-dependent.
    889               "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
    890                   # sensitive.
    891               "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
    892                   # insensitive.
    893               "name": "A String", # Define the name of the parameter, such as "api_key" . It is case sensitive.
    894             },
    895           ],
    896           "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
    897               # methods in all APIs.
    898               #
    899               # Refer to selector for syntax details.
    900         },
    901       ],
    902     },
    903     "id": "A String", # A unique ID for a specific instance of this message, typically assigned
    904         # by the client for tracking purpose. If empty, the server may choose to
    905         # generate one instead.
    906     "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
    907       "rules": [ # A list of API backend rules that apply to individual API methods.
    908           #
    909           # **NOTE:** All service configuration rules follow "last one wins" order.
    910         { # A backend rule provides configuration for an individual API element.
    911           "selector": "A String", # Selects the methods to which this rule applies.
    912               #
    913               # Refer to selector for syntax details.
    914           "minDeadline": 3.14, # Minimum deadline in seconds needed for this method. Calls having deadline
    915               # value lower than this will be rejected.
    916           "deadline": 3.14, # The number of seconds to wait for a response from a request.  The
    917               # default depends on the deployment context.
    918           "address": "A String", # The address of the API backend.
    919         },
    920       ],
    921     },
    922     "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
    923         #
    924         # The example below shows how to configure monitored resources and metrics
    925         # for monitoring. In the example, a monitored resource and two metrics are
    926         # defined. The `library.googleapis.com/book/returned_count` metric is sent
    927         # to both producer and consumer projects, whereas the
    928         # `library.googleapis.com/book/overdue_count` metric is only sent to the
    929         # consumer project.
    930         #
    931         #     monitored_resources:
    932         #     - type: library.googleapis.com/branch
    933         #       labels:
    934         #       - key: /city
    935         #         description: The city where the library branch is located in.
    936         #       - key: /name
    937         #         description: The name of the branch.
    938         #     metrics:
    939         #     - name: library.googleapis.com/book/returned_count
    940         #       metric_kind: DELTA
    941         #       value_type: INT64
    942         #       labels:
    943         #       - key: /customer_id
    944         #     - name: library.googleapis.com/book/overdue_count
    945         #       metric_kind: GAUGE
    946         #       value_type: INT64
    947         #       labels:
    948         #       - key: /customer_id
    949         #     monitoring:
    950         #       producer_destinations:
    951         #       - monitored_resource: library.googleapis.com/branch
    952         #         metrics:
    953         #         - library.googleapis.com/book/returned_count
    954         #       consumer_destinations:
    955         #       - monitored_resource: library.googleapis.com/branch
    956         #         metrics:
    957         #         - library.googleapis.com/book/returned_count
    958         #         - library.googleapis.com/book/overdue_count
    959       "producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.
    960           # There can be multiple producer destinations, each one must have a
    961           # different monitored resource type. A metric can be used in at most
    962           # one producer destination.
    963         { # Configuration of a specific monitoring destination (the producer project
    964             # or the consumer project).
    965           "monitoredResource": "A String", # The monitored resource type. The type must be defined in
    966               # Service.monitored_resources section.
    967           "metrics": [ # Names of the metrics to report to this monitoring destination.
    968               # Each name must be defined in Service.metrics section.
    969             "A String",
    970           ],
    971         },
    972       ],
    973       "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
    974           # There can be multiple consumer destinations, each one must have a
    975           # different monitored resource type. A metric can be used in at most
    976           # one consumer destination.
    977         { # Configuration of a specific monitoring destination (the producer project
    978             # or the consumer project).
    979           "monitoredResource": "A String", # The monitored resource type. The type must be defined in
    980               # Service.monitored_resources section.
    981           "metrics": [ # Names of the metrics to report to this monitoring destination.
    982               # Each name must be defined in Service.metrics section.
    983             "A String",
    984           ],
    985         },
    986       ],
    987     },
    988     "title": "A String", # The product title associated with this service.
    989     "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
    990         #
    991         # Example for an API targeted for external use:
    992         #
    993         #     name: calendar.googleapis.com
    994         #     authentication:
    995         #       providers:
    996         #       - id: google_calendar_auth
    997         #         jwks_uri: https://www.googleapis.com/oauth2/v1/certs
    998         #         issuer: https://securetoken.google.com
    999         #       rules:
   1000         #       - selector: "*"
   1001         #         requirements:
   1002         #           provider_id: google_calendar_auth
   1003       "rules": [ # A list of authentication rules that apply to individual API methods.
   1004           #
   1005           # **NOTE:** All service configuration rules follow "last one wins" order.
   1006         { # Authentication rules for the service.
   1007             #
   1008             # By default, if a method has any authentication requirements, every request
   1009             # must include a valid credential matching one of the requirements.
   1010             # It's an error to include more than one kind of credential in a single
   1011             # request.
   1012             #
   1013             # If a method doesn't have any auth requirements, request credentials will be
   1014             # ignored.
   1015           "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
   1016               # there are scopes defined for "Read-only access to Google Calendar" and
   1017               # "Access to Cloud Platform". Users can consent to a scope for an application,
   1018               # giving it permission to access that data on their behalf.
   1019               #
   1020               # OAuth scope specifications should be fairly coarse grained; a user will need
   1021               # to see and understand the text description of what your scope means.
   1022               #
   1023               # In most cases: use one or at most two OAuth scopes for an entire family of
   1024               # products. If your product has multiple APIs, you should probably be sharing
   1025               # the OAuth scope across all of those APIs.
   1026               #
   1027               # When you need finer grained OAuth consent screens: talk with your product
   1028               # management about how developers will use them in practice.
   1029               #
   1030               # Please note that even though each of the canonical scopes is enough for a
   1031               # request to be accepted and passed to the backend, a request can still fail
   1032               # due to the backend requiring additional scopes or permissions.
   1033             "canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An
   1034                 # OAuth token containing any of these scopes will be accepted.
   1035                 #
   1036                 # Example:
   1037                 #
   1038                 #      canonical_scopes: https://www.googleapis.com/auth/calendar,
   1039                 #                        https://www.googleapis.com/auth/calendar.read
   1040           },
   1041           "requirements": [ # Requirements for additional authentication providers.
   1042             { # User-defined authentication requirements, including support for
   1043                 # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
   1044               "providerId": "A String", # id from authentication provider.
   1045                   #
   1046                   # Example:
   1047                   #
   1048                   #     provider_id: bookstore_auth
   1049               "audiences": "A String", # NOTE: This will be deprecated soon, once AuthProvider.audiences is
   1050                   # implemented and accepted in all the runtime components.
   1051                   #
   1052                   # The list of JWT
   1053                   # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
   1054                   # that are allowed to access. A JWT containing any of these audiences will
   1055                   # be accepted. When this setting is absent, only JWTs with audience
   1056                   # "https://Service_name/API_name"
   1057                   # will be accepted. For example, if no audiences are in the setting,
   1058                   # LibraryService API will only accept JWTs with the following audience
   1059                   # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
   1060                   #
   1061                   # Example:
   1062                   #
   1063                   #     audiences: bookstore_android.apps.googleusercontent.com,
   1064                   #                bookstore_web.apps.googleusercontent.com
   1065             },
   1066           ],
   1067           "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
   1068               # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
   1069               #
   1070               # For requests without credentials, if the service control environment is
   1071               # specified, each incoming request **must** be associated with a service
   1072               # consumer. This can be done by passing an API key that belongs to a consumer
   1073               # project.
   1074           "customAuth": { # Configuration for a custom authentication provider. # Configuration for custom authentication.
   1075             "provider": "A String", # A configuration string containing connection information for the
   1076                 # authentication provider, typically formatted as a SmartService string
   1077                 # (go/smartservice).
   1078           },
   1079           "selector": "A String", # Selects the methods to which this rule applies.
   1080               #
   1081               # Refer to selector for syntax details.
   1082         },
   1083       ],
   1084       "providers": [ # Defines a set of authentication providers that a service supports.
   1085         { # Configuration for an anthentication provider, including support for
   1086             # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
   1087           "audiences": "A String", # The list of JWT
   1088               # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
   1089               # that are allowed to access. A JWT containing any of these audiences will
   1090               # be accepted. When this setting is absent, only JWTs with audience
   1091               # "https://Service_name/API_name"
   1092               # will be accepted. For example, if no audiences are in the setting,
   1093               # LibraryService API will only accept JWTs with the following audience
   1094               # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
   1095               #
   1096               # Example:
   1097               #
   1098               #     audiences: bookstore_android.apps.googleusercontent.com,
   1099               #                bookstore_web.apps.googleusercontent.com
   1100           "jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See
   1101               # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
   1102               # Optional if the key set document:
   1103               #  - can be retrieved from
   1104               #    [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
   1105               #    of the issuer.
   1106               #  - can be inferred from the email domain of the issuer (e.g. a Google service account).
   1107               #
   1108               # Example: https://www.googleapis.com/oauth2/v1/certs
   1109           "id": "A String", # The unique identifier of the auth provider. It will be referred to by
   1110               # `AuthRequirement.provider_id`.
   1111               #
   1112               # Example: "bookstore_auth".
   1113           "issuer": "A String", # Identifies the principal that issued the JWT. See
   1114               # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
   1115               # Usually a URL or an email address.
   1116               #
   1117               # Example: https://securetoken.google.com
   1118               # Example: 1234567-compute (a] developer.gserviceaccount.com
   1119         },
   1120       ],
   1121     },
   1122     "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
   1123       "rules": [ # A list of usage rules that apply to individual API methods.
   1124           #
   1125           # **NOTE:** All service configuration rules follow "last one wins" order.
   1126         { # Usage configuration rules for the service.
   1127             #
   1128             # NOTE: Under development.
   1129             #
   1130             #
   1131             # Use this rule to configure unregistered calls for the service. Unregistered
   1132             # calls are calls that do not contain consumer project identity.
   1133             # (Example: calls that do not contain an API key).
   1134             # By default, API methods do not allow unregistered calls, and each method call
   1135             # must be identified by a consumer project identity. Use this rule to
   1136             # allow/disallow unregistered calls.
   1137             #
   1138             # Example of an API that wants to allow unregistered calls for entire service.
   1139             #
   1140             #     usage:
   1141             #       rules:
   1142             #       - selector: "*"
   1143             #         allow_unregistered_calls: true
   1144             #
   1145             # Example of a method that wants to allow unregistered calls.
   1146             #
   1147             #     usage:
   1148             #       rules:
   1149             #       - selector: "google.example.library.v1.LibraryService.CreateBook"
   1150             #         allow_unregistered_calls: true
   1151           "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
   1152           "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
   1153               # methods in all APIs.
   1154               #
   1155               # Refer to selector for syntax details.
   1156         },
   1157       ],
   1158       "producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the
   1159           # service producer.
   1160           #
   1161           # Google Service Management currently only supports
   1162           # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
   1163           # channel. To use Google Cloud Pub/Sub as the channel, this must be the name
   1164           # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
   1165           # documented in https://cloud.google.com/pubsub/docs/overview.
   1166       "requirements": [ # Requirements that must be satisfied before a consumer project can use the
   1167           # service. Each requirement is of the form <service.name>/<requirement-id>;
   1168           # for example 'serviceusage.googleapis.com/billing-enabled'.
   1169         "A String",
   1170       ],
   1171     },
   1172     "configVersion": 42, # The version of the service configuration. The config version may
   1173         # influence interpretation of the configuration, for example, to
   1174         # determine defaults. This is documented together with applicable
   1175         # options. The current default for the config version itself is `3`.
   1176     "producerProjectId": "A String", # The id of the Google developer project that owns the service.
   1177         # Members of this project can manage the service configuration,
   1178         # manage consumption of the service, etc.
   1179     "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
   1180         # HttpRule, each specifying the mapping of an RPC method
   1181         # to one or more HTTP REST API methods.
   1182       "rules": [ # A list of HTTP configuration rules that apply to individual API methods.
   1183           #
   1184           # **NOTE:** All service configuration rules follow "last one wins" order.
   1185         { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
   1186             # REST APIs.  The mapping determines what portions of the request
   1187             # message are populated from the path, query parameters, or body of
   1188             # the HTTP request.  The mapping is typically specified as an
   1189             # `google.api.http` annotation, see "google/api/annotations.proto"
   1190             # for details.
   1191             #
   1192             # The mapping consists of a field specifying the path template and
   1193             # method kind.  The path template can refer to fields in the request
   1194             # message, as in the example below which describes a REST GET
   1195             # operation on a resource collection of messages:
   1196             #
   1197             #
   1198             #     service Messaging {
   1199             #       rpc GetMessage(GetMessageRequest) returns (Message) {
   1200             #         option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
   1201             #       }
   1202             #     }
   1203             #     message GetMessageRequest {
   1204             #       message SubMessage {
   1205             #         string subfield = 1;
   1206             #       }
   1207             #       string message_id = 1; // mapped to the URL
   1208             #       SubMessage sub = 2;    // `sub.subfield` is url-mapped
   1209             #     }
   1210             #     message Message {
   1211             #       string text = 1; // content of the resource
   1212             #     }
   1213             #
   1214             # The same http annotation can alternatively be expressed inside the
   1215             # `GRPC API Configuration` YAML file.
   1216             #
   1217             #     http:
   1218             #       rules:
   1219             #         - selector: <proto_package_name>.Messaging.GetMessage
   1220             #           get: /v1/messages/{message_id}/{sub.subfield}
   1221             #
   1222             # This definition enables an automatic, bidrectional mapping of HTTP
   1223             # JSON to RPC. Example:
   1224             #
   1225             # HTTP | RPC
   1226             # -----|-----
   1227             # `GET /v1/messages/123456/foo`  | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
   1228             #
   1229             # In general, not only fields but also field paths can be referenced
   1230             # from a path pattern. Fields mapped to the path pattern cannot be
   1231             # repeated and must have a primitive (non-message) type.
   1232             #
   1233             # Any fields in the request message which are not bound by the path
   1234             # pattern automatically become (optional) HTTP query
   1235             # parameters. Assume the following definition of the request message:
   1236             #
   1237             #
   1238             #     service Messaging {
   1239             #       rpc GetMessage(GetMessageRequest) returns (Message) {
   1240             #         option (google.api.http).get = "/v1/messages/{message_id}";
   1241             #       }
   1242             #     }
   1243             #     message GetMessageRequest {
   1244             #       message SubMessage {
   1245             #         string subfield = 1;
   1246             #       }
   1247             #       string message_id = 1; // mapped to the URL
   1248             #       int64 revision = 2;    // becomes a parameter
   1249             #       SubMessage sub = 3;    // `sub.subfield` becomes a parameter
   1250             #     }
   1251             #
   1252             #
   1253             # This enables a HTTP JSON to RPC mapping as below:
   1254             #
   1255             # HTTP | RPC
   1256             # -----|-----
   1257             # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`
   1258             #
   1259             # Note that fields which are mapped to HTTP parameters must have a
   1260             # primitive type or a repeated primitive type. Message types are not
   1261             # allowed. In the case of a repeated type, the parameter can be
   1262             # repeated in the URL, as in `...?param=A&param=B`.
   1263             #
   1264             # For HTTP method kinds which allow a request body, the `body` field
   1265             # specifies the mapping. Consider a REST update method on the
   1266             # message resource collection:
   1267             #
   1268             #
   1269             #     service Messaging {
   1270             #       rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
   1271             #         option (google.api.http) = {
   1272             #           put: "/v1/messages/{message_id}"
   1273             #           body: "message"
   1274             #         };
   1275             #       }
   1276             #     }
   1277             #     message UpdateMessageRequest {
   1278             #       string message_id = 1; // mapped to the URL
   1279             #       Message message = 2;   // mapped to the body
   1280             #     }
   1281             #
   1282             #
   1283             # The following HTTP JSON to RPC mapping is enabled, where the
   1284             # representation of the JSON in the request body is determined by
   1285             # protos JSON encoding:
   1286             #
   1287             # HTTP | RPC
   1288             # -----|-----
   1289             # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
   1290             #
   1291             # The special name `*` can be used in the body mapping to define that
   1292             # every field not bound by the path template should be mapped to the
   1293             # request body.  This enables the following alternative definition of
   1294             # the update method:
   1295             #
   1296             #     service Messaging {
   1297             #       rpc UpdateMessage(Message) returns (Message) {
   1298             #         option (google.api.http) = {
   1299             #           put: "/v1/messages/{message_id}"
   1300             #           body: "*"
   1301             #         };
   1302             #       }
   1303             #     }
   1304             #     message Message {
   1305             #       string message_id = 1;
   1306             #       string text = 2;
   1307             #     }
   1308             #
   1309             #
   1310             # The following HTTP JSON to RPC mapping is enabled:
   1311             #
   1312             # HTTP | RPC
   1313             # -----|-----
   1314             # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
   1315             #
   1316             # Note that when using `*` in the body mapping, it is not possible to
   1317             # have HTTP parameters, as all fields not bound by the path end in
   1318             # the body. This makes this option more rarely used in practice of
   1319             # defining REST APIs. The common usage of `*` is in custom methods
   1320             # which don't use the URL at all for transferring data.
   1321             #
   1322             # It is possible to define multiple HTTP methods for one RPC by using
   1323             # the `additional_bindings` option. Example:
   1324             #
   1325             #     service Messaging {
   1326             #       rpc GetMessage(GetMessageRequest) returns (Message) {
   1327             #         option (google.api.http) = {
   1328             #           get: "/v1/messages/{message_id}"
   1329             #           additional_bindings {
   1330             #             get: "/v1/users/{user_id}/messages/{message_id}"
   1331             #           }
   1332             #         };
   1333             #       }
   1334             #     }
   1335             #     message GetMessageRequest {
   1336             #       string message_id = 1;
   1337             #       string user_id = 2;
   1338             #     }
   1339             #
   1340             #
   1341             # This enables the following two alternative HTTP JSON to RPC
   1342             # mappings:
   1343             #
   1344             # HTTP | RPC
   1345             # -----|-----
   1346             # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
   1347             # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`
   1348             #
   1349             # # Rules for HTTP mapping
   1350             #
   1351             # The rules for mapping HTTP path, query parameters, and body fields
   1352             # to the request message are as follows:
   1353             #
   1354             # 1. The `body` field specifies either `*` or a field path, or is
   1355             #    omitted. If omitted, it assumes there is no HTTP body.
   1356             # 2. Leaf fields (recursive expansion of nested messages in the
   1357             #    request) can be classified into three types:
   1358             #     (a) Matched in the URL template.
   1359             #     (b) Covered by body (if body is `*`, everything except (a) fields;
   1360             #         else everything under the body field)
   1361             #     (c) All other fields.
   1362             # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
   1363             # 4. Any body sent with an HTTP request can contain only (b) fields.
   1364             #
   1365             # The syntax of the path template is as follows:
   1366             #
   1367             #     Template = "/" Segments [ Verb ] ;
   1368             #     Segments = Segment { "/" Segment } ;
   1369             #     Segment  = "*" | "**" | LITERAL | Variable ;
   1370             #     Variable = "{" FieldPath [ "=" Segments ] "}" ;
   1371             #     FieldPath = IDENT { "." IDENT } ;
   1372             #     Verb     = ":" LITERAL ;
   1373             #
   1374             # The syntax `*` matches a single path segment. It follows the semantics of
   1375             # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
   1376             # Expansion.
   1377             #
   1378             # The syntax `**` matches zero or more path segments. It follows the semantics
   1379             # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
   1380             # Expansion. NOTE: it must be the last segment in the path except the Verb.
   1381             #
   1382             # The syntax `LITERAL` matches literal text in the URL path.
   1383             #
   1384             # The syntax `Variable` matches the entire path as specified by its template;
   1385             # this nested template must not contain further variables. If a variable
   1386             # matches a single path segment, its template may be omitted, e.g. `{var}`
   1387             # is equivalent to `{var=*}`.
   1388             #
   1389             # NOTE: the field paths in variables and in the `body` must not refer to
   1390             # repeated fields or map fields.
   1391             #
   1392             # Use CustomHttpPattern to specify any HTTP method that is not included in the
   1393             # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
   1394             # a given URL path rule. The wild-card rule is useful for services that provide
   1395             # content to Web (HTML) clients.
   1396           "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
   1397               # `*` for mapping all fields not captured by the path pattern to the HTTP
   1398               # body. NOTE: the referred field must not be a repeated field and must be
   1399               # present at the top-level of request message type.
   1400           "get": "A String", # Used for listing and getting information about resources.
   1401           "restCollection": "A String", # Optional. The REST collection name is by default derived from the URL
   1402               # pattern. If specified, this field overrides the default collection name.
   1403               # Example:
   1404               #
   1405               #     rpc AddressesAggregatedList(AddressesAggregatedListRequest)
   1406               #         returns (AddressesAggregatedListResponse) {
   1407               #       option (google.api.http) = {
   1408               #         get: "/v1/projects/{project_id}/aggregated/addresses"
   1409               #         rest_collection: "projects.addresses"
   1410               #       };
   1411               #     }
   1412               #
   1413               # This method has the automatically derived collection name
   1414               # "projects.aggregated". Because, semantically, this rpc is actually an
   1415               # operation on the "projects.addresses" collection, the `rest_collection`
   1416               # field is configured to override the derived collection name.
   1417           "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must
   1418               # not contain an `additional_bindings` field themselves (that is,
   1419               # the nesting may only be one level deep).
   1420             # Object with schema name: HttpRule
   1421           ],
   1422           "mediaUpload": { # Defines the Media configuration for a service in case of an upload. # Use this only for Scotty Requests. Do not use this for media support using
   1423               # Bytestream, add instead
   1424               # [][google.bytestream.RestByteStream] as an API to your
   1425               # configuration for Bytestream methods.
   1426               # Use this only for Scotty Requests. Do not use this for media support using
   1427               # Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
   1428               # your configuration for Bytestream methods.
   1429             "progressNotification": True or False, # Whether to receive a notification for progress changes of media upload.
   1430             "startNotification": True or False, # Whether to receive a notification on the start of media upload.
   1431             "mimeTypes": [ # An array of mimetype patterns. Esf will only accept uploads that match one
   1432                 # of the given patterns.
   1433               "A String",
   1434             ],
   1435             "completeNotification": True or False, # A boolean that determines whether a notification for the completion of an
   1436                 # upload should be sent to the backend. These notifications will not be seen
   1437                 # by the client and will not consume quota.
   1438             "enabled": True or False, # Whether upload is enabled.
   1439             "uploadService": "A String", # DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
   1440                 #
   1441                 # Specify name of the upload service if one is used for upload.
   1442             "maxSize": "A String", # Optional maximum acceptable size for an upload.
   1443                 # The size is specified in bytes.
   1444             "dropzone": "A String", # Name of the Scotty dropzone to use for the current API.
   1445           },
   1446           "selector": "A String", # Selects methods to which this rule applies.
   1447               #
   1448               # Refer to selector for syntax details.
   1449           "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
   1450               # response. Other response fields are ignored. This field is optional. When
   1451               # not set, the response message will be used as HTTP body of response.
   1452               # NOTE: the referred field must be not a repeated field and must be present
   1453               # at the top-level of response message type.
   1454           "restMethodName": "A String", # Optional. The rest method name is by default derived from the URL
   1455               # pattern. If specified, this field overrides the default method name.
   1456               # Example:
   1457               #
   1458               #     rpc CreateResource(CreateResourceRequest)
   1459               #         returns (CreateResourceResponse) {
   1460               #       option (google.api.http) = {
   1461               #         post: "/v1/resources",
   1462               #         body: "resource",
   1463               #         rest_method_name: "insert"
   1464               #       };
   1465               #     }
   1466               #
   1467               # This method has the automatically derived rest method name "create", but
   1468               #  for backwards compatability with apiary, it is specified as insert.
   1469           "mediaDownload": { # Defines the Media configuration for a service in case of a download. # Use this only for Scotty Requests. Do not use this for bytestream methods.
   1470               # For media support, add instead [][google.bytestream.RestByteStream] as an
   1471               # API to your configuration.
   1472               # Use this only for Scotty Requests. Do not use this for media support using
   1473               # Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
   1474               # your configuration for Bytestream methods.
   1475             "useDirectDownload": True or False, # A boolean that determines if direct download from ESF should be used for
   1476                 # download of this media.
   1477             "enabled": True or False, # Whether download is enabled.
   1478             "completeNotification": True or False, # A boolean that determines whether a notification for the completion of a
   1479                 # download should be sent to the backend.
   1480             "maxDirectDownloadSize": "A String", # Optional maximum acceptable size for direct download.
   1481                 # The size is specified in bytes.
   1482             "dropzone": "A String", # Name of the Scotty dropzone to use for the current API.
   1483             "downloadService": "A String", # DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
   1484                 #
   1485                 # Specify name of the download service if one is used for download.
   1486           },
   1487           "put": "A String", # Used for updating a resource.
   1488           "patch": "A String", # Used for updating a resource.
   1489           "post": "A String", # Used for creating a resource.
   1490           "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
   1491             "path": "A String", # The path matched by this custom verb.
   1492             "kind": "A String", # The name of this custom HTTP verb.
   1493           },
   1494           "delete": "A String", # Used for deleting a resource.
   1495         },
   1496       ],
   1497       "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parmeters will be fully URI-decoded except in
   1498           # cases of single segment matches in reserved expansion, where "%2F" will be
   1499           # left encoded.
   1500           #
   1501           # The default behavior is to not decode RFC 6570 reserved characters in multi
   1502           # segment matches.
   1503     },
   1504     "apis": [ # A list of API interfaces exported by this service. Only the `name` field
   1505         # of the google.protobuf.Api needs to be provided by the configuration
   1506         # author, as the remaining fields will be derived from the IDL during the
   1507         # normalization process. It is an error to specify an API interface here
   1508         # which cannot be resolved against the associated IDL files.
   1509       { # Api is a light-weight descriptor for a protocol buffer service.
   1510         "name": "A String", # The fully qualified name of this api, including package name
   1511             # followed by the api's simple name.
   1512         "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
   1513             # message.
   1514             # protobuf element, like the file in which it is defined.
   1515           "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
   1516               # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
   1517         },
   1518         "mixins": [ # Included APIs. See Mixin.
   1519           { # Declares an API to be included in this API. The including API must
   1520               # redeclare all the methods from the included API, but documentation
   1521               # and options are inherited as follows:
   1522               #
   1523               # - If after comment and whitespace stripping, the documentation
   1524               #   string of the redeclared method is empty, it will be inherited
   1525               #   from the original method.
   1526               #
   1527               # - Each annotation belonging to the service config (http,
   1528               #   visibility) which is not set in the redeclared method will be
   1529               #   inherited.
   1530               #
   1531               # - If an http annotation is inherited, the path pattern will be
   1532               #   modified as follows. Any version prefix will be replaced by the
   1533               #   version of the including API plus the root path if specified.
   1534               #
   1535               # Example of a simple mixin:
   1536               #
   1537               #     package google.acl.v1;
   1538               #     service AccessControl {
   1539               #       // Get the underlying ACL object.
   1540               #       rpc GetAcl(GetAclRequest) returns (Acl) {
   1541               #         option (google.api.http).get = "/v1/{resource=**}:getAcl";
   1542               #       }
   1543               #     }
   1544               #
   1545               #     package google.storage.v2;
   1546               #     service Storage {
   1547               #       //       rpc GetAcl(GetAclRequest) returns (Acl);
   1548               #
   1549               #       // Get a data record.
   1550               #       rpc GetData(GetDataRequest) returns (Data) {
   1551               #         option (google.api.http).get = "/v2/{resource=**}";
   1552               #       }
   1553               #     }
   1554               #
   1555               # Example of a mixin configuration:
   1556               #
   1557               #     apis:
   1558               #     - name: google.storage.v2.Storage
   1559               #       mixins:
   1560               #       - name: google.acl.v1.AccessControl
   1561               #
   1562               # The mixin construct implies that all methods in `AccessControl` are
   1563               # also declared with same name and request/response types in
   1564               # `Storage`. A documentation generator or annotation processor will
   1565               # see the effective `Storage.GetAcl` method after inherting
   1566               # documentation and annotations as follows:
   1567               #
   1568               #     service Storage {
   1569               #       // Get the underlying ACL object.
   1570               #       rpc GetAcl(GetAclRequest) returns (Acl) {
   1571               #         option (google.api.http).get = "/v2/{resource=**}:getAcl";
   1572               #       }
   1573               #       ...
   1574               #     }
   1575               #
   1576               # Note how the version in the path pattern changed from `v1` to `v2`.
   1577               #
   1578               # If the `root` field in the mixin is specified, it should be a
   1579               # relative path under which inherited HTTP paths are placed. Example:
   1580               #
   1581               #     apis:
   1582               #     - name: google.storage.v2.Storage
   1583               #       mixins:
   1584               #       - name: google.acl.v1.AccessControl
   1585               #         root: acls
   1586               #
   1587               # This implies the following inherited HTTP annotation:
   1588               #
   1589               #     service Storage {
   1590               #       // Get the underlying ACL object.
   1591               #       rpc GetAcl(GetAclRequest) returns (Acl) {
   1592               #         option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
   1593               #       }
   1594               #       ...
   1595               #     }
   1596             "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
   1597                 # are rooted.
   1598             "name": "A String", # The fully qualified name of the API which is included.
   1599           },
   1600         ],
   1601         "syntax": "A String", # The source syntax of the service.
   1602         "version": "A String", # A version string for this api. If specified, must have the form
   1603             # `major-version.minor-version`, as in `1.10`. If the minor version
   1604             # is omitted, it defaults to zero. If the entire version field is
   1605             # empty, the major version is derived from the package name, as
   1606             # outlined below. If the field is not empty, the version in the
   1607             # package name will be verified to be consistent with what is
   1608             # provided here.
   1609             #
   1610             # The versioning schema uses [semantic
   1611             # versioning](http://semver.org) where the major version number
   1612             # indicates a breaking change and the minor version an additive,
   1613             # non-breaking change. Both version numbers are signals to users
   1614             # what to expect from different versions, and should be carefully
   1615             # chosen based on the product plan.
   1616             #
   1617             # The major version is also reflected in the package name of the
   1618             # API, which must end in `v<major-version>`, as in
   1619             # `google.feature.v1`. For major versions 0 and 1, the suffix can
   1620             # be omitted. Zero major versions must only be used for
   1621             # experimental, none-GA apis.
   1622         "options": [ # Any metadata attached to the API.
   1623           { # A protocol buffer option, which can be attached to a message, field,
   1624               # enumeration, etc.
   1625             "name": "A String", # The option's name. For protobuf built-in options (options defined in
   1626                 # descriptor.proto), this is the short name. For example, `"map_entry"`.
   1627                 # For custom options, it should be the fully-qualified name. For example,
   1628                 # `"google.api.http"`.
   1629             "value": { # The option's value packed in an Any message. If the value is a primitive,
   1630                 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
   1631                 # should be used. If the value is an enum, it should be stored as an int32
   1632                 # value using the google.protobuf.Int32Value type.
   1633               "a_key": "", # Properties of the object. Contains field @type with type URL.
   1634             },
   1635           },
   1636         ],
   1637         "methods": [ # The methods of this api, in unspecified order.
   1638           { # Method represents a method of an api.
   1639             "name": "A String", # The simple name of this method.
   1640             "requestStreaming": True or False, # If true, the request is streamed.
   1641             "responseTypeUrl": "A String", # The URL of the output message type.
   1642             "requestTypeUrl": "A String", # A URL of the input message type.
   1643             "responseStreaming": True or False, # If true, the response is streamed.
   1644             "syntax": "A String", # The source syntax of this method.
   1645             "options": [ # Any metadata attached to the method.
   1646               { # A protocol buffer option, which can be attached to a message, field,
   1647                   # enumeration, etc.
   1648                 "name": "A String", # The option's name. For protobuf built-in options (options defined in
   1649                     # descriptor.proto), this is the short name. For example, `"map_entry"`.
   1650                     # For custom options, it should be the fully-qualified name. For example,
   1651                     # `"google.api.http"`.
   1652                 "value": { # The option's value packed in an Any message. If the value is a primitive,
   1653                     # the corresponding wrapper type defined in google/protobuf/wrappers.proto
   1654                     # should be used. If the value is an enum, it should be stored as an int32
   1655                     # value using the google.protobuf.Int32Value type.
   1656                   "a_key": "", # Properties of the object. Contains field @type with type URL.
   1657                 },
   1658               },
   1659             ],
   1660           },
   1661         ],
   1662       },
   1663     ],
   1664     "customError": { # Customize service error responses.  For example, list any service # Custom error configuration.
   1665         # specific protobuf types that can appear in error detail lists of
   1666         # error responses.
   1667         #
   1668         # Example:
   1669         #
   1670         #     custom_error:
   1671         #       types:
   1672         #       - google.foo.v1.CustomError
   1673         #       - google.foo.v1.AnotherError
   1674       "rules": [ # The list of custom error rules that apply to individual API messages.
   1675           #
   1676           # **NOTE:** All service configuration rules follow "last one wins" order.
   1677         { # A custom error rule.
   1678           "isErrorType": True or False, # Mark this message as possible payload in error response.  Otherwise,
   1679               # objects of this type will be filtered when they appear in error payload.
   1680           "selector": "A String", # Selects messages to which this rule applies.
   1681               #
   1682               # Refer to selector for syntax details.
   1683         },
   1684       ],
   1685       "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
   1686         "A String",
   1687       ],
   1688     },
   1689     "quota": { # Quota configuration helps to achieve fairness and budgeting in service # Quota configuration.
   1690         # usage.
   1691         #
   1692         # The quota configuration works this way:
   1693         # - The service configuration defines a set of metrics.
   1694         # - For API calls, the quota.metric_rules maps methods to metrics with
   1695         #   corresponding costs.
   1696         # - The quota.limits defines limits on the metrics, which will be used for
   1697         #   quota checks at runtime.
   1698         #
   1699         # An example quota configuration in yaml format:
   1700         #
   1701         #    quota:
   1702         #
   1703         #      - name: apiWriteQpsPerProject
   1704         #        metric: library.googleapis.com/write_calls
   1705         #        unit: "1/min/{project}"  # rate limit for consumer projects
   1706         #        values:
   1707         #          STANDARD: 10000
   1708         #
   1709         #
   1710         #      # The metric rules bind all methods to the read_calls metric,
   1711         #      # except for the UpdateBook and DeleteBook methods. These two methods
   1712         #      # are mapped to the write_calls metric, with the UpdateBook method
   1713         #      # consuming at twice rate as the DeleteBook method.
   1714         #      metric_rules:
   1715         #      - selector: "*"
   1716         #        metric_costs:
   1717         #          library.googleapis.com/read_calls: 1
   1718         #      - selector: google.example.library.v1.LibraryService.UpdateBook
   1719         #        metric_costs:
   1720         #          library.googleapis.com/write_calls: 2
   1721         #      - selector: google.example.library.v1.LibraryService.DeleteBook
   1722         #        metric_costs:
   1723         #          library.googleapis.com/write_calls: 1
   1724         #
   1725         #  Corresponding Metric definition:
   1726         #
   1727         #      metrics:
   1728         #      - name: library.googleapis.com/read_calls
   1729         #        display_name: Read requests
   1730         #        metric_kind: DELTA
   1731         #        value_type: INT64
   1732         #
   1733         #      - name: library.googleapis.com/write_calls
   1734         #        display_name: Write requests
   1735         #        metric_kind: DELTA
   1736         #        value_type: INT64
   1737       "metricRules": [ # List of `MetricRule` definitions, each one mapping a selected method to one
   1738           # or more metrics.
   1739         { # Bind API methods to metrics. Binding a method to a metric causes that
   1740             # metric's configured quota behaviors to apply to the method call.
   1741           "metricCosts": { # Metrics to update when the selected methods are called, and the associated
   1742               # cost applied to each metric.
   1743               #
   1744               # The key of the map is the metric name, and the values are the amount
   1745               # increased for the metric against which the quota limits are defined.
   1746               # The value must not be negative.
   1747             "a_key": "A String",
   1748           },
   1749           "selector": "A String", # Selects the methods to which this rule applies.
   1750               #
   1751               # Refer to selector for syntax details.
   1752         },
   1753       ],
   1754       "limits": [ # List of `QuotaLimit` definitions for the service.
   1755         { # `QuotaLimit` defines a specific limit that applies over a specified duration
   1756             # for a limit type. There can be at most one limit for a duration and limit
   1757             # type combination defined within a `QuotaGroup`.
   1758           "displayName": "A String", # User-visible display name for this limit.
   1759               # Optional. If not set, the UI will provide a default display name based on
   1760               # the quota configuration. This field can be used to override the default
   1761               # display name generated from the configuration.
   1762           "description": "A String", # Optional. User-visible, extended description for this quota limit.
   1763               # Should be used only when more context is needed to understand this limit
   1764               # than provided by the limit's display name (see: `display_name`).
   1765           "defaultLimit": "A String", # Default number of tokens that can be consumed during the specified
   1766               # duration. This is the number of tokens assigned when a client
   1767               # application developer activates the service for his/her project.
   1768               #
   1769               # Specifying a value of 0 will block all requests. This can be used if you
   1770               # are provisioning quota to selected consumers and blocking others.
   1771               # Similarly, a value of -1 will indicate an unlimited quota. No other
   1772               # negative values are allowed.
   1773               #
   1774               # Used by group-based quotas only.
   1775           "metric": "A String", # The name of the metric this quota limit applies to. The quota limits with
   1776               # the same metric will be checked together during runtime. The metric must be
   1777               # defined within the service config.
   1778               #
   1779               # Used by metric-based quotas only.
   1780           "values": { # Tiered limit values, currently only STANDARD is supported.
   1781             "a_key": "A String",
   1782           },
   1783           "maxLimit": "A String", # Maximum number of tokens that can be consumed during the specified
   1784               # duration. Client application developers can override the default limit up
   1785               # to this maximum. If specified, this value cannot be set to a value less
   1786               # than the default limit. If not specified, it is set to the default limit.
   1787               #
   1788               # To allow clients to apply overrides with no upper bound, set this to -1,
   1789               # indicating unlimited maximum quota.
   1790               #
   1791               # Used by group-based quotas only.
   1792           "duration": "A String", # Duration of this limit in textual notation. Example: "100s", "24h", "1d".
   1793               # For duration longer than a day, only multiple of days is supported. We
   1794               # support only "100s" and "1d" for now. Additional support will be added in
   1795               # the future. "0" indicates indefinite duration.
   1796               #
   1797               # Used by group-based quotas only.
   1798           "freeTier": "A String", # Free tier value displayed in the Developers Console for this limit.
   1799               # The free tier is the number of tokens that will be subtracted from the
   1800               # billed amount when billing is enabled.
   1801               # This field can only be set on a limit with duration "1d", in a billable
   1802               # group; it is invalid on any other limit. If this field is not set, it
   1803               # defaults to 0, indicating that there is no free tier for this service.
   1804               #
   1805               # Used by group-based quotas only.
   1806           "unit": "A String", # Specify the unit of the quota limit. It uses the same syntax as
   1807               # Metric.unit. The supported unit kinds are determined by the quota
   1808               # backend system.
   1809               #
   1810               # The [Google Service Control](https://cloud.google.com/service-control)
   1811               # supports the following unit components:
   1812               # * One of the time intevals:
   1813               #   * "/min"  for quota every minute.
   1814               #   * "/d"  for quota every 24 hours, starting 00:00 US Pacific Time.
   1815               #   * Otherwise the quota won't be reset by time, such as storage limit.
   1816               # * One and only one of the granted containers:
   1817               #   * "/{project}" quota for a project
   1818               #
   1819               # Here are some examples:
   1820               # * "1/min/{project}" for quota per minute per project.
   1821               #
   1822               # Note: the order of unit components is insignificant.
   1823               # The "1" at the beginning is required to follow the metric unit syntax.
   1824               #
   1825               # Used by metric-based quotas only.
   1826           "name": "A String", # Name of the quota limit. The name is used to refer to the limit when
   1827               # overriding the default limit on per-consumer basis.
   1828               #
   1829               # For metric-based quota limits, the name must be provided, and it must be
   1830               # unique within the service. The name can only include alphanumeric
   1831               # characters as well as '-'.
   1832               #
   1833               # The maximum length of the limit name is 64 characters.
   1834               #
   1835               # The name of a limit is used as a unique identifier for this limit.
   1836               # Therefore, once a limit has been put into use, its name should be
   1837               # immutable. You can use the display_name field to provide a user-friendly
   1838               # name for the limit. The display name can be evolved over time without
   1839               # affecting the identity of the limit.
   1840         },
   1841       ],
   1842     },
   1843     "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
   1844         # elements.  Restrictions are specified using visibility labels
   1845         # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
   1846         #
   1847         # Users and projects can have access to more than one visibility label. The
   1848         # effective visibility for multiple labels is the union of each label's
   1849         # elements, plus any unrestricted elements.
   1850         #
   1851         # If an element and its parents have no restrictions, visibility is
   1852         # unconditionally granted.
   1853         #
   1854         # Example:
   1855         #
   1856         #     visibility:
   1857         #       rules:
   1858         #       - selector: google.calendar.Calendar.EnhancedSearch
   1859         #         restriction: TRUSTED_TESTER
   1860         #       - selector: google.calendar.Calendar.Delegate
   1861         #         restriction: GOOGLE_INTERNAL
   1862         #
   1863         # Here, all methods are publicly visible except for the restricted methods
   1864         # EnhancedSearch and Delegate.
   1865       "rules": [ # A list of visibility rules that apply to individual API elements.
   1866           #
   1867           # **NOTE:** All service configuration rules follow "last one wins" order.
   1868         { # A visibility rule provides visibility configuration for an individual API
   1869             # element.
   1870           "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
   1871               # Any of the listed labels can be used to grant the visibility.
   1872               #
   1873               # If a rule has multiple labels, removing one of the labels but not all of
   1874               # them can break clients.
   1875               #
   1876               # Example:
   1877               #
   1878               #     visibility:
   1879               #       rules:
   1880               #       - selector: google.calendar.Calendar.EnhancedSearch
   1881               #         restriction: GOOGLE_INTERNAL, TRUSTED_TESTER
   1882               #
   1883               # Removing GOOGLE_INTERNAL from this restriction will break clients that
   1884               # rely on this method and only had access to it through GOOGLE_INTERNAL.
   1885           "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
   1886               #
   1887               # Refer to selector for syntax details.
   1888         },
   1889       ],
   1890     },
   1891     "metrics": [ # Defines the metrics used by this service.
   1892       { # Defines a metric type and its schema. Once a metric descriptor is created,
   1893           # deleting or altering it stops data collection and makes the metric type's
   1894           # existing data unusable.
   1895         "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
   1896             # Use sentence case without an ending period, for example "Request count".
   1897         "description": "A String", # A detailed description of the metric, which can be used in documentation.
   1898         "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
   1899             # Some combinations of `metric_kind` and `value_type` might not be supported.
   1900         "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
   1901             # Some combinations of `metric_kind` and `value_type` might not be supported.
   1902         "labels": [ # The set of labels that can be used to describe a specific
   1903             # instance of this metric type. For example, the
   1904             # `appengine.googleapis.com/http/server/response_latencies` metric
   1905             # type has a label for the HTTP response code, `response_code`, so
   1906             # you can look at latencies for successful responses or just
   1907             # for responses that failed.
   1908           { # A description of a label.
   1909             "valueType": "A String", # The type of data that can be assigned to the label.
   1910             "description": "A String", # A human-readable description for the label.
   1911             "key": "A String", # The label key.
   1912           },
   1913         ],
   1914         "type": "A String", # The metric type, including its DNS name prefix. The type is not
   1915             # URL-encoded.  All user-defined custom metric types have the DNS name
   1916             # `custom.googleapis.com`.  Metric types should use a natural hierarchical
   1917             # grouping. For example:
   1918             #
   1919             #     "custom.googleapis.com/invoice/paid/amount"
   1920             #     "appengine.googleapis.com/http/server/response_latencies"
   1921         "unit": "A String", # The unit in which the metric value is reported. It is only applicable
   1922             # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
   1923             # supported units are a subset of [The Unified Code for Units of
   1924             # Measure](http://unitsofmeasure.org/ucum.html) standard:
   1925             #
   1926             # **Basic units (UNIT)**
   1927             #
   1928             # * `bit`   bit
   1929             # * `By`    byte
   1930             # * `s`     second
   1931             # * `min`   minute
   1932             # * `h`     hour
   1933             # * `d`     day
   1934             #
   1935             # **Prefixes (PREFIX)**
   1936             #
   1937             # * `k`     kilo    (10**3)
   1938             # * `M`     mega    (10**6)
   1939             # * `G`     giga    (10**9)
   1940             # * `T`     tera    (10**12)
   1941             # * `P`     peta    (10**15)
   1942             # * `E`     exa     (10**18)
   1943             # * `Z`     zetta   (10**21)
   1944             # * `Y`     yotta   (10**24)
   1945             # * `m`     milli   (10**-3)
   1946             # * `u`     micro   (10**-6)
   1947             # * `n`     nano    (10**-9)
   1948             # * `p`     pico    (10**-12)
   1949             # * `f`     femto   (10**-15)
   1950             # * `a`     atto    (10**-18)
   1951             # * `z`     zepto   (10**-21)
   1952             # * `y`     yocto   (10**-24)
   1953             # * `Ki`    kibi    (2**10)
   1954             # * `Mi`    mebi    (2**20)
   1955             # * `Gi`    gibi    (2**30)
   1956             # * `Ti`    tebi    (2**40)
   1957             #
   1958             # **Grammar**
   1959             #
   1960             # The grammar includes the dimensionless unit `1`, such as `1/s`.
   1961             #
   1962             # The grammar also includes these connectors:
   1963             #
   1964             # * `/`    division (as an infix operator, e.g. `1/s`).
   1965             # * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
   1966             #
   1967             # The grammar for a unit is as follows:
   1968             #
   1969             #     Expression = Component { "." Component } { "/" Component } ;
   1970             #
   1971             #     Component = [ PREFIX ] UNIT [ Annotation ]
   1972             #               | Annotation
   1973             #               | "1"
   1974             #               ;
   1975             #
   1976             #     Annotation = "{" NAME "}" ;
   1977             #
   1978             # Notes:
   1979             #
   1980             # * `Annotation` is just a comment if it follows a `UNIT` and is
   1981             #    equivalent to `1` if it is used alone. For examples,
   1982             #    `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
   1983             # * `NAME` is a sequence of non-blank printable ASCII characters not
   1984             #    containing '{' or '}'.
   1985         "name": "A String", # The resource name of the metric descriptor. Depending on the
   1986             # implementation, the name typically includes: (1) the parent resource name
   1987             # that defines the scope of the metric type or of its data; and (2) the
   1988             # metric's URL-encoded type, which also appears in the `type` field of this
   1989             # descriptor. For example, following is the resource name of a custom
   1990             # metric within the GCP project `my-project-id`:
   1991             #
   1992             #     "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
   1993       },
   1994     ],
   1995     "enums": [ # A list of all enum types included in this API service.  Enums
   1996         # referenced directly or indirectly by the `apis` are automatically
   1997         # included.  Enums which are not referenced but shall be included
   1998         # should be listed here by name. Example:
   1999         #
   2000         #     enums:
   2001         #     - name: google.someapi.v1.SomeEnum
   2002       { # Enum type definition.
   2003         "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
   2004             # protobuf element, like the file in which it is defined.
   2005           "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
   2006               # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
   2007         },
   2008         "enumvalue": [ # Enum value definitions.
   2009           { # Enum value definition.
   2010             "options": [ # Protocol buffer options.
   2011               { # A protocol buffer option, which can be attached to a message, field,
   2012                   # enumeration, etc.
   2013                 "name": "A String", # The option's name. For protobuf built-in options (options defined in
   2014                     # descriptor.proto), this is the short name. For example, `"map_entry"`.
   2015                     # For custom options, it should be the fully-qualified name. For example,
   2016                     # `"google.api.http"`.
   2017                 "value": { # The option's value packed in an Any message. If the value is a primitive,
   2018                     # the corresponding wrapper type defined in google/protobuf/wrappers.proto
   2019                     # should be used. If the value is an enum, it should be stored as an int32
   2020                     # value using the google.protobuf.Int32Value type.
   2021                   "a_key": "", # Properties of the object. Contains field @type with type URL.
   2022                 },
   2023               },
   2024             ],
   2025             "name": "A String", # Enum value name.
   2026             "number": 42, # Enum value number.
   2027           },
   2028         ],
   2029         "options": [ # Protocol buffer options.
   2030           { # A protocol buffer option, which can be attached to a message, field,
   2031               # enumeration, etc.
   2032             "name": "A String", # The option's name. For protobuf built-in options (options defined in
   2033                 # descriptor.proto), this is the short name. For example, `"map_entry"`.
   2034                 # For custom options, it should be the fully-qualified name. For example,
   2035                 # `"google.api.http"`.
   2036             "value": { # The option's value packed in an Any message. If the value is a primitive,
   2037                 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
   2038                 # should be used. If the value is an enum, it should be stored as an int32
   2039                 # value using the google.protobuf.Int32Value type.
   2040               "a_key": "", # Properties of the object. Contains field @type with type URL.
   2041             },
   2042           },
   2043         ],
   2044         "name": "A String", # Enum type name.
   2045         "syntax": "A String", # The source syntax.
   2046       },
   2047     ],
   2048     "types": [ # A list of all proto message types included in this API service.
   2049         # Types referenced directly or indirectly by the `apis` are
   2050         # automatically included.  Messages which are not referenced but
   2051         # shall be included, such as types used by the `google.protobuf.Any` type,
   2052         # should be listed here by name. Example:
   2053         #
   2054         #     types:
   2055         #     - name: google.protobuf.Int32
   2056       { # A protocol buffer message type.
   2057         "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
   2058           "A String",
   2059         ],
   2060         "name": "A String", # The fully qualified message name.
   2061         "fields": [ # The list of fields.
   2062           { # A single field of a message type.
   2063             "kind": "A String", # The field type.
   2064             "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
   2065                 # types. The first type has index 1; zero means the type is not in the list.
   2066             "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
   2067                 # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
   2068             "name": "A String", # The field name.
   2069             "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
   2070             "jsonName": "A String", # The field JSON name.
   2071             "number": 42, # The field number.
   2072             "cardinality": "A String", # The field cardinality.
   2073             "options": [ # The protocol buffer options.
   2074               { # A protocol buffer option, which can be attached to a message, field,
   2075                   # enumeration, etc.
   2076                 "name": "A String", # The option's name. For protobuf built-in options (options defined in
   2077                     # descriptor.proto), this is the short name. For example, `"map_entry"`.
   2078                     # For custom options, it should be the fully-qualified name. For example,
   2079                     # `"google.api.http"`.
   2080                 "value": { # The option's value packed in an Any message. If the value is a primitive,
   2081                     # the corresponding wrapper type defined in google/protobuf/wrappers.proto
   2082                     # should be used. If the value is an enum, it should be stored as an int32
   2083                     # value using the google.protobuf.Int32Value type.
   2084                   "a_key": "", # Properties of the object. Contains field @type with type URL.
   2085                 },
   2086               },
   2087             ],
   2088             "packed": True or False, # Whether to use alternative packed wire representation.
   2089           },
   2090         ],
   2091         "syntax": "A String", # The source syntax.
   2092         "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
   2093             # protobuf element, like the file in which it is defined.
   2094           "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
   2095               # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
   2096         },
   2097         "options": [ # The protocol buffer options.
   2098           { # A protocol buffer option, which can be attached to a message, field,
   2099               # enumeration, etc.
   2100             "name": "A String", # The option's name. For protobuf built-in options (options defined in
   2101                 # descriptor.proto), this is the short name. For example, `"map_entry"`.
   2102                 # For custom options, it should be the fully-qualified name. For example,
   2103                 # `"google.api.http"`.
   2104             "value": { # The option's value packed in an Any message. If the value is a primitive,
   2105                 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
   2106                 # should be used. If the value is an enum, it should be stored as an int32
   2107                 # value using the google.protobuf.Int32Value type.
   2108               "a_key": "", # Properties of the object. Contains field @type with type URL.
   2109             },
   2110           },
   2111         ],
   2112       },
   2113     ],
   2114     "logging": { # Logging configuration of the service. # Logging configuration.
   2115         #
   2116         # The following example shows how to configure logs to be sent to the
   2117         # producer and consumer projects. In the example, the `activity_history`
   2118         # log is sent to both the producer and consumer projects, whereas the
   2119         # `purchase_history` log is only sent to the producer project.
   2120         #
   2121         #     monitored_resources:
   2122         #     - type: library.googleapis.com/branch
   2123         #       labels:
   2124         #       - key: /city
   2125         #         description: The city where the library branch is located in.
   2126         #       - key: /name
   2127         #         description: The name of the branch.
   2128         #     logs:
   2129         #     - name: activity_history
   2130         #       labels:
   2131         #       - key: /customer_id
   2132         #     - name: purchase_history
   2133         #     logging:
   2134         #       producer_destinations:
   2135         #       - monitored_resource: library.googleapis.com/branch
   2136         #         logs:
   2137         #         - activity_history
   2138         #         - purchase_history
   2139         #       consumer_destinations:
   2140         #       - monitored_resource: library.googleapis.com/branch
   2141         #         logs:
   2142         #         - activity_history
   2143       "producerDestinations": [ # Logging configurations for sending logs to the producer project.
   2144           # There can be multiple producer destinations, each one must have a
   2145           # different monitored resource type. A log can be used in at most
   2146           # one producer destination.
   2147         { # Configuration of a specific logging destination (the producer project
   2148             # or the consumer project).
   2149           "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
   2150               # Service.monitored_resources section.
   2151           "logs": [ # Names of the logs to be sent to this destination. Each name must
   2152               # be defined in the Service.logs section. If the log name is
   2153               # not a domain scoped name, it will be automatically prefixed with
   2154               # the service name followed by "/".
   2155             "A String",
   2156           ],
   2157         },
   2158       ],
   2159       "consumerDestinations": [ # Logging configurations for sending logs to the consumer project.
   2160           # There can be multiple consumer destinations, each one must have a
   2161           # different monitored resource type. A log can be used in at most
   2162           # one consumer destination.
   2163         { # Configuration of a specific logging destination (the producer project
   2164             # or the consumer project).
   2165           "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
   2166               # Service.monitored_resources section.
   2167           "logs": [ # Names of the logs to be sent to this destination. Each name must
   2168               # be defined in the Service.logs section. If the log name is
   2169               # not a domain scoped name, it will be automatically prefixed with
   2170               # the service name followed by "/".
   2171             "A String",
   2172           ],
   2173         },
   2174       ],
   2175     },
   2176     "name": "A String", # The DNS address at which this service is available,
   2177         # e.g. `calendar.googleapis.com`.
   2178     "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
   2179         #
   2180         # Example:
   2181         # <pre><code>documentation:
   2182         #   summary: >
   2183         #     The Google Calendar API gives access
   2184         #     to most calendar features.
   2185         #   pages:
   2186         #   - name: Overview
   2187         #     content: &#40;== include google/foo/overview.md ==&#41;
   2188         #   - name: Tutorial
   2189         #     content: &#40;== include google/foo/tutorial.md ==&#41;
   2190         #     subpages;
   2191         #     - name: Java
   2192         #       content: &#40;== include google/foo/tutorial_java.md ==&#41;
   2193         #   rules:
   2194         #   - selector: google.calendar.Calendar.Get
   2195         #     description: >
   2196         #       ...
   2197         #   - selector: google.calendar.Calendar.Put
   2198         #     description: >
   2199         #       ...
   2200         # </code></pre>
   2201         # Documentation is provided in markdown syntax. In addition to
   2202         # standard markdown features, definition lists, tables and fenced
   2203         # code blocks are supported. Section headers can be provided and are
   2204         # interpreted relative to the section nesting of the context where
   2205         # a documentation fragment is embedded.
   2206         #
   2207         # Documentation from the IDL is merged with documentation defined
   2208         # via the config at normalization time, where documentation provided
   2209         # by config rules overrides IDL provided.
   2210         #
   2211         # A number of constructs specific to the API platform are supported
   2212         # in documentation text.
   2213         #
   2214         # In order to reference a proto element, the following
   2215         # notation can be used:
   2216         # <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
   2217         # To override the display text used for the link, this can be used:
   2218         # <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
   2219         # Text can be excluded from doc using the following notation:
   2220         # <pre><code>&#40;-- internal comment --&#41;</code></pre>
   2221         # Comments can be made conditional using a visibility label. The below
   2222         # text will be only rendered if the `BETA` label is available:
   2223         # <pre><code>&#40;--BETA: comment for BETA users --&#41;</code></pre>
   2224         # A few directives are available in documentation. Note that
   2225         # directives must appear on a single line to be properly
   2226         # identified. The `include` directive includes a markdown file from
   2227         # an external source:
   2228         # <pre><code>&#40;== include path/to/file ==&#41;</code></pre>
   2229         # The `resource_for` directive marks a message to be the resource of
   2230         # a collection in REST view. If it is not specified, tools attempt
   2231         # to infer the resource from the operations in a collection:
   2232         # <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>
   2233         # The directive `suppress_warning` does not directly affect documentation
   2234         # and is documented together with service config validation.
   2235       "rules": [ # A list of documentation rules that apply to individual API elements.
   2236           #
   2237           # **NOTE:** All service configuration rules follow "last one wins" order.
   2238         { # A documentation rule provides information about individual API elements.
   2239           "description": "A String", # Description of the selected API(s).
   2240           "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
   2241               # element is marked as `deprecated`.
   2242           "selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a
   2243               # qualified name of the element which may end in "*", indicating a wildcard.
   2244               # Wildcards are only allowed at the end and for a whole component of the
   2245               # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
   2246               # specify a default for all applicable elements, the whole pattern "*"
   2247               # is used.
   2248         },
   2249       ],
   2250       "documentationRootUrl": "A String", # The URL to the root of documentation.
   2251       "overview": "A String", # Declares a single overview page. For example:
   2252           # <pre><code>documentation:
   2253           #   summary: ...
   2254           #   overview: &#40;== include overview.md ==&#41;
   2255           # </code></pre>
   2256           # This is a shortcut for the following declaration (using pages style):
   2257           # <pre><code>documentation:
   2258           #   summary: ...
   2259           #   pages:
   2260           #   - name: Overview
   2261           #     content: &#40;== include overview.md ==&#41;
   2262           # </code></pre>
   2263           # Note: you cannot specify both `overview` field and `pages` field.
   2264       "pages": [ # The top level pages for the documentation set.
   2265         { # Represents a documentation page. A page can contain subpages to represent
   2266             # nested documentation set structure.
   2267           "content": "A String", # The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code>
   2268               # to include content from a Markdown file.
   2269           "subpages": [ # Subpages of this page. The order of subpages specified here will be
   2270               # honored in the generated docset.
   2271             # Object with schema name: Page
   2272           ],
   2273           "name": "A String", # The name of the page. It will be used as an identity of the page to
   2274               # generate URI of the page, text of the link to this page in navigation,
   2275               # etc. The full page name (start from the root page name to this page
   2276               # concatenated with `.`) can be used as reference to the page in your
   2277               # documentation. For example:
   2278               # <pre><code>pages:
   2279               # - name: Tutorial
   2280               #   content: &#40;== include tutorial.md ==&#41;
   2281               #   subpages:
   2282               #   - name: Java
   2283               #     content: &#40;== include tutorial_java.md ==&#41;
   2284               # </code></pre>
   2285               # You can reference `Java` page using Markdown reference link syntax:
   2286               # `Java`.
   2287         },
   2288       ],
   2289       "summary": "A String", # A short summary of what the service does. Can only be provided by
   2290           # plain text.
   2291     },
   2292     "sourceInfo": { # Source information used to create a Service Config # Output only. The source information for this configuration if available.
   2293       "sourceFiles": [ # All files used during config generation.
   2294         {
   2295           "a_key": "", # Properties of the object. Contains field @type with type URL.
   2296         },
   2297       ],
   2298     },
   2299     "systemTypes": [ # A list of all proto message types included in this API service.
   2300         # It serves similar purpose as [google.api.Service.types], except that
   2301         # these types are not needed by user-defined APIs. Therefore, they will not
   2302         # show up in the generated discovery doc. This field should only be used
   2303         # to define system APIs in ESF.
   2304       { # A protocol buffer message type.
   2305         "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
   2306           "A String",
   2307         ],
   2308         "name": "A String", # The fully qualified message name.
   2309         "fields": [ # The list of fields.
   2310           { # A single field of a message type.
   2311             "kind": "A String", # The field type.
   2312             "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
   2313                 # types. The first type has index 1; zero means the type is not in the list.
   2314             "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
   2315                 # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
   2316             "name": "A String", # The field name.
   2317             "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
   2318             "jsonName": "A String", # The field JSON name.
   2319             "number": 42, # The field number.
   2320             "cardinality": "A String", # The field cardinality.
   2321             "options": [ # The protocol buffer options.
   2322               { # A protocol buffer option, which can be attached to a message, field,
   2323                   # enumeration, etc.
   2324                 "name": "A String", # The option's name. For protobuf built-in options (options defined in
   2325                     # descriptor.proto), this is the short name. For example, `"map_entry"`.
   2326                     # For custom options, it should be the fully-qualified name. For example,
   2327                     # `"google.api.http"`.
   2328                 "value": { # The option's value packed in an Any message. If the value is a primitive,
   2329                     # the corresponding wrapper type defined in google/protobuf/wrappers.proto
   2330                     # should be used. If the value is an enum, it should be stored as an int32
   2331                     # value using the google.protobuf.Int32Value type.
   2332                   "a_key": "", # Properties of the object. Contains field @type with type URL.
   2333                 },
   2334               },
   2335             ],
   2336             "packed": True or False, # Whether to use alternative packed wire representation.
   2337           },
   2338         ],
   2339         "syntax": "A String", # The source syntax.
   2340         "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
   2341             # protobuf element, like the file in which it is defined.
   2342           "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
   2343               # protobuf element.  For example: `"google/protobuf/source_context.proto"`.
   2344         },
   2345         "options": [ # The protocol buffer options.
   2346           { # A protocol buffer option, which can be attached to a message, field,
   2347               # enumeration, etc.
   2348             "name": "A String", # The option's name. For protobuf built-in options (options defined in
   2349                 # descriptor.proto), this is the short name. For example, `"map_entry"`.
   2350                 # For custom options, it should be the fully-qualified name. For example,
   2351                 # `"google.api.http"`.
   2352             "value": { # The option's value packed in an Any message. If the value is a primitive,
   2353                 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
   2354                 # should be used. If the value is an enum, it should be stored as an int32
   2355                 # value using the google.protobuf.Int32Value type.
   2356               "a_key": "", # Properties of the object. Contains field @type with type URL.
   2357             },
   2358           },
   2359         ],
   2360       },
   2361     ],
   2362     "context": { # `Context` defines which contexts an API requests. # Context configuration.
   2363         #
   2364         # Example:
   2365         #
   2366         #     context:
   2367         #       rules:
   2368         #       - selector: "*"
   2369         #         requested:
   2370         #         - google.rpc.context.ProjectContext
   2371         #         - google.rpc.context.OriginContext
   2372         #
   2373         # The above specifies that all methods in the API request
   2374         # `google.rpc.context.ProjectContext` and
   2375         # `google.rpc.context.OriginContext`.
   2376         #
   2377         # Available context types are defined in package
   2378         # `google.rpc.context`.
   2379       "rules": [ # A list of RPC context rules that apply to individual API methods.
   2380           #
   2381           # **NOTE:** All service configuration rules follow "last one wins" order.
   2382         { # A context rule provides information about the context for an individual API
   2383             # element.
   2384           "provided": [ # A list of full type names of provided contexts.
   2385             "A String",
   2386           ],
   2387           "selector": "A String", # Selects the methods to which this rule applies.
   2388               #
   2389               # Refer to selector for syntax details.
   2390           "requested": [ # A list of full type names of requested contexts.
   2391             "A String",
   2392           ],
   2393         },
   2394       ],
   2395     },
   2396     "endpoints": [ # Configuration for network endpoints.  If this is empty, then an endpoint
   2397         # with the same name as the service is automatically generated to service all
   2398         # defined APIs.
   2399       { # `Endpoint` describes a network endpoint that serves a set of APIs.
   2400           # A service may expose any number of endpoints, and all endpoints share the
   2401           # same service configuration, such as quota configuration and monitoring
   2402           # configuration.
   2403           #
   2404           # Example service configuration:
   2405           #
   2406           #     name: library-example.googleapis.com
   2407           #     endpoints:
   2408           #       # Below entry makes 'google.example.library.v1.Library'
   2409           #       # API be served from endpoint address library-example.googleapis.com.
   2410           #       # It also allows HTTP OPTIONS calls to be passed to the backend, for
   2411           #       # it to decide whether the subsequent cross-origin request is
   2412           #       # allowed to proceed.
   2413           #     - name: library-example.googleapis.com
   2414           #       allow_cors: true
   2415         "target": "A String", # The specification of an Internet routable address of API frontend that will
   2416             # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).
   2417             # It should be either a valid IPv4 address or a fully-qualified domain name.
   2418             # For example, "8.8.8.8" or "myservice.appspot.com".
   2419         "apis": [ # The list of APIs served by this endpoint.
   2420             #
   2421             # If no APIs are specified this translates to "all APIs" exported by the
   2422             # service, as defined in the top-level service configuration.
   2423           "A String",
   2424         ],
   2425         "allowCors": True or False, # Allowing
   2426             # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
   2427             # cross-domain traffic, would allow the backends served from this endpoint to
   2428             # receive and respond to HTTP OPTIONS requests. The response will be used by
   2429             # the browser to determine whether the subsequent cross-origin request is
   2430             # allowed to proceed.
   2431         "name": "A String", # The canonical name of this endpoint.
   2432         "features": [ # The list of features enabled on this endpoint.
   2433           "A String",
   2434         ],
   2435         "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
   2436             # please specify multiple google.api.Endpoint for each of the intented
   2437             # alias.
   2438             #
   2439             # Additional names that this endpoint will be hosted on.
   2440           "A String",
   2441         ],
   2442       },
   2443     ],
   2444     "experimental": { # Experimental service configuration. These configuration options can # Experimental configuration.
   2445         # only be used by whitelisted users.
   2446       "authorization": { # Configuration of authorization. # Authorization configuration.
   2447           #
   2448           # This section determines the authorization provider, if unspecified, then no
   2449           # authorization check will be done.
   2450           #
   2451           # Example:
   2452           #
   2453           #     experimental:
   2454           #       authorization:
   2455           #         provider: firebaserules.googleapis.com
   2456         "provider": "A String", # The name of the authorization provider, such as
   2457             # firebaserules.googleapis.com.
   2458       },
   2459     },
   2460   }</pre>
   2461 </div>
   2462 
   2463 <div class="method">
   2464     <code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code>
   2465   <pre>Gets the access control policy for a resource.
   2466 Returns an empty policy if the resource exists and does not have a policy
   2467 set.
   2468 
   2469 Args:
   2470   resource: string, REQUIRED: The resource for which the policy is being requested.
   2471 See the operation documentation for the appropriate value for this field. (required)
   2472   body: object, The request body. (required)
   2473     The object takes the form of:
   2474 
   2475 { # Request message for `GetIamPolicy` method.
   2476   }
   2477 
   2478   x__xgafv: string, V1 error format.
   2479     Allowed values
   2480       1 - v1 error format
   2481       2 - v2 error format
   2482 
   2483 Returns:
   2484   An object of the form:
   2485 
   2486     { # Defines an Identity and Access Management (IAM) policy. It is used to
   2487       # specify access control policies for Cloud Platform resources.
   2488       #
   2489       #
   2490       # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
   2491       # `members` to a `role`, where the members can be user accounts, Google groups,
   2492       # Google domains, and service accounts. A `role` is a named list of permissions
   2493       # defined by IAM.
   2494       #
   2495       # **Example**
   2496       #
   2497       #     {
   2498       #       "bindings": [
   2499       #         {
   2500       #           "role": "roles/owner",
   2501       #           "members": [
   2502       #             "user:mike (a] example.com",
   2503       #             "group:admins (a] example.com",
   2504       #             "domain:google.com",
   2505       #             "serviceAccount:my-other-app (a] appspot.gserviceaccount.com",
   2506       #           ]
   2507       #         },
   2508       #         {
   2509       #           "role": "roles/viewer",
   2510       #           "members": ["user:sean (a] example.com"]
   2511       #         }
   2512       #       ]
   2513       #     }
   2514       #
   2515       # For a description of IAM and its features, see the
   2516       # [IAM developer's guide](https://cloud.google.com/iam).
   2517     "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
   2518       { # Specifies the audit configuration for a service.
   2519           # The configuration determines which permission types are logged, and what
   2520           # identities, if any, are exempted from logging.
   2521           # An AuditConfig must have one or more AuditLogConfigs.
   2522           #
   2523           # If there are AuditConfigs for both `allServices` and a specific service,
   2524           # the union of the two AuditConfigs is used for that service: the log_types
   2525           # specified in each AuditConfig are enabled, and the exempted_members in each
   2526           # AuditConfig are exempted.
   2527           #
   2528           # Example Policy with multiple AuditConfigs:
   2529           #
   2530           #     {
   2531           #       "audit_configs": [
   2532           #         {
   2533           #           "service": "allServices"
   2534           #           "audit_log_configs": [
   2535           #             {
   2536           #               "log_type": "DATA_READ",
   2537           #               "exempted_members": [
   2538           #                 "user:foo (a] gmail.com"
   2539           #               ]
   2540           #             },
   2541           #             {
   2542           #               "log_type": "DATA_WRITE",
   2543           #             },
   2544           #             {
   2545           #               "log_type": "ADMIN_READ",
   2546           #             }
   2547           #           ]
   2548           #         },
   2549           #         {
   2550           #           "service": "fooservice.googleapis.com"
   2551           #           "audit_log_configs": [
   2552           #             {
   2553           #               "log_type": "DATA_READ",
   2554           #             },
   2555           #             {
   2556           #               "log_type": "DATA_WRITE",
   2557           #               "exempted_members": [
   2558           #                 "user:bar (a] gmail.com"
   2559           #               ]
   2560           #             }
   2561           #           ]
   2562           #         }
   2563           #       ]
   2564           #     }
   2565           #
   2566           # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
   2567           # logging. It also exempts foo (a] gmail.com from DATA_READ logging, and
   2568           # bar (a] gmail.com from DATA_WRITE logging.
   2569         "exemptedMembers": [
   2570           "A String",
   2571         ],
   2572         "auditLogConfigs": [ # The configuration for logging of each type of permission.
   2573             # Next ID: 4
   2574           { # Provides the configuration for logging a type of permissions.
   2575               # Example:
   2576               #
   2577               #     {
   2578               #       "audit_log_configs": [
   2579               #         {
   2580               #           "log_type": "DATA_READ",
   2581               #           "exempted_members": [
   2582               #             "user:foo (a] gmail.com"
   2583               #           ]
   2584               #         },
   2585               #         {
   2586               #           "log_type": "DATA_WRITE",
   2587               #         }
   2588               #       ]
   2589               #     }
   2590               #
   2591               # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
   2592               # foo (a] gmail.com from DATA_READ logging.
   2593             "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
   2594                 # permission.
   2595                 # Follows the same format of Binding.members.
   2596               "A String",
   2597             ],
   2598             "logType": "A String", # The log type that this config enables.
   2599           },
   2600         ],
   2601         "service": "A String", # Specifies a service that will be enabled for audit logging.
   2602             # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
   2603             # `allServices` is a special value that covers all services.
   2604       },
   2605     ],
   2606     "rules": [ # If more than one rule is specified, the rules are applied in the following
   2607         # manner:
   2608         # - All matching LOG rules are always applied.
   2609         # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
   2610         #   Logging will be applied if one or more matching rule requires logging.
   2611         # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
   2612         #   granted.
   2613         #   Logging will be applied if one or more matching rule requires logging.
   2614         # - Otherwise, if no rule applies, permission is denied.
   2615       { # A rule to be applied in a Policy.
   2616         "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
   2617             # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
   2618             # The format for in and not_in entries is the same as for members in a
   2619             # Binding (see google/iam/v1/policy.proto).
   2620           "A String",
   2621         ],
   2622         "description": "A String", # Human-readable description of the rule.
   2623         "in": [ # If one or more 'in' clauses are specified, the rule matches if
   2624             # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
   2625           "A String",
   2626         ],
   2627         "action": "A String", # Required
   2628         "conditions": [ # Additional restrictions that must be met
   2629           { # A condition to be met.
   2630             "iam": "A String", # Trusted attributes supplied by the IAM system.
   2631             "svc": "A String", # Trusted attributes discharged by the service.
   2632             "value": "A String", # DEPRECATED. Use 'values' instead.
   2633             "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
   2634                 # the IAM system for access control.
   2635             "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
   2636               "A String",
   2637             ],
   2638             "op": "A String", # An operator to apply the subject with.
   2639           },
   2640         ],
   2641         "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
   2642             # that match the LOG action.
   2643           { # Specifies what kind of log the caller must write
   2644             "counter": { # Options for counters # Counter options.
   2645               "field": "A String", # The field value to attribute.
   2646               "metric": "A String", # The metric to update.
   2647             },
   2648             "dataAccess": { # Write a Data Access (Gin) log # Data access options.
   2649             },
   2650             "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
   2651               "logName": "A String", # The log_name to populate in the Cloud Audit Record.
   2652             },
   2653           },
   2654         ],
   2655         "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
   2656             # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
   2657             # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
   2658           "A String",
   2659         ],
   2660       },
   2661     ],
   2662     "version": 42, # Version of the `Policy`. The default version is 0.
   2663     "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
   2664         # prevent simultaneous updates of a policy from overwriting each other.
   2665         # It is strongly suggested that systems make use of the `etag` in the
   2666         # read-modify-write cycle to perform policy updates in order to avoid race
   2667         # conditions: An `etag` is returned in the response to `getIamPolicy`, and
   2668         # systems are expected to put that etag in the request to `setIamPolicy` to
   2669         # ensure that their change will be applied to the same version of the policy.
   2670         #
   2671         # If no `etag` is provided in the call to `setIamPolicy`, then the existing
   2672         # policy is overwritten blindly.
   2673     "bindings": [ # Associates a list of `members` to a `role`.
   2674         # Multiple `bindings` must not be specified for the same `role`.
   2675         # `bindings` with no members will result in an error.
   2676       { # Associates `members` with a `role`.
   2677         "role": "A String", # Role that is assigned to `members`.
   2678             # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
   2679             # Required
   2680         "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
   2681             # `members` can have the following values:
   2682             #
   2683             # * `allUsers`: A special identifier that represents anyone who is
   2684             #    on the internet; with or without a Google account.
   2685             #
   2686             # * `allAuthenticatedUsers`: A special identifier that represents anyone
   2687             #    who is authenticated with a Google account or a service account.
   2688             #
   2689             # * `user:{emailid}`: An email address that represents a specific Google
   2690             #    account. For example, `alice (a] gmail.com` or `joe (a] example.com`.
   2691             #
   2692             #
   2693             # * `serviceAccount:{emailid}`: An email address that represents a service
   2694             #    account. For example, `my-other-app (a] appspot.gserviceaccount.com`.
   2695             #
   2696             # * `group:{emailid}`: An email address that represents a Google group.
   2697             #    For example, `admins (a] example.com`.
   2698             #
   2699             #
   2700             # * `domain:{domain}`: A Google Apps domain name that represents all the
   2701             #    users of that domain. For example, `google.com` or `example.com`.
   2702             #
   2703           "A String",
   2704         ],
   2705       },
   2706     ],
   2707     "iamOwned": True or False,
   2708   }</pre>
   2709 </div>
   2710 
   2711 <div class="method">
   2712     <code class="details" id="list">list(producerProjectId=None, pageSize=None, pageToken=None, consumerId=None, x__xgafv=None)</code>
   2713   <pre>Lists managed services.
   2714 
   2715 Returns all public services. For authenticated users, also returns all
   2716 services the calling user has "servicemanagement.services.get" permission
   2717 for.
   2718 
   2719 **BETA:** If the caller specifies the `consumer_id`, it returns only the
   2720 services enabled on the consumer. The `consumer_id` must have the format
   2721 of "project:{PROJECT-ID}".
   2722 
   2723 Args:
   2724   producerProjectId: string, Include services produced by the specified project.
   2725   pageSize: integer, Requested size of the next page of data.
   2726   pageToken: string, Token identifying which result to start with; returned by a previous list
   2727 call.
   2728   consumerId: string, Include services consumed by the specified consumer.
   2729 
   2730 The Google Service Management implementation accepts the following
   2731 forms:
   2732 - project:<project_id>
   2733   x__xgafv: string, V1 error format.
   2734     Allowed values
   2735       1 - v1 error format
   2736       2 - v2 error format
   2737 
   2738 Returns:
   2739   An object of the form:
   2740 
   2741     { # Response message for `ListServices` method.
   2742     "services": [ # The returned services will only have the name field set.
   2743       { # The full representation of a Service that is managed by
   2744           # Google Service Management.
   2745         "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
   2746             # for naming requirements.
   2747         "producerProjectId": "A String", # ID of the project that produces and owns this service.
   2748       },
   2749     ],
   2750     "nextPageToken": "A String", # Token that can be passed to `ListServices` to resume a paginated query.
   2751   }</pre>
   2752 </div>
   2753 
   2754 <div class="method">
   2755     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
   2756   <pre>Retrieves the next page of results.
   2757 
   2758 Args:
   2759   previous_request: The request for the previous page. (required)
   2760   previous_response: The response from the request for the previous page. (required)
   2761 
   2762 Returns:
   2763   A request object that you can call 'execute()' on to request the next
   2764   page. Returns None if there are no more items in the collection.
   2765     </pre>
   2766 </div>
   2767 
   2768 <div class="method">
   2769     <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
   2770   <pre>Sets the access control policy on the specified resource. Replaces any
   2771 existing policy.
   2772 
   2773 Args:
   2774   resource: string, REQUIRED: The resource for which the policy is being specified.
   2775 See the operation documentation for the appropriate value for this field. (required)
   2776   body: object, The request body. (required)
   2777     The object takes the form of:
   2778 
   2779 { # Request message for `SetIamPolicy` method.
   2780     "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
   2781         # the policy is limited to a few 10s of KB. An empty policy is a
   2782         # valid policy but certain Cloud Platform services (such as Projects)
   2783         # might reject them.
   2784         # specify access control policies for Cloud Platform resources.
   2785         #
   2786         #
   2787         # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
   2788         # `members` to a `role`, where the members can be user accounts, Google groups,
   2789         # Google domains, and service accounts. A `role` is a named list of permissions
   2790         # defined by IAM.
   2791         #
   2792         # **Example**
   2793         #
   2794         #     {
   2795         #       "bindings": [
   2796         #         {
   2797         #           "role": "roles/owner",
   2798         #           "members": [
   2799         #             "user:mike (a] example.com",
   2800         #             "group:admins (a] example.com",
   2801         #             "domain:google.com",
   2802         #             "serviceAccount:my-other-app (a] appspot.gserviceaccount.com",
   2803         #           ]
   2804         #         },
   2805         #         {
   2806         #           "role": "roles/viewer",
   2807         #           "members": ["user:sean (a] example.com"]
   2808         #         }
   2809         #       ]
   2810         #     }
   2811         #
   2812         # For a description of IAM and its features, see the
   2813         # [IAM developer's guide](https://cloud.google.com/iam).
   2814       "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
   2815         { # Specifies the audit configuration for a service.
   2816             # The configuration determines which permission types are logged, and what
   2817             # identities, if any, are exempted from logging.
   2818             # An AuditConfig must have one or more AuditLogConfigs.
   2819             #
   2820             # If there are AuditConfigs for both `allServices` and a specific service,
   2821             # the union of the two AuditConfigs is used for that service: the log_types
   2822             # specified in each AuditConfig are enabled, and the exempted_members in each
   2823             # AuditConfig are exempted.
   2824             #
   2825             # Example Policy with multiple AuditConfigs:
   2826             #
   2827             #     {
   2828             #       "audit_configs": [
   2829             #         {
   2830             #           "service": "allServices"
   2831             #           "audit_log_configs": [
   2832             #             {
   2833             #               "log_type": "DATA_READ",
   2834             #               "exempted_members": [
   2835             #                 "user:foo (a] gmail.com"
   2836             #               ]
   2837             #             },
   2838             #             {
   2839             #               "log_type": "DATA_WRITE",
   2840             #             },
   2841             #             {
   2842             #               "log_type": "ADMIN_READ",
   2843             #             }
   2844             #           ]
   2845             #         },
   2846             #         {
   2847             #           "service": "fooservice.googleapis.com"
   2848             #           "audit_log_configs": [
   2849             #             {
   2850             #               "log_type": "DATA_READ",
   2851             #             },
   2852             #             {
   2853             #               "log_type": "DATA_WRITE",
   2854             #               "exempted_members": [
   2855             #                 "user:bar (a] gmail.com"
   2856             #               ]
   2857             #             }
   2858             #           ]
   2859             #         }
   2860             #       ]
   2861             #     }
   2862             #
   2863             # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
   2864             # logging. It also exempts foo (a] gmail.com from DATA_READ logging, and
   2865             # bar (a] gmail.com from DATA_WRITE logging.
   2866           "exemptedMembers": [
   2867             "A String",
   2868           ],
   2869           "auditLogConfigs": [ # The configuration for logging of each type of permission.
   2870               # Next ID: 4
   2871             { # Provides the configuration for logging a type of permissions.
   2872                 # Example:
   2873                 #
   2874                 #     {
   2875                 #       "audit_log_configs": [
   2876                 #         {
   2877                 #           "log_type": "DATA_READ",
   2878                 #           "exempted_members": [
   2879                 #             "user:foo (a] gmail.com"
   2880                 #           ]
   2881                 #         },
   2882                 #         {
   2883                 #           "log_type": "DATA_WRITE",
   2884                 #         }
   2885                 #       ]
   2886                 #     }
   2887                 #
   2888                 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
   2889                 # foo (a] gmail.com from DATA_READ logging.
   2890               "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
   2891                   # permission.
   2892                   # Follows the same format of Binding.members.
   2893                 "A String",
   2894               ],
   2895               "logType": "A String", # The log type that this config enables.
   2896             },
   2897           ],
   2898           "service": "A String", # Specifies a service that will be enabled for audit logging.
   2899               # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
   2900               # `allServices` is a special value that covers all services.
   2901         },
   2902       ],
   2903       "rules": [ # If more than one rule is specified, the rules are applied in the following
   2904           # manner:
   2905           # - All matching LOG rules are always applied.
   2906           # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
   2907           #   Logging will be applied if one or more matching rule requires logging.
   2908           # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
   2909           #   granted.
   2910           #   Logging will be applied if one or more matching rule requires logging.
   2911           # - Otherwise, if no rule applies, permission is denied.
   2912         { # A rule to be applied in a Policy.
   2913           "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
   2914               # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
   2915               # The format for in and not_in entries is the same as for members in a
   2916               # Binding (see google/iam/v1/policy.proto).
   2917             "A String",
   2918           ],
   2919           "description": "A String", # Human-readable description of the rule.
   2920           "in": [ # If one or more 'in' clauses are specified, the rule matches if
   2921               # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
   2922             "A String",
   2923           ],
   2924           "action": "A String", # Required
   2925           "conditions": [ # Additional restrictions that must be met
   2926             { # A condition to be met.
   2927               "iam": "A String", # Trusted attributes supplied by the IAM system.
   2928               "svc": "A String", # Trusted attributes discharged by the service.
   2929               "value": "A String", # DEPRECATED. Use 'values' instead.
   2930               "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
   2931                   # the IAM system for access control.
   2932               "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
   2933                 "A String",
   2934               ],
   2935               "op": "A String", # An operator to apply the subject with.
   2936             },
   2937           ],
   2938           "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
   2939               # that match the LOG action.
   2940             { # Specifies what kind of log the caller must write
   2941               "counter": { # Options for counters # Counter options.
   2942                 "field": "A String", # The field value to attribute.
   2943                 "metric": "A String", # The metric to update.
   2944               },
   2945               "dataAccess": { # Write a Data Access (Gin) log # Data access options.
   2946               },
   2947               "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
   2948                 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
   2949               },
   2950             },
   2951           ],
   2952           "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
   2953               # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
   2954               # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
   2955             "A String",
   2956           ],
   2957         },
   2958       ],
   2959       "version": 42, # Version of the `Policy`. The default version is 0.
   2960       "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
   2961           # prevent simultaneous updates of a policy from overwriting each other.
   2962           # It is strongly suggested that systems make use of the `etag` in the
   2963           # read-modify-write cycle to perform policy updates in order to avoid race
   2964           # conditions: An `etag` is returned in the response to `getIamPolicy`, and
   2965           # systems are expected to put that etag in the request to `setIamPolicy` to
   2966           # ensure that their change will be applied to the same version of the policy.
   2967           #
   2968           # If no `etag` is provided in the call to `setIamPolicy`, then the existing
   2969           # policy is overwritten blindly.
   2970       "bindings": [ # Associates a list of `members` to a `role`.
   2971           # Multiple `bindings` must not be specified for the same `role`.
   2972           # `bindings` with no members will result in an error.
   2973         { # Associates `members` with a `role`.
   2974           "role": "A String", # Role that is assigned to `members`.
   2975               # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
   2976               # Required
   2977           "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
   2978               # `members` can have the following values:
   2979               #
   2980               # * `allUsers`: A special identifier that represents anyone who is
   2981               #    on the internet; with or without a Google account.
   2982               #
   2983               # * `allAuthenticatedUsers`: A special identifier that represents anyone
   2984               #    who is authenticated with a Google account or a service account.
   2985               #
   2986               # * `user:{emailid}`: An email address that represents a specific Google
   2987               #    account. For example, `alice (a] gmail.com` or `joe (a] example.com`.
   2988               #
   2989               #
   2990               # * `serviceAccount:{emailid}`: An email address that represents a service
   2991               #    account. For example, `my-other-app (a] appspot.gserviceaccount.com`.
   2992               #
   2993               # * `group:{emailid}`: An email address that represents a Google group.
   2994               #    For example, `admins (a] example.com`.
   2995               #
   2996               #
   2997               # * `domain:{domain}`: A Google Apps domain name that represents all the
   2998               #    users of that domain. For example, `google.com` or `example.com`.
   2999               #
   3000             "A String",
   3001           ],
   3002         },
   3003       ],
   3004       "iamOwned": True or False,
   3005     },
   3006     "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
   3007         # the fields in the mask will be modified. If no mask is provided, the
   3008         # following default mask is used:
   3009         # paths: "bindings, etag"
   3010         # This field is only used by Cloud IAM.
   3011   }
   3012 
   3013   x__xgafv: string, V1 error format.
   3014     Allowed values
   3015       1 - v1 error format
   3016       2 - v2 error format
   3017 
   3018 Returns:
   3019   An object of the form:
   3020 
   3021     { # Defines an Identity and Access Management (IAM) policy. It is used to
   3022       # specify access control policies for Cloud Platform resources.
   3023       #
   3024       #
   3025       # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
   3026       # `members` to a `role`, where the members can be user accounts, Google groups,
   3027       # Google domains, and service accounts. A `role` is a named list of permissions
   3028       # defined by IAM.
   3029       #
   3030       # **Example**
   3031       #
   3032       #     {
   3033       #       "bindings": [
   3034       #         {
   3035       #           "role": "roles/owner",
   3036       #           "members": [
   3037       #             "user:mike (a] example.com",
   3038       #             "group:admins (a] example.com",
   3039       #             "domain:google.com",
   3040       #             "serviceAccount:my-other-app (a] appspot.gserviceaccount.com",
   3041       #           ]
   3042       #         },
   3043       #         {
   3044       #           "role": "roles/viewer",
   3045       #           "members": ["user:sean (a] example.com"]
   3046       #         }
   3047       #       ]
   3048       #     }
   3049       #
   3050       # For a description of IAM and its features, see the
   3051       # [IAM developer's guide](https://cloud.google.com/iam).
   3052     "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
   3053       { # Specifies the audit configuration for a service.
   3054           # The configuration determines which permission types are logged, and what
   3055           # identities, if any, are exempted from logging.
   3056           # An AuditConfig must have one or more AuditLogConfigs.
   3057           #
   3058           # If there are AuditConfigs for both `allServices` and a specific service,
   3059           # the union of the two AuditConfigs is used for that service: the log_types
   3060           # specified in each AuditConfig are enabled, and the exempted_members in each
   3061           # AuditConfig are exempted.
   3062           #
   3063           # Example Policy with multiple AuditConfigs:
   3064           #
   3065           #     {
   3066           #       "audit_configs": [
   3067           #         {
   3068           #           "service": "allServices"
   3069           #           "audit_log_configs": [
   3070           #             {
   3071           #               "log_type": "DATA_READ",
   3072           #               "exempted_members": [
   3073           #                 "user:foo (a] gmail.com"
   3074           #               ]
   3075           #             },
   3076           #             {
   3077           #               "log_type": "DATA_WRITE",
   3078           #             },
   3079           #             {
   3080           #               "log_type": "ADMIN_READ",
   3081           #             }
   3082           #           ]
   3083           #         },
   3084           #         {
   3085           #           "service": "fooservice.googleapis.com"
   3086           #           "audit_log_configs": [
   3087           #             {
   3088           #               "log_type": "DATA_READ",
   3089           #             },
   3090           #             {
   3091           #               "log_type": "DATA_WRITE",
   3092           #               "exempted_members": [
   3093           #                 "user:bar (a] gmail.com"
   3094           #               ]
   3095           #             }
   3096           #           ]
   3097           #         }
   3098           #       ]
   3099           #     }
   3100           #
   3101           # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
   3102           # logging. It also exempts foo (a] gmail.com from DATA_READ logging, and
   3103           # bar (a] gmail.com from DATA_WRITE logging.
   3104         "exemptedMembers": [
   3105           "A String",
   3106         ],
   3107         "auditLogConfigs": [ # The configuration for logging of each type of permission.
   3108             # Next ID: 4
   3109           { # Provides the configuration for logging a type of permissions.
   3110               # Example:
   3111               #
   3112               #     {
   3113               #       "audit_log_configs": [
   3114               #         {
   3115               #           "log_type": "DATA_READ",
   3116               #           "exempted_members": [
   3117               #             "user:foo (a] gmail.com"
   3118               #           ]
   3119               #         },
   3120               #         {
   3121               #           "log_type": "DATA_WRITE",
   3122               #         }
   3123               #       ]
   3124               #     }
   3125               #
   3126               # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
   3127               # foo (a] gmail.com from DATA_READ logging.
   3128             "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
   3129                 # permission.
   3130                 # Follows the same format of Binding.members.
   3131               "A String",
   3132             ],
   3133             "logType": "A String", # The log type that this config enables.
   3134           },
   3135         ],
   3136         "service": "A String", # Specifies a service that will be enabled for audit logging.
   3137             # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
   3138             # `allServices` is a special value that covers all services.
   3139       },
   3140     ],
   3141     "rules": [ # If more than one rule is specified, the rules are applied in the following
   3142         # manner:
   3143         # - All matching LOG rules are always applied.
   3144         # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
   3145         #   Logging will be applied if one or more matching rule requires logging.
   3146         # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
   3147         #   granted.
   3148         #   Logging will be applied if one or more matching rule requires logging.
   3149         # - Otherwise, if no rule applies, permission is denied.
   3150       { # A rule to be applied in a Policy.
   3151         "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
   3152             # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
   3153             # The format for in and not_in entries is the same as for members in a
   3154             # Binding (see google/iam/v1/policy.proto).
   3155           "A String",
   3156         ],
   3157         "description": "A String", # Human-readable description of the rule.
   3158         "in": [ # If one or more 'in' clauses are specified, the rule matches if
   3159             # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
   3160           "A String",
   3161         ],
   3162         "action": "A String", # Required
   3163         "conditions": [ # Additional restrictions that must be met
   3164           { # A condition to be met.
   3165             "iam": "A String", # Trusted attributes supplied by the IAM system.
   3166             "svc": "A String", # Trusted attributes discharged by the service.
   3167             "value": "A String", # DEPRECATED. Use 'values' instead.
   3168             "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
   3169                 # the IAM system for access control.
   3170             "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
   3171               "A String",
   3172             ],
   3173             "op": "A String", # An operator to apply the subject with.
   3174           },
   3175         ],
   3176         "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
   3177             # that match the LOG action.
   3178           { # Specifies what kind of log the caller must write
   3179             "counter": { # Options for counters # Counter options.
   3180               "field": "A String", # The field value to attribute.
   3181               "metric": "A String", # The metric to update.
   3182             },
   3183             "dataAccess": { # Write a Data Access (Gin) log # Data access options.
   3184             },
   3185             "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
   3186               "logName": "A String", # The log_name to populate in the Cloud Audit Record.
   3187             },
   3188           },
   3189         ],
   3190         "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
   3191             # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
   3192             # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
   3193           "A String",
   3194         ],
   3195       },
   3196     ],
   3197     "version": 42, # Version of the `Policy`. The default version is 0.
   3198     "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
   3199         # prevent simultaneous updates of a policy from overwriting each other.
   3200         # It is strongly suggested that systems make use of the `etag` in the
   3201         # read-modify-write cycle to perform policy updates in order to avoid race
   3202         # conditions: An `etag` is returned in the response to `getIamPolicy`, and
   3203         # systems are expected to put that etag in the request to `setIamPolicy` to
   3204         # ensure that their change will be applied to the same version of the policy.
   3205         #
   3206         # If no `etag` is provided in the call to `setIamPolicy`, then the existing
   3207         # policy is overwritten blindly.
   3208     "bindings": [ # Associates a list of `members` to a `role`.
   3209         # Multiple `bindings` must not be specified for the same `role`.
   3210         # `bindings` with no members will result in an error.
   3211       { # Associates `members` with a `role`.
   3212         "role": "A String", # Role that is assigned to `members`.
   3213             # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
   3214             # Required
   3215         "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
   3216             # `members` can have the following values:
   3217             #
   3218             # * `allUsers`: A special identifier that represents anyone who is
   3219             #    on the internet; with or without a Google account.
   3220             #
   3221             # * `allAuthenticatedUsers`: A special identifier that represents anyone
   3222             #    who is authenticated with a Google account or a service account.
   3223             #
   3224             # * `user:{emailid}`: An email address that represents a specific Google
   3225             #    account. For example, `alice (a] gmail.com` or `joe (a] example.com`.
   3226             #
   3227             #
   3228             # * `serviceAccount:{emailid}`: An email address that represents a service
   3229             #    account. For example, `my-other-app (a] appspot.gserviceaccount.com`.
   3230             #
   3231             # * `group:{emailid}`: An email address that represents a Google group.
   3232             #    For example, `admins (a] example.com`.
   3233             #
   3234             #
   3235             # * `domain:{domain}`: A Google Apps domain name that represents all the
   3236             #    users of that domain. For example, `google.com` or `example.com`.
   3237             #
   3238           "A String",
   3239         ],
   3240       },
   3241     ],
   3242     "iamOwned": True or False,
   3243   }</pre>
   3244 </div>
   3245 
   3246 <div class="method">
   3247     <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
   3248   <pre>Returns permissions that a caller has on the specified resource.
   3249 If the resource does not exist, this will return an empty set of
   3250 permissions, not a NOT_FOUND error.
   3251 
   3252 Note: This operation is designed to be used for building permission-aware
   3253 UIs and command-line tools, not for authorization checking. This operation
   3254 may "fail open" without warning.
   3255 
   3256 Args:
   3257   resource: string, REQUIRED: The resource for which the policy detail is being requested.
   3258 See the operation documentation for the appropriate value for this field. (required)
   3259   body: object, The request body. (required)
   3260     The object takes the form of:
   3261 
   3262 { # Request message for `TestIamPermissions` method.
   3263     "permissions": [ # The set of permissions to check for the `resource`. Permissions with
   3264         # wildcards (such as '*' or 'storage.*') are not allowed. For more
   3265         # information see
   3266         # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
   3267       "A String",
   3268     ],
   3269   }
   3270 
   3271   x__xgafv: string, V1 error format.
   3272     Allowed values
   3273       1 - v1 error format
   3274       2 - v2 error format
   3275 
   3276 Returns:
   3277   An object of the form:
   3278 
   3279     { # Response message for `TestIamPermissions` method.
   3280     "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
   3281         # allowed.
   3282       "A String",
   3283     ],
   3284   }</pre>
   3285 </div>
   3286 
   3287 <div class="method">
   3288     <code class="details" id="undelete">undelete(serviceName, x__xgafv=None)</code>
   3289   <pre>Revives a previously deleted managed service. The method restores the
   3290 service using the configuration at the time the service was deleted.
   3291 The target service must exist and must have been deleted within the
   3292 last 30 days.
   3293 
   3294 Operation<response: UndeleteServiceResponse>
   3295 
   3296 Args:
   3297   serviceName: string, The name of the service. See the [overview](/service-management/overview)
   3298 for naming requirements. For example: `example.googleapis.com`. (required)
   3299   x__xgafv: string, V1 error format.
   3300     Allowed values
   3301       1 - v1 error format
   3302       2 - v2 error format
   3303 
   3304 Returns:
   3305   An object of the form:
   3306 
   3307     { # This resource represents a long-running operation that is the result of a
   3308       # network API call.
   3309     "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
   3310         # programming environments, including REST APIs and RPC APIs. It is used by
   3311         # [gRPC](https://github.com/grpc). The error model is designed to be:
   3312         #
   3313         # - Simple to use and understand for most users
   3314         # - Flexible enough to meet unexpected needs
   3315         #
   3316         # # Overview
   3317         #
   3318         # The `Status` message contains three pieces of data: error code, error message,
   3319         # and error details. The error code should be an enum value of
   3320         # google.rpc.Code, but it may accept additional error codes if needed.  The
   3321         # error message should be a developer-facing English message that helps
   3322         # developers *understand* and *resolve* the error. If a localized user-facing
   3323         # error message is needed, put the localized message in the error details or
   3324         # localize it in the client. The optional error details may contain arbitrary
   3325         # information about the error. There is a predefined set of error detail types
   3326         # in the package `google.rpc` that can be used for common error conditions.
   3327         #
   3328         # # Language mapping
   3329         #
   3330         # The `Status` message is the logical representation of the error model, but it
   3331         # is not necessarily the actual wire format. When the `Status` message is
   3332         # exposed in different client libraries and different wire protocols, it can be
   3333         # mapped differently. For example, it will likely be mapped to some exceptions
   3334         # in Java, but more likely mapped to some error codes in C.
   3335         #
   3336         # # Other uses
   3337         #
   3338         # The error model and the `Status` message can be used in a variety of
   3339         # environments, either with or without APIs, to provide a
   3340         # consistent developer experience across different environments.
   3341         #
   3342         # Example uses of this error model include:
   3343         #
   3344         # - Partial errors. If a service needs to return partial errors to the client,
   3345         #     it may embed the `Status` in the normal response to indicate the partial
   3346         #     errors.
   3347         #
   3348         # - Workflow errors. A typical workflow has multiple steps. Each step may
   3349         #     have a `Status` message for error reporting.
   3350         #
   3351         # - Batch operations. If a client uses batch request and batch response, the
   3352         #     `Status` message should be used directly inside batch response, one for
   3353         #     each error sub-response.
   3354         #
   3355         # - Asynchronous operations. If an API call embeds asynchronous operation
   3356         #     results in its response, the status of those operations should be
   3357         #     represented directly using the `Status` message.
   3358         #
   3359         # - Logging. If some API errors are stored in logs, the message `Status` could
   3360         #     be used directly after any stripping needed for security/privacy reasons.
   3361       "message": "A String", # A developer-facing error message, which should be in English. Any
   3362           # user-facing error message should be localized and sent in the
   3363           # google.rpc.Status.details field, or localized by the client.
   3364       "code": 42, # The status code, which should be an enum value of google.rpc.Code.
   3365       "details": [ # A list of messages that carry the error details.  There will be a
   3366           # common set of message types for APIs to use.
   3367         {
   3368           "a_key": "", # Properties of the object. Contains field @type with type URL.
   3369         },
   3370       ],
   3371     },
   3372     "done": True or False, # If the value is `false`, it means the operation is still in progress.
   3373         # If true, the operation is completed, and either `error` or `response` is
   3374         # available.
   3375     "response": { # The normal response of the operation in case of success.  If the original
   3376         # method returns no data on success, such as `Delete`, the response is
   3377         # `google.protobuf.Empty`.  If the original method is standard
   3378         # `Get`/`Create`/`Update`, the response should be the resource.  For other
   3379         # methods, the response should have the type `XxxResponse`, where `Xxx`
   3380         # is the original method name.  For example, if the original method name
   3381         # is `TakeSnapshot()`, the inferred response type is
   3382         # `TakeSnapshotResponse`.
   3383       "a_key": "", # Properties of the object. Contains field @type with type URL.
   3384     },
   3385     "name": "A String", # The server-assigned name, which is only unique within the same service that
   3386         # originally returns it. If you use the default HTTP mapping, the
   3387         # `name` should have the format of `operations/some/unique/name`.
   3388     "metadata": { # Service-specific metadata associated with the operation.  It typically
   3389         # contains progress information and common metadata such as create time.
   3390         # Some services might not provide such metadata.  Any method that returns a
   3391         # long-running operation should document the metadata type, if any.
   3392       "a_key": "", # Properties of the object. Contains field @type with type URL.
   3393     },
   3394   }</pre>
   3395 </div>
   3396 
   3397 </body></html>