From 43f435c459205c8305f248efe78e6bd72a1b95c3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Dec 2022 07:07:57 +0000 Subject: [PATCH] feat(apigee): update the api #### apigee:v1 The following keys were added: - resources.organizations.resources.envgroups.methods.getDeployedIngressConfig (Total Keys: 13) - schemas.GoogleCloudApigeeV1DeploymentConfig.properties.deploymentGroups (Total Keys: 2) - schemas.GoogleCloudApigeeV1DeploymentConfig.properties.endpoints (Total Keys: 2) - schemas.GoogleCloudApigeeV1DeploymentGroupConfig (Total Keys: 4) - schemas.GoogleCloudApigeeV1EndpointChainingRule (Total Keys: 5) - schemas.GoogleCloudApigeeV1EnvironmentConfig.properties.deploymentGroups (Total Keys: 2) - schemas.GoogleCloudApigeeV1EnvironmentGroupConfig.properties.endpointChainingRules (Total Keys: 2) - schemas.GoogleCloudApigeeV1EnvironmentGroupConfig.properties.location.type (Total Keys: 1) - schemas.GoogleCloudApigeeV1RoutingRule.properties.deploymentGroup.type (Total Keys: 1) - schemas.GoogleCloudApigeeV1RoutingRule.properties.otherTargets (Total Keys: 2) --- .../apigee_v1.organizations.envgroups.html | 54 +++++++ .../apigee_v1.organizations.environments.html | 16 ++- ...anizations.environments.targetservers.html | 12 +- docs/dyn/apigee_v1.organizations.html | 15 +- .../discovery_cache/documents/apigee.v1.json | 134 +++++++++++++++++- 5 files changed, 219 insertions(+), 12 deletions(-) diff --git a/docs/dyn/apigee_v1.organizations.envgroups.html b/docs/dyn/apigee_v1.organizations.envgroups.html index 14ca097997e..fff371980a3 100644 --- a/docs/dyn/apigee_v1.organizations.envgroups.html +++ b/docs/dyn/apigee_v1.organizations.envgroups.html @@ -91,6 +91,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets an environment group.

+

+ getDeployedIngressConfig(name, view=None, x__xgafv=None)

+

Gets the deployed ingress configuration for an environment group.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all environment groups.

@@ -215,6 +218,57 @@

Method Details

} +
+ getDeployedIngressConfig(name, view=None, x__xgafv=None) +
Gets the deployed ingress configuration for an environment group.
+
+Args:
+  name: string, Required. Name of the deployed configuration for the environment group in the following format: 'organizations/{org}/envgroups/{envgroup}/deployedIngressConfig'. (required)
+  view: string, When set to FULL, additional details about the specific deployments receiving traffic will be included in the IngressConfig response's RoutingRules.
+    Allowed values
+      INGRESS_CONFIG_VIEW_UNSPECIFIED - The default/unset value. The API will default to the BASIC view.
+      BASIC - Include all ingress config data necessary for the runtime to configure ingress, but no more. Routing rules will include only basepath and destination environment. This the default value.
+      FULL - Include all ingress config data, including internal debug info for each routing rule such as the proxy claiming a particular basepath and when the routing rule first appeared in the env group.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.
+  "endpointChainingRules": [ # A list of proxies in each deployment group for proxy chaining calls.
+    { # EndpointChainingRule specifies the proxies contained in a particular deployment group, so that other deployment groups can find them in chaining calls.
+      "deploymentGroup": "A String", # The deployment group to target for cross-shard chaining calls to these proxies.
+      "proxyIds": [ # List of proxy ids which may be found in the given deployment group.
+        "A String",
+      ],
+    },
+  ],
+  "hostnames": [ # Host names for the environment group.
+    "A String",
+  ],
+  "location": "A String", # When this message appears in the top-level IngressConfig, this field will be populated in lieu of the inlined routing_rules and hostnames fields. Some URL for downloading the full EnvironmentGroupConfig for this group.
+  "name": "A String", # Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.
+  "revisionId": "A String", # Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed.
+  "routingRules": [ # Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments.
+    {
+      "basepath": "A String", # URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string.
+      "deploymentGroup": "A String", # Name of a deployment group in an environment bound to the environment group in the following format: `organizations/{org}/environment/{env}/deploymentGroups/{group}` Only one of environment or deployment_group will be set.
+      "envGroupRevision": "A String", # The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.
+      "environment": "A String", # Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`. Only one of environment or deployment_group will be set.
+      "otherTargets": [ # Conflicting targets, which will be resource names specifying either deployment groups or environments.
+        "A String",
+      ],
+      "receiver": "A String", # The resource name of the proxy revision that is receiving this basepath in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.
+      "updateTime": "A String", # The unix timestamp when this rule was updated. This is updated whenever env_group_revision is updated. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.
+    },
+  ],
+  "uid": "A String", # A unique id for the environment group config that will only change if the environment group is deleted and recreated.
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all environment groups.
diff --git a/docs/dyn/apigee_v1.organizations.environments.html b/docs/dyn/apigee_v1.organizations.environments.html
index fdea44d1e02..935be578fe9 100644
--- a/docs/dyn/apigee_v1.organizations.environments.html
+++ b/docs/dyn/apigee_v1.organizations.environments.html
@@ -481,12 +481,25 @@ 

