Skip to content

Commit

Permalink
feat(serviceconsumermanagement): update the api
Browse files Browse the repository at this point in the history
#### serviceconsumermanagement:v1

The following keys were added:
- schemas.MethodSettings.properties.autoPopulatedFields (Total Keys: 2)

#### serviceconsumermanagement:v1beta1

The following keys were added:
- resources.services.resources.properties.methods.create (Total Keys: 12)
- schemas.MethodSettings.properties.autoPopulatedFields (Total Keys: 2)
- schemas.V1Beta1ConsumerProperty (Total Keys: 7)
  • Loading branch information
yoshi-automation committed Dec 7, 2023
1 parent 2f8dcf9 commit 9dcb748
Show file tree
Hide file tree
Showing 4 changed files with 259 additions and 2 deletions.
5 changes: 5 additions & 0 deletions docs/dyn/serviceconsumermanagement_v1beta1.services.html
Expand Up @@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the consumerQuotaMetrics Resource.</p>

<p class="toc_element">
<code><a href="serviceconsumermanagement_v1beta1.services.properties.html">properties()</a></code>
</p>
<p class="firstline">Returns the properties Resource.</p>

<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand Down
161 changes: 161 additions & 0 deletions docs/dyn/serviceconsumermanagement_v1beta1.services.properties.html
@@ -0,0 +1,161 @@
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}

body {
font-size: 13px;
padding: 1em;
}

h1 {
font-size: 26px;
margin-bottom: 1em;
}

h2 {
font-size: 24px;
margin-bottom: 1em;
}

h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}

pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
margin-top: 0.5em;
}

h1, h2, h3, p {
font-family: Arial, sans serif;
}

h1, h2, h3 {
border-bottom: solid #CCC 1px;
}

.toc_element {
margin-top: 0.5em;
}

.firstline {
margin-left: 2 em;
}

.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}

.details {
font-weight: bold;
font-size: 14px;
}

</style>

<h1><a href="serviceconsumermanagement_v1beta1.html">Service Consumer Management API</a> . <a href="serviceconsumermanagement_v1beta1.services.html">services</a> . <a href="serviceconsumermanagement_v1beta1.services.properties.html">properties</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a consumer property. If the property already exists, this method fails with an ALREADY_EXISTS error. For this failure case, the Status details field will contain the existing property's value.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a consumer property. If the property already exists, this method fails with an ALREADY_EXISTS error. For this failure case, the Status details field will contain the existing property&#x27;s value.

