Skip to content

Commit bb24623

Browse files
1 parent 805807c commit bb24623

5 files changed

Lines changed: 134 additions & 41 deletions

src/Apigee/GoogleCloudApigeeV1EnvironmentClientIPResolutionConfigHeaderIndexAlgorithm.php

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ class GoogleCloudApigeeV1EnvironmentClientIPResolutionConfigHeaderIndexAlgorithm
2828
*/
2929
public $ipHeaderIndex;
3030
/**
31-
* Required. The name of the header to extract the client ip from. We are
32-
* currently only supporting the X-Forwarded-For header.
31+
* Required. The name of the header to extract the client ip from.
3332
*
3433
* @var string
3534
*/
@@ -54,8 +53,7 @@ public function getIpHeaderIndex()
5453
return $this->ipHeaderIndex;
5554
}
5655
/**
57-
* Required. The name of the header to extract the client ip from. We are
58-
* currently only supporting the X-Forwarded-For header.
56+
* Required. The name of the header to extract the client ip from.
5957
*
6058
* @param string $ipHeaderName
6159
*/

src/Apigee/GoogleCloudApigeeV1RuntimeTraceConfig.php

Lines changed: 61 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,33 @@ class GoogleCloudApigeeV1RuntimeTraceConfig extends \Google\Collection
2424
*/
2525
public const EXPORTER_EXPORTER_UNSPECIFIED = 'EXPORTER_UNSPECIFIED';
2626
/**
27-
* Jaeger exporter
27+
* Exports events to Jaeger. Compatible with OpenCensus protocol.
2828
*/
2929
public const EXPORTER_JAEGER = 'JAEGER';
3030
/**
31-
* Cloudtrace exporter
31+
* Exports events to Cloud Trace. Compatible with OpenCensus protocol.
3232
*/
3333
public const EXPORTER_CLOUD_TRACE = 'CLOUD_TRACE';
3434
/**
35-
* Open Telemetry Collector
35+
* OpenTelemetry Collector. Compatible with OpenTelemetry protocol.
3636
*/
3737
public const EXPORTER_OPEN_TELEMETRY_COLLECTOR = 'OPEN_TELEMETRY_COLLECTOR';
38+
/**
39+
* Exports events to Cloud Trace. Compatible with OpenTelemetry protocol.
40+
*/
41+
public const EXPORTER_OPEN_TELEMETRY_CLOUD_TRACE = 'OPEN_TELEMETRY_CLOUD_TRACE';
42+
/**
43+
* Protocol unspecified. Defaults to OPEN_CENSUS.
44+
*/
45+
public const TRACE_PROTOCOL_TRACE_PROTOCOL_UNSPECIFIED = 'TRACE_PROTOCOL_UNSPECIFIED';
46+
/**
47+
* Uses OpenCensus protocol.
48+
*/
49+
public const TRACE_PROTOCOL_OPEN_CENSUS = 'OPEN_CENSUS';
50+
/**
51+
* Uses OpenTelemetry Protocol (OTLP).
52+
*/
53+
public const TRACE_PROTOCOL_OTLP = 'OTLP';
3854
protected $collection_key = 'overrides';
3955
/**
4056
* Endpoint of the exporter.
@@ -58,13 +74,15 @@ class GoogleCloudApigeeV1RuntimeTraceConfig extends \Google\Collection
5874
*/
5975
public $name;
6076
/**
61-
* If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace
62-
* data. Configuration Requirements (if `open_telemetry_protocol_enabled` is
63-
* `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or
64-
* `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`:
65-
* - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is
66-
* `CLOUD_TRACE`: - `endpoint` refers to a valid project ID
77+
* Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send
78+
* trace data. Configuration Requirements (if
79+
* `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s:
80+
* `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is
81+
* `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector
82+
* URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid
83+
* project ID Deprecated: Use trace_protocol instead.
6784
*
85+
* @deprecated
6886
* @var bool
6987
*/
7088
public $openTelemetryProtocolEnabled;
@@ -85,6 +103,12 @@ class GoogleCloudApigeeV1RuntimeTraceConfig extends \Google\Collection
85103
public $revisionId;
86104
protected $samplingConfigType = GoogleCloudApigeeV1RuntimeTraceSamplingConfig::class;
87105
protected $samplingConfigDataType = '';
106+
/**
107+
* Optional. The trace protocol to use.
108+
*
109+
* @var string
110+
*/
111+
public $traceProtocol;
88112

