| <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="developerconnect_v1.html">Developer Connect API</a> . <a href="developerconnect_v1.projects.html">projects</a> . <a href="developerconnect_v1.projects.locations.html">locations</a> . <a href="developerconnect_v1.projects.locations.insightsConfigs.html">insightsConfigs</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, insightsConfigId=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new InsightsConfig in a given project and location.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a single Insight.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single Insight.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists InsightsConfigs in a given project and location.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, allowMissing=None, body=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the parameters of a single InsightsConfig.</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, insightsConfigId=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Creates a new InsightsConfig in a given project and location. |
| |
| Args: |
| parent: string, Required. Value for parent. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The InsightsConfig resource is the core configuration object to capture events from your Software Development Lifecycle. It acts as the central hub for managing how Developer connect understands your application, its runtime environments, and the artifacts deployed within them. |
| "annotations": { # Optional. User specified annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations. |
| "a_key": "A String", |
| }, |
| "appHubApplication": "A String", # Optional. The name of the App Hub Application. Format: projects/{project}/locations/{location}/applications/{application} |
| "artifactConfigs": [ # Optional. The artifact configurations of the artifacts that are deployed. |
| { # The artifact config of the artifact that is deployed. |
| "googleArtifactAnalysis": { # Google Artifact Analysis configurations. # Optional. Set if the artifact metadata is stored in Artifact analysis. |
| "projectId": "A String", # Required. The project id of the project where the provenance is stored. |
| }, |
| "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact registry. |
| "artifactRegistryPackage": "A String", # Required. Immutable. The name of the artifact registry package. |
| "projectId": "A String", # Required. The host project of Artifact Registry. |
| }, |
| "uri": "A String", # Required. Immutable. The URI of the artifact that is deployed. e.g. `us-docker.pkg.dev/my-project/my-repo/image`. The URI does not include the tag / digest because it captures a lineage of artifacts. |
| }, |
| ], |
| "createTime": "A String", # Output only. [Output only] Create timestamp |
| "errors": [ # Output only. Any errors that occurred while setting up the InsightsConfig. Each error will be in the format: `field_name: error_message`, e.g. GetAppHubApplication: Permission denied while getting App Hub application. Please grant permissions to the P4SA. |
| { # 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). |
| "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. |
| }, |
| ], |
| "labels": { # Optional. Set of labels associated with an InsightsConfig. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The name of the InsightsConfig. Format: projects/{project}/locations/{location}/insightsConfigs/{insightsConfig} |
| "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. |
| "runtimeConfigs": [ # Output only. The runtime configurations where the application is deployed. |
| { # RuntimeConfig represents the runtimes where the application is deployed. |
| "appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload. |
| "criticality": "A String", # Output only. The criticality of the App Hub Workload. |
| "environment": "A String", # Output only. The environment of the App Hub Workload. |
| "workload": "A String", # Required. Output only. Immutable. The name of the App Hub Workload. Format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`. |
| }, |
| "gkeWorkload": { # GKEWorkload represents the Google Kubernetes Engine runtime. # Output only. Google Kubernetes Engine runtime. |
| "cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`. |
| "deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`. |
| }, |
| "state": "A String", # Output only. The state of the Runtime. |
| "uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name. |
| }, |
| ], |
| "state": "A String", # Optional. Output only. The state of the InsightsConfig. |
| "updateTime": "A String", # Output only. [Output only] Update timestamp |
| } |
| |
| insightsConfigId: string, Required. ID of the requesting InsightsConfig. |
| validateOnly: boolean, Optional. If set, validate the request, but do not actually post it. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "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, 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`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Delete a single Insight. |
| |
| Args: |
| name: string, Required. Value for parent. (required) |
| etag: string, Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
| requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| validateOnly: boolean, Optional. If set, validate the request, but do not actually post it. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "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, 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`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details of a single Insight. |
| |
| Args: |
| name: string, Required. Name of the resource. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The InsightsConfig resource is the core configuration object to capture events from your Software Development Lifecycle. It acts as the central hub for managing how Developer connect understands your application, its runtime environments, and the artifacts deployed within them. |
| "annotations": { # Optional. User specified annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations. |
| "a_key": "A String", |
| }, |
| "appHubApplication": "A String", # Optional. The name of the App Hub Application. Format: projects/{project}/locations/{location}/applications/{application} |
| "artifactConfigs": [ # Optional. The artifact configurations of the artifacts that are deployed. |
| { # The artifact config of the artifact that is deployed. |
| "googleArtifactAnalysis": { # Google Artifact Analysis configurations. # Optional. Set if the artifact metadata is stored in Artifact analysis. |
| "projectId": "A String", # Required. The project id of the project where the provenance is stored. |
| }, |
| "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact registry. |
| "artifactRegistryPackage": "A String", # Required. Immutable. The name of the artifact registry package. |
| "projectId": "A String", # Required. The host project of Artifact Registry. |
| }, |
| "uri": "A String", # Required. Immutable. The URI of the artifact that is deployed. e.g. `us-docker.pkg.dev/my-project/my-repo/image`. The URI does not include the tag / digest because it captures a lineage of artifacts. |
| }, |
| ], |
| "createTime": "A String", # Output only. [Output only] Create timestamp |
| "errors": [ # Output only. Any errors that occurred while setting up the InsightsConfig. Each error will be in the format: `field_name: error_message`, e.g. GetAppHubApplication: Permission denied while getting App Hub application. Please grant permissions to the P4SA. |
| { # 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). |
| "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. |
| }, |
| ], |
| "labels": { # Optional. Set of labels associated with an InsightsConfig. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The name of the InsightsConfig. Format: projects/{project}/locations/{location}/insightsConfigs/{insightsConfig} |
| "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. |
| "runtimeConfigs": [ # Output only. The runtime configurations where the application is deployed. |
| { # RuntimeConfig represents the runtimes where the application is deployed. |
| "appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload. |
| "criticality": "A String", # Output only. The criticality of the App Hub Workload. |
| "environment": "A String", # Output only. The environment of the App Hub Workload. |
| "workload": "A String", # Required. Output only. Immutable. The name of the App Hub Workload. Format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`. |
| }, |
| "gkeWorkload": { # GKEWorkload represents the Google Kubernetes Engine runtime. # Output only. Google Kubernetes Engine runtime. |
| "cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`. |
| "deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`. |
| }, |
| "state": "A String", # Output only. The state of the Runtime. |
| "uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name. |
| }, |
| ], |
| "state": "A String", # Optional. Output only. The state of the InsightsConfig. |
| "updateTime": "A String", # Output only. [Output only] Update timestamp |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists InsightsConfigs in a given project and location. |
| |
| Args: |
| parent: string, Required. Parent value for ListInsightsConfigsRequest. (required) |
| filter: string, Optional. Filtering results. See https://google.aip.dev/160 for more details. Filter string, adhering to the rules in https://google.aip.dev/160. List only InsightsConfigs matching the filter. If filter is empty, all InsightsConfigs are listed. |
| orderBy: string, Optional. Hint for how to order the results. |
| pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| pageToken: string, Optional. A token identifying a page of results the server should return. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Request for response to listing InsightsConfigs. |
| "insightsConfigs": [ # The list of InsightsConfigs. |
| { # The InsightsConfig resource is the core configuration object to capture events from your Software Development Lifecycle. It acts as the central hub for managing how Developer connect understands your application, its runtime environments, and the artifacts deployed within them. |
| "annotations": { # Optional. User specified annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations. |
| "a_key": "A String", |
| }, |
| "appHubApplication": "A String", # Optional. The name of the App Hub Application. Format: projects/{project}/locations/{location}/applications/{application} |
| "artifactConfigs": [ # Optional. The artifact configurations of the artifacts that are deployed. |
| { # The artifact config of the artifact that is deployed. |
| "googleArtifactAnalysis": { # Google Artifact Analysis configurations. # Optional. Set if the artifact metadata is stored in Artifact analysis. |
| "projectId": "A String", # Required. The project id of the project where the provenance is stored. |
| }, |
| "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact registry. |
| "artifactRegistryPackage": "A String", # Required. Immutable. The name of the artifact registry package. |
| "projectId": "A String", # Required. The host project of Artifact Registry. |
| }, |
| "uri": "A String", # Required. Immutable. The URI of the artifact that is deployed. e.g. `us-docker.pkg.dev/my-project/my-repo/image`. The URI does not include the tag / digest because it captures a lineage of artifacts. |
| }, |
| ], |
| "createTime": "A String", # Output only. [Output only] Create timestamp |
| "errors": [ # Output only. Any errors that occurred while setting up the InsightsConfig. Each error will be in the format: `field_name: error_message`, e.g. GetAppHubApplication: Permission denied while getting App Hub application. Please grant permissions to the P4SA. |
| { # 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). |
| "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. |
| }, |
| ], |
| "labels": { # Optional. Set of labels associated with an InsightsConfig. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The name of the InsightsConfig. Format: projects/{project}/locations/{location}/insightsConfigs/{insightsConfig} |
| "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. |
| "runtimeConfigs": [ # Output only. The runtime configurations where the application is deployed. |
| { # RuntimeConfig represents the runtimes where the application is deployed. |
| "appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload. |
| "criticality": "A String", # Output only. The criticality of the App Hub Workload. |
| "environment": "A String", # Output only. The environment of the App Hub Workload. |
| "workload": "A String", # Required. Output only. Immutable. The name of the App Hub Workload. Format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`. |
| }, |
| "gkeWorkload": { # GKEWorkload represents the Google Kubernetes Engine runtime. # Output only. Google Kubernetes Engine runtime. |
| "cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`. |
| "deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`. |
| }, |
| "state": "A String", # Output only. The state of the Runtime. |
| "uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name. |
| }, |
| ], |
| "state": "A String", # Optional. Output only. The state of the InsightsConfig. |
| "updateTime": "A String", # Output only. [Output only] Update timestamp |
| }, |
| ], |
| "nextPageToken": "A String", # A token identifying a page of results the server should return. |
| "unreachable": [ # Locations that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, allowMissing=None, body=None, requestId=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Updates the parameters of a single InsightsConfig. |
| |
| Args: |
| name: string, Identifier. The name of the InsightsConfig. Format: projects/{project}/locations/{location}/insightsConfigs/{insightsConfig} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The InsightsConfig resource is the core configuration object to capture events from your Software Development Lifecycle. It acts as the central hub for managing how Developer connect understands your application, its runtime environments, and the artifacts deployed within them. |
| "annotations": { # Optional. User specified annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations. |
| "a_key": "A String", |
| }, |
| "appHubApplication": "A String", # Optional. The name of the App Hub Application. Format: projects/{project}/locations/{location}/applications/{application} |
| "artifactConfigs": [ # Optional. The artifact configurations of the artifacts that are deployed. |
| { # The artifact config of the artifact that is deployed. |
| "googleArtifactAnalysis": { # Google Artifact Analysis configurations. # Optional. Set if the artifact metadata is stored in Artifact analysis. |
| "projectId": "A String", # Required. The project id of the project where the provenance is stored. |
| }, |
| "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact registry. |
| "artifactRegistryPackage": "A String", # Required. Immutable. The name of the artifact registry package. |
| "projectId": "A String", # Required. The host project of Artifact Registry. |
| }, |
| "uri": "A String", # Required. Immutable. The URI of the artifact that is deployed. e.g. `us-docker.pkg.dev/my-project/my-repo/image`. The URI does not include the tag / digest because it captures a lineage of artifacts. |
| }, |
| ], |
| "createTime": "A String", # Output only. [Output only] Create timestamp |
| "errors": [ # Output only. Any errors that occurred while setting up the InsightsConfig. Each error will be in the format: `field_name: error_message`, e.g. GetAppHubApplication: Permission denied while getting App Hub application. Please grant permissions to the P4SA. |
| { # 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). |
| "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. |
| }, |
| ], |
| "labels": { # Optional. Set of labels associated with an InsightsConfig. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The name of the InsightsConfig. Format: projects/{project}/locations/{location}/insightsConfigs/{insightsConfig} |
| "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. |
| "runtimeConfigs": [ # Output only. The runtime configurations where the application is deployed. |
| { # RuntimeConfig represents the runtimes where the application is deployed. |
| "appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload. |
| "criticality": "A String", # Output only. The criticality of the App Hub Workload. |
| "environment": "A String", # Output only. The environment of the App Hub Workload. |
| "workload": "A String", # Required. Output only. Immutable. The name of the App Hub Workload. Format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`. |
| }, |
| "gkeWorkload": { # GKEWorkload represents the Google Kubernetes Engine runtime. # Output only. Google Kubernetes Engine runtime. |
| "cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`. |
| "deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`. |
| }, |
| "state": "A String", # Output only. The state of the Runtime. |
| "uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name. |
| }, |
| ], |
| "state": "A String", # Optional. Output only. The state of the InsightsConfig. |
| "updateTime": "A String", # Output only. [Output only] Update timestamp |
| } |
| |
| allowMissing: boolean, Optional. If set to true, and the insightsConfig is not found a new insightsConfig will be created. In this situation `update_mask` is ignored. The creation will succeed only if the input insightsConfig has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties). |
| requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| validateOnly: boolean, Optional. If set, validate the request, but do not actually post it. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "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, 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`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