Method Details

"A String", ], }, + "deploymentGroups": [ # List of deployment groups in the environment. + { # DeploymentGroupConfig represents a deployment group that should be present in a particular environment. + "name": "A String", # Name of the deployment group in the following format: `organizations/{org}/environments/{env}/deploymentGroups/{group}`. + "revisionId": "A String", # Revision number which can be used by the runtime to detect if the deployment group has changed between two versions. + "uid": "A String", # Unique ID. The ID will only change if the deployment group is deleted and recreated. + }, + ], "deployments": [ # List of deployments in the environment. - { # NEXT ID: 9 + { # NEXT ID: 11 "attributes": { # Additional key-value metadata for the deployment. "a_key": "A String", }, "basePath": "A String", # Base path where the application will be hosted. Defaults to "/". + "deploymentGroups": [ # The list of deployment groups in which this proxy should be deployed. Not currently populated for shared flows. + "A String", + ], + "endpoints": { # A mapping from basepaths to proxy endpoint names in this proxy. Not populated for shared flows. + "a_key": "A String", + }, "location": "A String", # Location of the API proxy bundle as a URI. "name": "A String", # Name of the API or shared flow revision to be deployed in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` "proxyUid": "A String", # Unique ID of the API proxy revision. @@ -494,6 +507,7 @@

Method Details

"uid": "A String", # Unique ID. The ID will only change if the deployment is deleted and recreated. }, ], + "envScopedRevisionId": "A String", # Revision ID for environment-scoped resources (e.g. target servers, keystores) in this config. This ID will increment any time a resource not scoped to a deployment group changes. "featureFlags": { # Feature flags inherited from the organization and environment. "a_key": "A String", }, diff --git a/docs/dyn/apigee_v1.organizations.environments.targetservers.html b/docs/dyn/apigee_v1.organizations.environments.targetservers.html index 9b4683d0094..6e4b7c11ead 100644 --- a/docs/dyn/apigee_v1.organizations.environments.targetservers.html +++ b/docs/dyn/apigee_v1.organizations.environments.targetservers.html @@ -104,7 +104,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. +{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -140,7 +140,7 @@

Method Details

Returns: An object of the form: - { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. + { # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -182,7 +182,7 @@

Method Details

Returns: An object of the form: - { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. + { # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -224,7 +224,7 @@

Method Details

Returns: An object of the form: - { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. + { # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -261,7 +261,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. +{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -296,7 +296,7 @@

Method Details

Returns: An object of the form: - { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. + { # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. diff --git a/docs/dyn/apigee_v1.organizations.html b/docs/dyn/apigee_v1.organizations.html index 982f5a15f24..568cf9c701a 100644 --- a/docs/dyn/apigee_v1.organizations.html +++ b/docs/dyn/apigee_v1.organizations.html @@ -445,16 +445,29 @@

Method Details

{ "environmentGroups": [ # List of environment groups in the organization. { # EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules. + "endpointChainingRules": [ # A list of proxies in each deployment group for proxy chaining calls. + { # EndpointChainingRule specifies the proxies contained in a particular deployment group, so that other deployment groups can find them in chaining calls. + "deploymentGroup": "A String", # The deployment group to target for cross-shard chaining calls to these proxies. + "proxyIds": [ # List of proxy ids which may be found in the given deployment group. + "A String", + ], + }, + ], "hostnames": [ # Host names for the environment group. "A String", ], + "location": "A String", # When this message appears in the top-level IngressConfig, this field will be populated in lieu of the inlined routing_rules and hostnames fields. Some URL for downloading the full EnvironmentGroupConfig for this group. "name": "A String", # Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. "revisionId": "A String", # Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed. "routingRules": [ # Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments. { "basepath": "A String", # URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string. + "deploymentGroup": "A String", # Name of a deployment group in an environment bound to the environment group in the following format: `organizations/{org}/environment/{env}/deploymentGroups/{group}` Only one of environment or deployment_group will be set. "envGroupRevision": "A String", # The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL. - "environment": "A String", # Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`. + "environment": "A String", # Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`. Only one of environment or deployment_group will be set. + "otherTargets": [ # Conflicting targets, which will be resource names specifying either deployment groups or environments. + "A String", + ], "receiver": "A String", # The resource name of the proxy revision that is receiving this basepath in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL. "updateTime": "A String", # The unix timestamp when this rule was updated. This is updated whenever env_group_revision is updated. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL. }, diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index 451da9d6f50..1b10e54da2d 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -3262,6 +3262,46 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getDeployedIngressConfig": { + "description": "Gets the deployed ingress configuration for an environment group.", + "flatPath": "v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig", + "httpMethod": "GET", + "id": "apigee.organizations.envgroups.getDeployedIngressConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the deployed configuration for the environment group in the following format: 'organizations/{org}/envgroups/{envgroup}/deployedIngressConfig'.", + "location": "path", + "pattern": "^organizations/[^/]+/envgroups/[^/]+/deployedIngressConfig$", + "required": true, + "type": "string" + }, + "view": { + "description": "When set to FULL, additional details about the specific deployments receiving traffic will be included in the IngressConfig response's RoutingRules.", + "enum": [ + "INGRESS_CONFIG_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The default/unset value. The API will default to the BASIC view.", + "Include all ingress config data necessary for the runtime to configure ingress, but no more. Routing rules will include only basepath and destination environment. This the default value.", + "Include all ingress config data, including internal debug info for each routing rule such as the proxy claiming a particular basepath and when the routing rule first appeared in the env group." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1EnvironmentGroupConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all environment groups.", "flatPath": "v1/organizations/{organizationsId}/envgroups", @@ -8634,7 +8674,7 @@ } } }, - "revision": "20221209", + "revision": "20221213", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -10466,7 +10506,7 @@ "type": "object" }, "GoogleCloudApigeeV1DeploymentConfig": { - "description": "NEXT ID: 9", + "description": "NEXT ID: 11", "id": "GoogleCloudApigeeV1DeploymentConfig", "properties": { "attributes": { @@ -10480,6 +10520,20 @@ "description": "Base path where the application will be hosted. Defaults to \"/\".", "type": "string" }, + "deploymentGroups": { + "description": "The list of deployment groups in which this proxy should be deployed. Not currently populated for shared flows.", + "items": { + "type": "string" + }, + "type": "array" + }, + "endpoints": { + "additionalProperties": { + "type": "string" + }, + "description": "A mapping from basepaths to proxy endpoint names in this proxy. Not populated for shared flows.", + "type": "object" + }, "location": { "description": "Location of the API proxy bundle as a URI.", "type": "string" @@ -10503,6 +10557,26 @@ }, "type": "object" }, + "GoogleCloudApigeeV1DeploymentGroupConfig": { + "description": "DeploymentGroupConfig represents a deployment group that should be present in a particular environment.", + "id": "GoogleCloudApigeeV1DeploymentGroupConfig", + "properties": { + "name": { + "description": "Name of the deployment group in the following format: `organizations/{org}/environments/{env}/deploymentGroups/{group}`.", + "type": "string" + }, + "revisionId": { + "description": "Revision number which can be used by the runtime to detect if the deployment group has changed between two versions.", + "format": "int64", + "type": "string" + }, + "uid": { + "description": "Unique ID. The ID will only change if the deployment group is deleted and recreated.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1Developer": { "id": "GoogleCloudApigeeV1Developer", "properties": { @@ -10887,6 +10961,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1EndpointChainingRule": { + "description": "EndpointChainingRule specifies the proxies contained in a particular deployment group, so that other deployment groups can find them in chaining calls.", + "id": "GoogleCloudApigeeV1EndpointChainingRule", + "properties": { + "deploymentGroup": { + "description": "The deployment group to target for cross-shard chaining calls to these proxies.", + "type": "string" + }, + "proxyIds": { + "description": "List of proxy ids which may be found in the given deployment group.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1EntityMetadata": { "description": "Metadata common to many entities in this API.", "id": "GoogleCloudApigeeV1EntityMetadata", @@ -11020,6 +11112,13 @@ "$ref": "GoogleCloudApigeeV1DebugMask", "description": "Debug mask that applies to all deployments in the environment." }, + "deploymentGroups": { + "description": "List of deployment groups in the environment.", + "items": { + "$ref": "GoogleCloudApigeeV1DeploymentGroupConfig" + }, + "type": "array" + }, "deployments": { "description": "List of deployments in the environment.", "items": { @@ -11027,6 +11126,11 @@ }, "type": "array" }, + "envScopedRevisionId": { + "description": "Revision ID for environment-scoped resources (e.g. target servers, keystores) in this config. This ID will increment any time a resource not scoped to a deployment group changes.", + "format": "int64", + "type": "string" + }, "featureFlags": { "additionalProperties": { "type": "string" @@ -11189,6 +11293,13 @@ "description": "EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.", "id": "GoogleCloudApigeeV1EnvironmentGroupConfig", "properties": { + "endpointChainingRules": { + "description": "A list of proxies in each deployment group for proxy chaining calls.", + "items": { + "$ref": "GoogleCloudApigeeV1EndpointChainingRule" + }, + "type": "array" + }, "hostnames": { "description": "Host names for the environment group.", "items": { @@ -11196,6 +11307,10 @@ }, "type": "array" }, + "location": { + "description": "When this message appears in the top-level IngressConfig, this field will be populated in lieu of the inlined routing_rules and hostnames fields. Some URL for downloading the full EnvironmentGroupConfig for this group.", + "type": "string" + }, "name": { "description": "Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.", "type": "string" @@ -13740,15 +13855,26 @@ "description": "URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string.", "type": "string" }, + "deploymentGroup": { + "description": "Name of a deployment group in an environment bound to the environment group in the following format: `organizations/{org}/environment/{env}/deploymentGroups/{group}` Only one of environment or deployment_group will be set.", + "type": "string" + }, "envGroupRevision": { "description": "The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.", "format": "int64", "type": "string" }, "environment": { - "description": "Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`.", + "description": "Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`. Only one of environment or deployment_group will be set.", "type": "string" }, + "otherTargets": { + "description": "Conflicting targets, which will be resource names specifying either deployment groups or environments.", + "items": { + "type": "string" + }, + "type": "array" + }, "receiver": { "description": "The resource name of the proxy revision that is receiving this basepath in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.", "type": "string" @@ -14677,7 +14803,7 @@ "type": "object" }, "GoogleCloudApigeeV1TargetServer": { - "description": "TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.", + "description": "TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.", "id": "GoogleCloudApigeeV1TargetServer", "properties": { "description": {