89113
/**
90114
* Endpoint of the exporter.
@@ -108,7 +132,7 @@ public function getEndpoint()
108132
* consuming them. Recorded spans can be exported by registered exporters.
109133
*
110134
* Accepted values: EXPORTER_UNSPECIFIED, JAEGER, CLOUD_TRACE,
111-
* OPEN_TELEMETRY_COLLECTOR
135+
* OPEN_TELEMETRY_COLLECTOR, OPEN_TELEMETRY_CLOUD_TRACE
112136
*
113137
* @param self::EXPORTER_* $exporter
114138
*/
@@ -141,20 +165,23 @@ public function getName()
141165
return $this->name;
142166
}
143167
/**
144-
* If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace
145-
* data. Configuration Requirements (if `open_telemetry_protocol_enabled` is
146-
* `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or
147-
* `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`:
148-
* - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is
149-
* `CLOUD_TRACE`: - `endpoint` refers to a valid project ID
168+
* Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send
169+
* trace data. Configuration Requirements (if
170+
* `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s:
171+
* `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is
172+
* `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector
173+
* URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid
174+
* project ID Deprecated: Use trace_protocol instead.
150175
*
176+
* @deprecated
151177
* @param bool $openTelemetryProtocolEnabled
152178
*/
153179
public function setOpenTelemetryProtocolEnabled($openTelemetryProtocolEnabled)
154180
{
155181
$this->openTelemetryProtocolEnabled = $openTelemetryProtocolEnabled;
156182
}
157183
/**
184+
* @deprecated
158185
* @return bool
159186
*/
160187
public function getOpenTelemetryProtocolEnabled()
@@ -226,6 +253,24 @@ public function getSamplingConfig()
226253
{
227254
return $this->samplingConfig;
228255
}
256+
/**
257+
* Optional. The trace protocol to use.
258+
*
259+
* Accepted values: TRACE_PROTOCOL_UNSPECIFIED, OPEN_CENSUS, OTLP
260+
*
261+
* @param self::TRACE_PROTOCOL_* $traceProtocol
262+
*/
263+
public function setTraceProtocol($traceProtocol)
264+
{
265+
$this->traceProtocol = $traceProtocol;
266+
}
267+
/**
268+
* @return self::TRACE_PROTOCOL_*
269+
*/
270+
public function getTraceProtocol()
271+
{
272+
return $this->traceProtocol;
273+
}
229274
}
230275

231276
// Adding a class alias for backwards compatibility with the previous class name.

src/Apigee/GoogleCloudApigeeV1RuntimeTraceConfigOverride.php

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@
1919