Args:
parent: string, Required. Name of the property to create. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123` (required)
body: object, The request body.
The object takes the form of:

{ # A property assigned to a consumer of a service.
&quot;description&quot;: &quot;A String&quot;, # Output only. The description of the property.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this property. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/properties/SERVICE_LEVEL` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.
&quot;propagation&quot;: { # This resource represents a long-running operation that is the result of a network API call. # Output only. A long-running operation which tracks the propagation of recent changes to this resource to all affected backends. If this field is empty, all affected backends have been notified of the change. If this field contains an operation in progress, then the most recent change to this resource has not yet been sent out to all backends. If this field contains an operation that has failed with an error, the caller should retry the change.
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
&quot;propertyKey&quot;: &quot;A String&quot;, # Output only. The name of the property as it appears in the service configuration. An example property name would be: `SERVICE_LEVEL`
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of this property.
&quot;value&quot;: &quot;&quot;, # Value of this property for the consumer. This field may be empty if the consumer has not been assigned a value.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A property assigned to a consumer of a service.
&quot;description&quot;: &quot;A String&quot;, # Output only. The description of the property.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this property. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/properties/SERVICE_LEVEL` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.
&quot;propagation&quot;: { # This resource represents a long-running operation that is the result of a network API call. # Output only. A long-running operation which tracks the propagation of recent changes to this resource to all affected backends. If this field is empty, all affected backends have been notified of the change. If this field contains an operation in progress, then the most recent change to this resource has not yet been sent out to all backends. If this field contains an operation that has failed with an error, the caller should retry the change.
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
&quot;propertyKey&quot;: &quot;A String&quot;, # Output only. The name of the property as it appears in the service configuration. An example property name would be: `SERVICE_LEVEL`
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of this property.
&quot;value&quot;: &quot;&quot;, # Value of this property for the consumer. This field may be empty if the consumer has not been assigned a value.
}</pre>
</div>

</body></html>
Expand Up @@ -542,7 +542,7 @@
}
}
},
"revision": "20231114",
"revision": "20231204",
"rootUrl": "https://serviceconsumermanagement.googleapis.com/",
"schemas": {
"AddTenantProjectRequest": {
Expand Down Expand Up @@ -1817,6 +1817,13 @@
"description": "Describes the generator configuration for a method.",
"id": "MethodSettings",
"properties": {
"autoPopulatedFields": {
"description": "List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id",
"items": {
"type": "string"
},
"type": "array"
},
"longRunning": {
"$ref": "LongRunning",
"description": "Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes"
Expand Down
Expand Up @@ -496,11 +496,43 @@
}
}
}
},
"properties": {
"methods": {
"create": {
"description": "Creates a consumer property. If the property already exists, this method fails with an ALREADY_EXISTS error. For this failure case, the Status details field will contain the existing property's value.",
"flatPath": "v1beta1/services/{servicesId}/{servicesId1}/{servicesId2}/properties",
"httpMethod": "POST",
"id": "serviceconsumermanagement.services.properties.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the property to create. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123`",
"location": "path",
"pattern": "^services/[^/]+/[^/]+/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/properties",
"request": {
"$ref": "V1Beta1ConsumerProperty"
},
"response": {
"$ref": "V1Beta1ConsumerProperty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20231114",
"revision": "20231204",
"rootUrl": "https://serviceconsumermanagement.googleapis.com/",
"schemas": {
"Api": {
Expand Down Expand Up @@ -1651,6 +1683,13 @@
"description": "Describes the generator configuration for a method.",
"id": "MethodSettings",
"properties": {
"autoPopulatedFields": {
"description": "List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id",
"items": {
"type": "string"
},
"type": "array"
},
"longRunning": {
"$ref": "LongRunning",
"description": "Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes"
Expand Down Expand Up @@ -2583,6 +2622,51 @@
},
"type": "object"
},
"V1Beta1ConsumerProperty": {
"description": "A property assigned to a consumer of a service.",
"id": "V1Beta1ConsumerProperty",
"properties": {
"description": {
"description": "Output only. The description of the property.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of this property. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/properties/SERVICE_LEVEL` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.",
"type": "string"
},
"propagation": {
"$ref": "Operation",
"description": "Output only. A long-running operation which tracks the propagation of recent changes to this resource to all affected backends. If this field is empty, all affected backends have been notified of the change. If this field contains an operation in progress, then the most recent change to this resource has not yet been sent out to all backends. If this field contains an operation that has failed with an error, the caller should retry the change."
},
"propertyKey": {
"description": "Output only. The name of the property as it appears in the service configuration. An example property name would be: `SERVICE_LEVEL`",
"type": "string"
},
"type": {
"description": "Output only. The type of this property.",
"enum": [
"UNSPECIFIED",
"INT64",
"BOOL",
"STRING",
"DOUBLE"
],
"enumDescriptions": [
"The type is unspecified, and will result in an error.",
"The type is `int64`.",
"The type is `bool`.",
"The type is `string`.",
"The type is 'double'."
],
"type": "string"
},
"value": {
"description": "Value of this property for the consumer. This field may be empty if the consumer has not been assigned a value.",
"type": "any"
}
},
"type": "object"
},
"V1Beta1ConsumerQuotaLimit": {
"description": "Consumer quota settings for a quota limit.",
"id": "V1Beta1ConsumerQuotaLimit",
Expand Down

0 comments on commit 9dcb748

Please sign in to comment.