You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.</p>
<pclass="firstline">Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.</p>
<pclass="firstline">Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.</p>
<pre>Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.
174
+
175
+
Args:
176
+
enterpriseId: string, The ID of the enterprise. (required)
177
+
deviceType: string, Whether it’s a dedicated device or a knowledge worker device.
178
+
Allowed values
179
+
unknown - This value is unused
180
+
dedicatedDevice - This device is a dedicated device.
181
+
knowledgeWorker - This device is required to have an authenticated user.
<pre>Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.
@@ -384,7 +411,7 @@ <h3>Method Details</h3>
384
411
<pre>Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.
385
412
386
413
Args:
387
-
requestMode: string, The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
414
+
requestMode: string, The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Specifying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
388
415
Allowed values
389
416
waitForNotifications - Wait until one or more notifications are present.
390
417
returnImmediately - Returns immediately whether notifications are present or not.
<pre>Gets the deployed ingress configuration for an environment group.
224
+
225
+
Args:
226
+
name: string, Required. Name of the deployed configuration for the environment group in the following format: 'organizations/{org}/envgroups/{envgroup}/deployedIngressConfig'. (required)
227
+
view: string, When set to FULL, additional details about the specific deployments receiving traffic will be included in the IngressConfig response's RoutingRules.
228
+
Allowed values
229
+
INGRESS_CONFIG_VIEW_UNSPECIFIED - The default/unset value. The API will default to the BASIC view.
230
+
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.
231
+
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.
232
+
x__xgafv: string, V1 error format.
233
+
Allowed values
234
+
1 - v1 error format
235
+
2 - v2 error format
236
+
237
+
Returns:
238
+
An object of the form:
239
+
240
+
{ # EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.
241
+
"endpointChainingRules": [ # A list of proxies in each deployment group for proxy chaining calls.
242
+
{ # EndpointChainingRule specifies the proxies contained in a particular deployment group, so that other deployment groups can find them in chaining calls.
243
+
"deploymentGroup": "A String", # The deployment group to target for cross-shard chaining calls to these proxies.
244
+
"proxyIds": [ # List of proxy ids which may be found in the given deployment group.
245
+
"A String",
246
+
],
247
+
},
248
+
],
249
+
"hostnames": [ # Host names for the environment group.
250
+
"A String",
251
+
],
252
+
"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.
253
+
"name": "A String", # Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.
254
+
"revisionId": "A String", # Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed.
255
+
"routingRules": [ # Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments.
256
+
{
257
+
"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.
258
+
"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.
259
+
"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.
260
+
"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.
261
+
"otherTargets": [ # Conflicting targets, which will be resource names specifying either deployment groups or environments.
262
+
"A String",
263
+
],
264
+
"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.
265
+
"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.
266
+
},
267
+
],
268
+
"uid": "A String", # A unique id for the environment group config that will only change if the environment group is deleted and recreated.
Copy file name to clipboardExpand all lines: docs/dyn/apigee_v1.organizations.environments.html
+15-1Lines changed: 15 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -481,19 +481,33 @@ <h3>Method Details</h3>
481
481
"A String",
482
482
],
483
483
},
484
+
"deploymentGroups": [ # List of deployment groups in the environment.
485
+
{ # DeploymentGroupConfig represents a deployment group that should be present in a particular environment.
486
+
"name": "A String", # Name of the deployment group in the following format: `organizations/{org}/environments/{env}/deploymentGroups/{group}`.
487
+
"revisionId": "A String", # Revision number which can be used by the runtime to detect if the deployment group has changed between two versions.
488
+
"uid": "A String", # Unique ID. The ID will only change if the deployment group is deleted and recreated.
489
+
},
490
+
],
484
491
"deployments": [ # List of deployments in the environment.
485
-
{ # NEXT ID: 9
492
+
{ # NEXT ID: 11
486
493
"attributes": { # Additional key-value metadata for the deployment.
487
494
"a_key": "A String",
488
495
},
489
496
"basePath": "A String", # Base path where the application will be hosted. Defaults to "/".
497
+
"deploymentGroups": [ # The list of deployment groups in which this proxy should be deployed. Not currently populated for shared flows.
498
+
"A String",
499
+
],
500
+
"endpoints": { # A mapping from basepaths to proxy endpoint names in this proxy. Not populated for shared flows.
501
+
"a_key": "A String",
502
+
},
490
503
"location": "A String", # Location of the API proxy bundle as a URI.
491
504
"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}`
492
505
"proxyUid": "A String", # Unique ID of the API proxy revision.
493
506
"serviceAccount": "A String", # The service account identity associated with this deployment. If non-empty, will be in the following format: `projects/-/serviceAccounts/{account_email}`
494
507
"uid": "A String", # Unique ID. The ID will only change if the deployment is deleted and recreated.
495
508
},
496
509
],
510
+
"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.
497
511
"featureFlags": { # Feature flags inherited from the organization and environment.
Copy file name to clipboardExpand all lines: docs/dyn/apigee_v1.organizations.environments.targetservers.html
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -104,7 +104,7 @@ <h3>Method Details</h3>
104
104
body: object, The request body.
105
105
The object takes the form of:
106
106
107
-
{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
107
+
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
108
108
"description": "A String", # Optional. A human-readable description of this TargetServer.
109
109
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
110
110
"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 @@ <h3>Method Details</h3>
140
140
Returns:
141
141
An object of the form:
142
142
143
-
{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
143
+
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
144
144
"description": "A String", # Optional. A human-readable description of this TargetServer.
145
145
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
146
146
"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 @@ <h3>Method Details</h3>
182
182
Returns:
183
183
An object of the form:
184
184
185
-
{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
185
+
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
186
186
"description": "A String", # Optional. A human-readable description of this TargetServer.
187
187
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
188
188
"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 @@ <h3>Method Details</h3>
224
224
Returns:
225
225
An object of the form:
226
226
227
-
{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
227
+
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
228
228
"description": "A String", # Optional. A human-readable description of this TargetServer.
229
229
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
230
230
"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 @@ <h3>Method Details</h3>
261
261
body: object, The request body.
262
262
The object takes the form of:
263
263
264
-
{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
264
+
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
265
265
"description": "A String", # Optional. A human-readable description of this TargetServer.
266
266
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
267
267
"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 @@ <h3>Method Details</h3>
296
296
Returns:
297
297
An object of the form:
298
298
299
-
{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
299
+
{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
300
300
"description": "A String", # Optional. A human-readable description of this TargetServer.
301
301
"host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
302
302
"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.
0 commit comments