2020
class GoogleCloudApigeeV1RuntimeTraceConfigOverride extends \Google\Model
2121
{
22+
/**
23+
* Protocol unspecified. Defaults to OPEN_CENSUS.
24+
*/
25+
public const TRACE_PROTOCOL_TRACE_PROTOCOL_UNSPECIFIED = 'TRACE_PROTOCOL_UNSPECIFIED';
26+
/**
27+
* Uses OpenCensus protocol.
28+
*/
29+
public const TRACE_PROTOCOL_OPEN_CENSUS = 'OPEN_CENSUS';
30+
/**
31+
* Uses OpenTelemetry Protocol (OTLP).
32+
*/
33+
public const TRACE_PROTOCOL_OTLP = 'OTLP';
2234
/**
2335
* Name of the API proxy that will have its trace configuration overridden
2436
* following format: `organizations/{org}/apis/{api}`
@@ -34,13 +46,15 @@ class GoogleCloudApigeeV1RuntimeTraceConfigOverride extends \Google\Model
3446
*/
3547
public $name;
3648
/**
37-
* If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace
38-
* data. Configuration Requirements (if `open_telemetry_protocol_enabled` is
39-
* `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or
40-
* `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`:
41-
* - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is
42-
* `CLOUD_TRACE`: - `endpoint` refers to a valid project ID
49+
* Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send
50+
* trace data. Configuration Requirements (if
51+
* `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s:
52+
* `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is
53+
* `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector
54+
* URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid
55+
* project ID Deprecated: Use trace_protocol instead.
4356
*
57+
* @deprecated
4458
* @var bool
4559
*/
4660
public $openTelemetryProtocolEnabled;
@@ -59,6 +73,12 @@ class GoogleCloudApigeeV1RuntimeTraceConfigOverride extends \Google\Model
5973
public $revisionId;
6074
protected $samplingConfigType = GoogleCloudApigeeV1RuntimeTraceSamplingConfig::class;
6175
protected $samplingConfigDataType = '';
76+
/**
77+
* Optional. The trace protocol to use.
78+
*
79+
* @var string
80+
*/
81+
public $traceProtocol;
6282
/**
6383
* Unique ID for the configuration override. The ID will only change if the
6484
* override is deleted and recreated. Corresponds to name's "override" field.
@@ -102,20 +122,23 @@ public function getName()
102122
return $this->name;
103123
}
104124
/**
105-
* If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace
106-
* data. Configuration Requirements (if `open_telemetry_protocol_enabled` is
107-
* `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or
108-
* `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`:
109-
* - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is
110-
* `CLOUD_TRACE`: - `endpoint` refers to a valid project ID
125+
* Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send
126+
* trace data. Configuration Requirements (if
127+
* `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s:
128+
* `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is
129+
* `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector
130+
* URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid
131+
* project ID Deprecated: Use trace_protocol instead.
111132
*
133+
* @deprecated
112134
* @param bool $openTelemetryProtocolEnabled
113135
*/
114136
public function setOpenTelemetryProtocolEnabled($openTelemetryProtocolEnabled)
115137
{
116138
$this->openTelemetryProtocolEnabled = $openTelemetryProtocolEnabled;
117139
}
118140
/**
141+
* @deprecated
119142
* @return bool
120143
*/
121144
public function getOpenTelemetryProtocolEnabled()
@@ -171,6 +194,24 @@ public function getSamplingConfig()
171194
{
172195
return $this->samplingConfig;
173196
}
197+
/**
198+
* Optional. The trace protocol to use.
199+
*
200+
* Accepted values: TRACE_PROTOCOL_UNSPECIFIED, OPEN_CENSUS, OTLP
201+
*
202+
* @param self::TRACE_PROTOCOL_* $traceProtocol
203+
*/
204+
public function setTraceProtocol($traceProtocol)
205+
{
206+
$this->traceProtocol = $traceProtocol;
207+
}
208+
/**
209+
* @return self::TRACE_PROTOCOL_*
210+
*/
211+
public function getTraceProtocol()
212+
{
213+
return $this->traceProtocol;
214+
}
174215
/**
175216
* Unique ID for the configuration override. The ID will only change if the
176217
* override is deleted and recreated. Corresponds to name's "override" field.

src/Apigee/GoogleCloudApigeeV1TraceConfig.php

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,21 @@ class GoogleCloudApigeeV1TraceConfig extends \Google\Model
2424
*/
2525
public const EXPORTER_EXPORTER_UNSPECIFIED = 'EXPORTER_UNSPECIFIED';
2626
/**
27-
* Jaeger exporter
27+
* Exports events to Jaeger. Compatible with OpenCensus protocol.
2828
*/
2929
public const EXPORTER_JAEGER = 'JAEGER';
3030
/**
31-
* Cloudtrace exporter
31+
* Exports events to Cloud Trace. Compatible with OpenCensus protocol.
3232
*/
3333
public const EXPORTER_CLOUD_TRACE = 'CLOUD_TRACE';
3434
/**
35-
* Open Telemetry Collector
35+
* OpenTelemetry Collector. Compatible with OpenTelemetry protocol.
3636
*/
3737
public const EXPORTER_OPEN_TELEMETRY_COLLECTOR = 'OPEN_TELEMETRY_COLLECTOR';
38+
/**
39+
* Exports events to Cloud Trace. Compatible with OpenTelemetry protocol.
40+
*/
41+
public const EXPORTER_OPEN_TELEMETRY_CLOUD_TRACE = 'OPEN_TELEMETRY_CLOUD_TRACE';
3842
/**
3943
* Required. Endpoint of the exporter.
4044
*
@@ -43,8 +47,9 @@ class GoogleCloudApigeeV1TraceConfig extends \Google\Model
4347
public $endpoint;
4448
/**
4549
* Required. Exporter that is used to view the distributed trace captured
46-
* using OpenCensus. An exporter sends traces to any backend that is capable
47-
* of consuming them. Recorded spans can be exported by registered exporters.
50+
* using the chosen trace protocol. An exporter sends traces to any backend
51+
* that is capable of consuming them. Recorded spans can be exported by
52+
* registered exporters.
4853
*
4954
* @var string
5055
*/
@@ -70,11 +75,12 @@ public function getEndpoint()
7075
}
7176
/**
7277
* Required. Exporter that is used to view the distributed trace captured
73-
* using OpenCensus. An exporter sends traces to any backend that is capable
74-
* of consuming them. Recorded spans can be exported by registered exporters.
78+
* using the chosen trace protocol. An exporter sends traces to any backend
79+
* that is capable of consuming them. Recorded spans can be exported by
80+
* registered exporters.
7581
*
7682
* Accepted values: EXPORTER_UNSPECIFIED, JAEGER, CLOUD_TRACE,
77-
* OPEN_TELEMETRY_COLLECTOR
83+
* OPEN_TELEMETRY_COLLECTOR, OPEN_TELEMETRY_CLOUD_TRACE
7884
*
7985
* @param self::EXPORTER_* $exporter
8086
*/

src/Apigee/Resource/OrganizationsDevelopersApps.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,12 @@ public function get($name, $optParams = [])
172172
* limit is 1000.
173173
* @opt_param bool expand Optional. Specifies whether to expand the results. Set
174174
* to `true` to expand the results. This query parameter is not valid if you use
175-
* the `count` or `startKey` query parameters.
175+
* the `count` or `startKey` query parameters. **Note**: If set to `true`, the
176+
* `apigee.developerapps.get` permission is required.
176177
* @opt_param bool shallowExpand Optional. Specifies whether to expand the
177178
* results in shallow mode. Set to `true` to expand the results in shallow mode.
179+
* **Note**: If set to `true`, the `apigee.developerapps.get` permission is
180+
* required.
178181
* @opt_param string startKey **Note**: Must be used in conjunction with the
179182
* `count` parameter. Name of the developer app from which to start displaying
180183
* the list of developer apps. For example, if you're returning 50 developer

0 commit comments

Comments
 (0)