chore: update docs/dyn (#1162)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/b5e48daa-1759-436b-9fe7-ffce1482b520/targets
- [ ] To automatically regenerate this PR, check this box.
diff --git a/docs/dyn/apigee_v1.organizations.instances.html b/docs/dyn/apigee_v1.organizations.instances.html
index 9ea8bb2..0e7ba96 100644
--- a/docs/dyn/apigee_v1.organizations.instances.html
+++ b/docs/dyn/apigee_v1.organizations.instances.html
@@ -97,7 +97,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details for an Apigee runtime instance. **Note:** Not supported for Apigee hybrid.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -121,15 +121,15 @@
The object takes the form of:
{ # Apigee runtime instance.
- "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
"createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
"description": "A String", # Optional. Description of the instance.
+ "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
+ "displayName": "A String", # Optional. Display name for the instance.
"host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
+ "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
+ "location": "A String", # Required. Compute Engine location where the instance resides.
"name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
"port": "A String", # Output only. Port number of the exposed Apigee endpoint.
- "location": "A String", # Required. Compute Engine location where the instance resides.
- "displayName": "A String", # Optional. Display name for the instance.
- "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
"state": "A String", # Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.
}
@@ -142,24 +142,24 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "response": { # The normal response of the operation in case of success. 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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "metadata": { # 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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # 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}`.
- "done": 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.
- "error": { # 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.
- "message": "A String", # 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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- }</pre>
+ "done": 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.
+ "error": { # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # 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.
+ },
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
+ "response": { # The normal response of the operation in case of success. 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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
</div>
<div class="method">
@@ -177,24 +177,24 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "response": { # The normal response of the operation in case of success. 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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "metadata": { # 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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # 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}`.
- "done": 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.
- "error": { # 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.
- "message": "A String", # 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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- }</pre>
+ "done": 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.
+ "error": { # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # 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.
+ },
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
+ "response": { # The normal response of the operation in case of success. 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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
</div>
<div class="method">
@@ -212,27 +212,27 @@
An object of the form:
{ # Apigee runtime instance.
- "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
- "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
- "description": "A String", # Optional. Description of the instance.
- "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
- "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
- "port": "A String", # Output only. Port number of the exposed Apigee endpoint.
- "location": "A String", # Required. Compute Engine location where the instance resides.
- "displayName": "A String", # Optional. Display name for the instance.
- "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
- "state": "A String", # Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.
- }</pre>
+ "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
+ "description": "A String", # Optional. Description of the instance.
+ "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
+ "displayName": "A String", # Optional. Display name for the instance.
+ "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
+ "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
+ "location": "A String", # Required. Compute Engine location where the instance resides.
+ "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
+ "port": "A String", # Output only. Port number of the exposed Apigee endpoint.
+ "state": "A String", # Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.
+}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid.
Args:
parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}`. (required)
- pageToken: string, Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.
pageSize: integer, Maximum number of instances to return. Defaults to 25.
+ pageToken: string, Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -242,22 +242,22 @@
An object of the form:
{ # Response for ListInstances.
- "instances": [ # Instances in the specified organization.
- { # Apigee runtime instance.
- "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
- "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
- "description": "A String", # Optional. Description of the instance.
- "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
- "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
- "port": "A String", # Output only. Port number of the exposed Apigee endpoint.
- "location": "A String", # Required. Compute Engine location where the instance resides.
- "displayName": "A String", # Optional. Display name for the instance.
- "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
- "state": "A String", # Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.
- },
- ],
- "nextPageToken": "A String", # Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist.
- }</pre>
+ "instances": [ # Instances in the specified organization.
+ { # Apigee runtime instance.
+ "createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
+ "description": "A String", # Optional. Description of the instance.
+ "diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
+ "displayName": "A String", # Optional. Display name for the instance.
+ "host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
+ "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
+ "location": "A String", # Required. Compute Engine location where the instance resides.
+ "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
+ "port": "A String", # Output only. Port number of the exposed Apigee endpoint.
+ "state": "A String", # Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.
+ },
+ ],
+ "nextPageToken": "A String", # Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist.
+}</pre>
</div>
<div class="method">
@@ -284,31 +284,31 @@
The object takes the form of:
{ # Request for ReportInstanceStatus.
- "reportTime": "A String", # The time the report was generated in the runtime. Used to prevent an old status from overwriting a newer one. An instance should space out it's status reports so that clock skew does not play a factor.
- "resources": [ # Status for config resources
- { # The status of a resource loaded in the runtime.
- "uid": "A String", # The uid of the resource. In the unexpected case that the instance has multiple uids for the same name, they should be reported under separate ResourceStatuses.
- "revisions": [ # Revisions of the resource currently deployed in the instance.
- { # The status of a specific resource revision.
- "replicas": 42, # The number of replicas that have successfully loaded this revision.
- "revisionId": "A String", # The revision of the resource.
- "errors": [ # Errors reported when attempting to load this revision.
- { # Details on why a resource update failed in the runtime.
- "code": "A String", # Status code.
- "message": "A String", # User-friendly error message.
- "resource": "A String", # The sub resource specific to this error (e.g. a proxy deployed within the EnvironmentConfig). If empty the error refers to the top level resource.
- "type": "A String", # A string that uniquely identifies the type of error. This provides a more reliable means to deduplicate errors across revisions and instances.
- },
- ],
- "jsonSpec": "A String", # The json content of the resource revision.
- },
- ],
- "totalReplicas": 42, # The total number of replicas that should have this resource.
- "resource": "A String", # The resource name. Currently only two resources are supported: EnvironmentGroup - organizations/{org}/envgroups/{envgroup} EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig
- },
- ],
- "instanceUid": "A String", # A unique ID for the instance which is guaranteed to be unique in case the user installs multiple hybrid runtimes with the same instance ID.
- }
+ "instanceUid": "A String", # A unique ID for the instance which is guaranteed to be unique in case the user installs multiple hybrid runtimes with the same instance ID.
+ "reportTime": "A String", # The time the report was generated in the runtime. Used to prevent an old status from overwriting a newer one. An instance should space out it's status reports so that clock skew does not play a factor.
+ "resources": [ # Status for config resources
+ { # The status of a resource loaded in the runtime.
+ "resource": "A String", # The resource name. Currently only two resources are supported: EnvironmentGroup - organizations/{org}/envgroups/{envgroup} EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig
+ "revisions": [ # Revisions of the resource currently deployed in the instance.
+ { # The status of a specific resource revision.
+ "errors": [ # Errors reported when attempting to load this revision.
+ { # Details on why a resource update failed in the runtime.
+ "code": "A String", # Status code.
+ "message": "A String", # User-friendly error message.
+ "resource": "A String", # The sub resource specific to this error (e.g. a proxy deployed within the EnvironmentConfig). If empty the error refers to the top level resource.
+ "type": "A String", # A string that uniquely identifies the type of error. This provides a more reliable means to deduplicate errors across revisions and instances.
+ },
+ ],
+ "jsonSpec": "A String", # The json content of the resource revision.
+ "replicas": 42, # The number of replicas that have successfully loaded this revision.
+ "revisionId": "A String", # The revision of the resource.
+ },
+ ],
+ "totalReplicas": 42, # The total number of replicas that should have this resource.
+ "uid": "A String", # The uid of the resource. In the unexpected case that the instance has multiple uids for the same name, they should be reported under separate ResourceStatuses.
+ },
+ ],
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -319,7 +319,7 @@
An object of the form:
{ # Placeholder for future enhancements to status reporting protocol
- }</pre>
+}</pre>
</div>
</body></html>
\ No newline at end of file