Skip to content

Commit f2f275e

Browse files
gcf-owl-bot[bot]suztomo
gcf-owl-bot[bot]
and
suztomo
authored
docs: [maps-places] change comments for some fields in Places API (#10124)
* docs: change comments for some fields in Places API feat: add new wheelchair accessibility fields feat: add new primary type fields feat: add new short formatted address field PiperOrigin-RevId: 588852313 Source-Link: googleapis/googleapis@fe38367 Source-Link: https://github.com/googleapis/googleapis-gen/commit/d1a3cba834ead4c8a93644dd84ff0d2b0fc57b25 Copy-Tag: eyJwIjoiamF2YS1tYXBzLXBsYWNlcy8uT3dsQm90LnlhbWwiLCJoIjoiZDFhM2NiYTgzNGVhZDRjOGE5MzY0NGRkODRmZjBkMmIwZmM1N2IyNSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Tomo Suzuki <suztomo@google.com>
1 parent b833bfe commit f2f275e

35 files changed

Lines changed: 6707 additions & 5637 deletions

‎java-maps-places/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
201201
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-places/java11.html
202202
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
203203
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.maps/google-maps-places.svg
204-
[maven-version-link]: https://central.sonatype.com/artifact/com.google.maps/google-maps-places/0.0.0
204+
[maven-version-link]: https://central.sonatype.com/artifact/com.google.maps/google-maps-places/0.2.0
205205
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
206206
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
207207
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

‎java-maps-places/google-maps-places/src/main/java/com/google/maps/places/v1/PlacesClient.java‎

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
// AUTO-GENERATED DOCUMENTATION AND CLASS.
2828
/**
2929
* Service Description: Service definition for the Places API. Note: every request actually requires
30-
* a field mask set outside of the request proto (all/'&#42;' is not assumed). That can be set via
30+
* a field mask set outside of the request proto (all/'&#42;', is not assumed). That can be set via
3131
* either a side channel (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over
3232
* HTTP. See: https://cloud.google.com/apis/docs/system-parameters
3333
*
@@ -335,8 +335,11 @@ public final UnaryCallable<SearchTextRequest, SearchTextResponse> searchTextCall
335335
* }
336336
* }</pre>
337337
*
338-
* @param name Required. The resource name of a photo. It is returned in Place's photos.name
339-
* field. Format: places/&lt;place_id&gt;/photos/&lt;photo_reference&gt;/media.
338+
* @param name Required. The resource name of a photo media in the format:
339+
* `places/{place_id}/photos/{photo_reference}/media`.
340+
* <p>The resource name of a photo as returned in a Place object's `photos.name` field comes
341+
* with the format `places/{place_id}/photos/{photo_reference}`. You need to append `/media`
342+
* at the end of the photo resource to get the photo media resource name.
340343
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
341344
*/
342345
public final PhotoMedia getPhotoMedia(PhotoMediaName name) {
@@ -363,8 +366,11 @@ public final PhotoMedia getPhotoMedia(PhotoMediaName name) {
363366
* }
364367
* }</pre>
365368
*
366-
* @param name Required. The resource name of a photo. It is returned in Place's photos.name
367-
* field. Format: places/&lt;place_id&gt;/photos/&lt;photo_reference&gt;/media.
369+
* @param name Required. The resource name of a photo media in the format:
370+
* `places/{place_id}/photos/{photo_reference}/media`.
371+
* <p>The resource name of a photo as returned in a Place object's `photos.name` field comes
372+
* with the format `places/{place_id}/photos/{photo_reference}`. You need to append `/media`
373+
* at the end of the photo resource to get the photo media resource name.
368374
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
369375
*/
370376
public final PhotoMedia getPhotoMedia(String name) {
@@ -435,7 +441,7 @@ public final UnaryCallable<GetPhotoMediaRequest, PhotoMedia> getPhotoMediaCallab
435441

436442
// AUTO-GENERATED DOCUMENTATION AND METHOD.
437443
/**
438-
* Get a Place with a place id (in a name) string.
444+
* Get place details with a place id (in a name) string.
439445
*
440446
* <p>Sample code:
441447
*
@@ -451,8 +457,8 @@ public final UnaryCallable<GetPhotoMediaRequest, PhotoMedia> getPhotoMediaCallab
451457
* }
452458
* }</pre>
453459
*
454-
* @param name Required. A place_id returned in a Place (with "places/" prefix), or equivalently
455-
* the name in the same Place. Format: places/&lt;place_id&gt;.
460+
* @param name Required. A place ID returned in a Place (with "places/" prefix), or equivalently
461+
* the name in the same Place. Format: `places/{place_id}`.
456462
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
457463
*/
458464
public final Place getPlace(PlaceName name) {
@@ -463,7 +469,7 @@ public final Place getPlace(PlaceName name) {
463469

464470
// AUTO-GENERATED DOCUMENTATION AND METHOD.
465471
/**
466-
* Get a Place with a place id (in a name) string.
472+
* Get place details with a place id (in a name) string.
467473
*
468474
* <p>Sample code:
469475
*
@@ -479,8 +485,8 @@ public final Place getPlace(PlaceName name) {
479485
* }
480486
* }</pre>
481487
*
482-
* @param name Required. A place_id returned in a Place (with "places/" prefix), or equivalently
483-
* the name in the same Place. Format: places/&lt;place_id&gt;.
488+
* @param name Required. A place ID returned in a Place (with "places/" prefix), or equivalently
489+
* the name in the same Place. Format: `places/{place_id}`.
484490
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
485491
*/
486492
public final Place getPlace(String name) {
@@ -490,7 +496,7 @@ public final Place getPlace(String name) {
490496

491497
// AUTO-GENERATED DOCUMENTATION AND METHOD.
492498
/**
493-
* Get a Place with a place id (in a name) string.
499+
* Get place details with a place id (in a name) string.
494500
*
495501
* <p>Sample code:
496502
*
@@ -520,7 +526,7 @@ public final Place getPlace(GetPlaceRequest request) {
520526

521527
// AUTO-GENERATED DOCUMENTATION AND METHOD.
522528
/**
523-
* Get a Place with a place id (in a name) string.
529+
* Get place details with a place id (in a name) string.
524530
*
525531
* <p>Sample code:
526532
*

‎java-maps-places/google-maps-places/src/main/java/com/google/maps/places/v1/package-info.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* <p>======================= PlacesClient =======================
2323
*
2424
* <p>Service Description: Service definition for the Places API. Note: every request actually
25-
* requires a field mask set outside of the request proto (all/'&#42;' is not assumed). That can be
25+
* requires a field mask set outside of the request proto (all/'&#42;', is not assumed). That can be
2626
* set via either a side channel (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask)
2727
* over HTTP. See: https://cloud.google.com/apis/docs/system-parameters
2828
*

‎java-maps-places/google-maps-places/src/test/java/com/google/maps/places/v1/PlacesClientHttpJsonTest.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,9 +302,12 @@ public void getPlaceTest() throws Exception {
302302
.setId("id3355")
303303
.setDisplayName(LocalizedText.newBuilder().build())
304304
.addAllTypes(new ArrayList<String>())
305+
.setPrimaryType("primaryType-867549092")
306+
.setPrimaryTypeDisplayName(LocalizedText.newBuilder().build())
305307
.setNationalPhoneNumber("nationalPhoneNumber-1432446651")
306308
.setInternationalPhoneNumber("internationalPhoneNumber-74125591")
307309
.setFormattedAddress("formattedAddress1036810136")
310+
.setShortFormattedAddress("shortFormattedAddress282445876")
308311
.addAllAddressComponents(new ArrayList<Place.AddressComponent>())
309312
.setPlusCode(Place.PlusCode.newBuilder().build())
310313
.setLocation(LatLng.newBuilder().build())
@@ -402,9 +405,12 @@ public void getPlaceTest2() throws Exception {
402405
.setId("id3355")
403406
.setDisplayName(LocalizedText.newBuilder().build())
404407
.addAllTypes(new ArrayList<String>())
408+
.setPrimaryType("primaryType-867549092")
409+
.setPrimaryTypeDisplayName(LocalizedText.newBuilder().build())
405410
.setNationalPhoneNumber("nationalPhoneNumber-1432446651")
406411
.setInternationalPhoneNumber("internationalPhoneNumber-74125591")
407412
.setFormattedAddress("formattedAddress1036810136")
413+
.setShortFormattedAddress("shortFormattedAddress282445876")
408414
.addAllAddressComponents(new ArrayList<Place.AddressComponent>())
409415
.setPlusCode(Place.PlusCode.newBuilder().build())
410416
.setLocation(LatLng.newBuilder().build())

‎java-maps-places/google-maps-places/src/test/java/com/google/maps/places/v1/PlacesClientTest.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,9 +304,12 @@ public void getPlaceTest() throws Exception {
304304
.setId("id3355")
305305
.setDisplayName(LocalizedText.newBuilder().build())
306306
.addAllTypes(new ArrayList<String>())
307+
.setPrimaryType("primaryType-867549092")
308+
.setPrimaryTypeDisplayName(LocalizedText.newBuilder().build())
307309
.setNationalPhoneNumber("nationalPhoneNumber-1432446651")
308310
.setInternationalPhoneNumber("internationalPhoneNumber-74125591")
309311
.setFormattedAddress("formattedAddress1036810136")
312+
.setShortFormattedAddress("shortFormattedAddress282445876")
310313
.addAllAddressComponents(new ArrayList<Place.AddressComponent>())
311314
.setPlusCode(Place.PlusCode.newBuilder().build())
312315
.setLocation(LatLng.newBuilder().build())
@@ -398,9 +401,12 @@ public void getPlaceTest2() throws Exception {
398401
.setId("id3355")
399402
.setDisplayName(LocalizedText.newBuilder().build())
400403
.addAllTypes(new ArrayList<String>())
404+
.setPrimaryType("primaryType-867549092")
405+
.setPrimaryTypeDisplayName(LocalizedText.newBuilder().build())
401406
.setNationalPhoneNumber("nationalPhoneNumber-1432446651")
402407
.setInternationalPhoneNumber("internationalPhoneNumber-74125591")
403408
.setFormattedAddress("formattedAddress1036810136")
409+
.setShortFormattedAddress("shortFormattedAddress282445876")
404410
.addAllAddressComponents(new ArrayList<Place.AddressComponent>())
405411
.setPlusCode(Place.PlusCode.newBuilder().build())
406412
.setLocation(LatLng.newBuilder().build())

‎java-maps-places/grpc-google-maps-places-v1/src/main/java/com/google/maps/places/v1/PlacesGrpc.java‎

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@
2222
*
2323
* <pre>
2424
* Service definition for the Places API.
25-
* Note: every request actually requires a field mask set outside of the request
26-
* proto (all/'*' is not assumed). That can be set via either a side channel
27-
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
28-
* See: https://cloud.google.com/apis/docs/system-parameters
25+
* Note: every request actually requires a field mask set outside of
26+
* the request proto (all/'*', is not assumed). That can be set via either a
27+
* side channel (SystemParameterContext) over RPC, or a header
28+
* (X-Goog-FieldMask) over HTTP. See:
29+
* https://cloud.google.com/apis/docs/system-parameters
2930
* </pre>
3031
*/
3132
@javax.annotation.Generated(
@@ -251,10 +252,11 @@ public PlacesFutureStub newStub(
251252
*
252253
* <pre>
253254
* Service definition for the Places API.
254-
* Note: every request actually requires a field mask set outside of the request
255-
* proto (all/'*' is not assumed). That can be set via either a side channel
256-
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
257-
* See: https://cloud.google.com/apis/docs/system-parameters
255+
* Note: every request actually requires a field mask set outside of
256+
* the request proto (all/'*', is not assumed). That can be set via either a
257+
* side channel (SystemParameterContext) over RPC, or a header
258+
* (X-Goog-FieldMask) over HTTP. See:
259+
* https://cloud.google.com/apis/docs/system-parameters
258260
* </pre>
259261
*/
260262
public interface AsyncService {
@@ -306,7 +308,7 @@ default void getPhotoMedia(
306308
*
307309
*
308310
* <pre>
309-
* Get a Place with a place id (in a name) string.
311+
* Get place details with a place id (in a name) string.
310312
* </pre>
311313
*/
312314
default void getPlace(
@@ -321,10 +323,11 @@ default void getPlace(
321323
*
322324
* <pre>
323325
* Service definition for the Places API.
324-
* Note: every request actually requires a field mask set outside of the request
325-
* proto (all/'*' is not assumed). That can be set via either a side channel
326-
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
327-
* See: https://cloud.google.com/apis/docs/system-parameters
326+
* Note: every request actually requires a field mask set outside of
327+
* the request proto (all/'*', is not assumed). That can be set via either a
328+
* side channel (SystemParameterContext) over RPC, or a header
329+
* (X-Goog-FieldMask) over HTTP. See:
330+
* https://cloud.google.com/apis/docs/system-parameters
328331
* </pre>
329332
*/
330333
public abstract static class PlacesImplBase implements io.grpc.BindableService, AsyncService {
@@ -340,10 +343,11 @@ public final io.grpc.ServerServiceDefinition bindService() {
340343
*
341344
* <pre>
342345
* Service definition for the Places API.
343-
* Note: every request actually requires a field mask set outside of the request
344-
* proto (all/'*' is not assumed). That can be set via either a side channel
345-
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
346-
* See: https://cloud.google.com/apis/docs/system-parameters
346+
* Note: every request actually requires a field mask set outside of
347+
* the request proto (all/'*', is not assumed). That can be set via either a
348+
* side channel (SystemParameterContext) over RPC, or a header
349+
* (X-Goog-FieldMask) over HTTP. See:
350+
* https://cloud.google.com/apis/docs/system-parameters
347351
* </pre>
348352
*/
349353
public static final class PlacesStub extends io.grpc.stub.AbstractAsyncStub<PlacesStub> {
@@ -408,7 +412,7 @@ public void getPhotoMedia(
408412
*
409413
*
410414
* <pre>
411-
* Get a Place with a place id (in a name) string.
415+
* Get place details with a place id (in a name) string.
412416
* </pre>
413417
*/
414418
public void getPlace(
@@ -424,10 +428,11 @@ public void getPlace(
424428
*
425429
* <pre>
426430
* Service definition for the Places API.
427-
* Note: every request actually requires a field mask set outside of the request
428-
* proto (all/'*' is not assumed). That can be set via either a side channel
429-
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
430-
* See: https://cloud.google.com/apis/docs/system-parameters
431+
* Note: every request actually requires a field mask set outside of
432+
* the request proto (all/'*', is not assumed). That can be set via either a
433+
* side channel (SystemParameterContext) over RPC, or a header
434+
* (X-Goog-FieldMask) over HTTP. See:
435+
* https://cloud.google.com/apis/docs/system-parameters
431436
* </pre>
432437
*/
433438
public static final class PlacesBlockingStub
@@ -484,7 +489,7 @@ public com.google.maps.places.v1.PhotoMedia getPhotoMedia(
484489
*
485490
*
486491
* <pre>
487-
* Get a Place with a place id (in a name) string.
492+
* Get place details with a place id (in a name) string.
488493
* </pre>
489494
*/
490495
public com.google.maps.places.v1.Place getPlace(
@@ -499,10 +504,11 @@ public com.google.maps.places.v1.Place getPlace(
499504
*
500505
* <pre>
501506
* Service definition for the Places API.
502-
* Note: every request actually requires a field mask set outside of the request
503-
* proto (all/'*' is not assumed). That can be set via either a side channel
504-
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
505-
* See: https://cloud.google.com/apis/docs/system-parameters
507+
* Note: every request actually requires a field mask set outside of
508+
* the request proto (all/'*', is not assumed). That can be set via either a
509+
* side channel (SystemParameterContext) over RPC, or a header
510+
* (X-Goog-FieldMask) over HTTP. See:
511+
* https://cloud.google.com/apis/docs/system-parameters
506512
* </pre>
507513
*/
508514
public static final class PlacesFutureStub
@@ -561,7 +567,7 @@ protected PlacesFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
561567
*
562568
*
563569
* <pre>
564-
* Get a Place with a place id (in a name) string.
570+
* Get place details with a place id (in a name) string.
565571
* </pre>
566572
*/
567573
public com.google.common.util.concurrent.ListenableFuture<com.google.maps.places.v1.Place>

‎java-maps-places/proto-google-maps-places-v1/src/main/java/com/google/maps/places/v1/AttributionProto.java‎

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,17 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
4141
static {
4242
java.lang.String[] descriptorData = {
4343
"\n\'google/maps/places/v1/attribution.prot"
44-
+ "o\022\025google.maps.places.v1\032\037google/api/fie"
45-
+ "ld_behavior.proto\"[\n\021AuthorAttribution\022\032"
46-
+ "\n\014display_name\030\001 \001(\tB\004\342A\001\003\022\021\n\003uri\030\002 \001(\tB"
47-
+ "\004\342A\001\003\022\027\n\tphoto_uri\030\003 \001(\tB\004\342A\001\003B\244\001\n\031com.g"
48-
+ "oogle.maps.places.v1B\020AttributionProtoP\001"
49-
+ "Z7cloud.google.com/go/maps/places/apiv1/"
50-
+ "placespb;placespb\370\001\001\242\002\006GMPSV1\252\002\025Google.M"
51-
+ "aps.Places.V1\312\002\025Google\\Maps\\Places\\V1b\006p"
52-
+ "roto3"
44+
+ "o\022\025google.maps.places.v1\"I\n\021AuthorAttrib"
45+
+ "ution\022\024\n\014display_name\030\001 \001(\t\022\013\n\003uri\030\002 \001(\t"
46+
+ "\022\021\n\tphoto_uri\030\003 \001(\tB\244\001\n\031com.google.maps."
47+
+ "places.v1B\020AttributionProtoP\001Z7cloud.goo"
48+
+ "gle.com/go/maps/places/apiv1/placespb;pl"
49+
+ "acespb\370\001\001\242\002\006GMPSV1\252\002\025Google.Maps.Places."
50+
+ "V1\312\002\025Google\\Maps\\Places\\V1b\006proto3"
5351
};
5452
descriptor =
5553
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
56-
descriptorData,
57-
new com.google.protobuf.Descriptors.FileDescriptor[] {
58-
com.google.api.FieldBehaviorProto.getDescriptor(),
59-
});
54+
descriptorData, new com.google.protobuf.Descriptors.FileDescriptor[] {});
6055
internal_static_google_maps_places_v1_AuthorAttribution_descriptor =
6156
getDescriptor().getMessageTypes().get(0);
6257
internal_static_google_maps_places_v1_AuthorAttribution_fieldAccessorTable =
@@ -65,12 +60,6 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
6560
new java.lang.String[] {
6661
"DisplayName", "Uri", "PhotoUri",
6762
});
68-
com.google.protobuf.ExtensionRegistry registry =
69-
com.google.protobuf.ExtensionRegistry.newInstance();
70-
registry.add(com.google.api.FieldBehaviorProto.fieldBehavior);
71-
com.google.protobuf.Descriptors.FileDescriptor.internalUpdateFileDescriptor(
72-
descriptor, registry);
73-
com.google.api.FieldBehaviorProto.getDescriptor();
7463
}
7564

7665
// @@protoc_insertion_point(outer_class_scope)

0 commit comments

Comments
 (0)