Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [maps-places] change comments for some fields in Places API #10124

Merged
merged 3 commits into from
Jan 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion java-maps-places/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-places/java11.html
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.maps/google-maps-places.svg
[maven-version-link]: https://central.sonatype.com/artifact/com.google.maps/google-maps-places/0.0.0
[maven-version-link]: https://central.sonatype.com/artifact/com.google.maps/google-maps-places/0.2.0
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service definition for the Places API. Note: every request actually requires
* a field mask set outside of the request proto (all/'*' is not assumed). That can be set via
* a field mask set outside of the request proto (all/'*', is not assumed). That can be set via
* either a side channel (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over
* HTTP. See: https://cloud.google.com/apis/docs/system-parameters
*
Expand Down Expand Up @@ -335,8 +335,11 @@ public final UnaryCallable<SearchTextRequest, SearchTextResponse> searchTextCall
* }
* }</pre>
*
* @param name Required. The resource name of a photo. It is returned in Place's photos.name
* field. Format: places/&lt;place_id&gt;/photos/&lt;photo_reference&gt;/media.
* @param name Required. The resource name of a photo media in the format:
* `places/{place_id}/photos/{photo_reference}/media`.
* <p>The resource name of a photo as returned in a Place object's `photos.name` field comes
* with the format `places/{place_id}/photos/{photo_reference}`. You need to append `/media`
* at the end of the photo resource to get the photo media resource name.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final PhotoMedia getPhotoMedia(PhotoMediaName name) {
Expand All @@ -363,8 +366,11 @@ public final PhotoMedia getPhotoMedia(PhotoMediaName name) {
* }
* }</pre>
*
* @param name Required. The resource name of a photo. It is returned in Place's photos.name
* field. Format: places/&lt;place_id&gt;/photos/&lt;photo_reference&gt;/media.
* @param name Required. The resource name of a photo media in the format:
* `places/{place_id}/photos/{photo_reference}/media`.
* <p>The resource name of a photo as returned in a Place object's `photos.name` field comes
* with the format `places/{place_id}/photos/{photo_reference}`. You need to append `/media`
* at the end of the photo resource to get the photo media resource name.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final PhotoMedia getPhotoMedia(String name) {
Expand Down Expand Up @@ -435,7 +441,7 @@ public final UnaryCallable<GetPhotoMediaRequest, PhotoMedia> getPhotoMediaCallab

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get a Place with a place id (in a name) string.
* Get place details with a place id (in a name) string.
*
* <p>Sample code:
*
Expand All @@ -451,8 +457,8 @@ public final UnaryCallable<GetPhotoMediaRequest, PhotoMedia> getPhotoMediaCallab
* }
* }</pre>
*
* @param name Required. A place_id returned in a Place (with "places/" prefix), or equivalently
* the name in the same Place. Format: places/&lt;place_id&gt;.
* @param name Required. A place ID returned in a Place (with "places/" prefix), or equivalently
* the name in the same Place. Format: `places/{place_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Place getPlace(PlaceName name) {
Expand All @@ -463,7 +469,7 @@ public final Place getPlace(PlaceName name) {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get a Place with a place id (in a name) string.
* Get place details with a place id (in a name) string.
*
* <p>Sample code:
*
Expand All @@ -479,8 +485,8 @@ public final Place getPlace(PlaceName name) {
* }
* }</pre>
*
* @param name Required. A place_id returned in a Place (with "places/" prefix), or equivalently
* the name in the same Place. Format: places/&lt;place_id&gt;.
* @param name Required. A place ID returned in a Place (with "places/" prefix), or equivalently
* the name in the same Place. Format: `places/{place_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Place getPlace(String name) {
Expand All @@ -490,7 +496,7 @@ public final Place getPlace(String name) {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get a Place with a place id (in a name) string.
* Get place details with a place id (in a name) string.
*
* <p>Sample code:
*
Expand Down Expand Up @@ -520,7 +526,7 @@ public final Place getPlace(GetPlaceRequest request) {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get a Place with a place id (in a name) string.
* Get place details with a place id (in a name) string.
*
* <p>Sample code:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* <p>======================= PlacesClient =======================
*
* <p>Service Description: Service definition for the Places API. Note: every request actually
* requires a field mask set outside of the request proto (all/'&#42;' is not assumed). That can be
* requires a field mask set outside of the request proto (all/'&#42;', is not assumed). That can be
* set via either a side channel (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask)
* over HTTP. See: https://cloud.google.com/apis/docs/system-parameters
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -302,9 +302,12 @@ public void getPlaceTest() throws Exception {
.setId("id3355")
.setDisplayName(LocalizedText.newBuilder().build())
.addAllTypes(new ArrayList<String>())
.setPrimaryType("primaryType-867549092")
.setPrimaryTypeDisplayName(LocalizedText.newBuilder().build())
.setNationalPhoneNumber("nationalPhoneNumber-1432446651")
.setInternationalPhoneNumber("internationalPhoneNumber-74125591")
.setFormattedAddress("formattedAddress1036810136")
.setShortFormattedAddress("shortFormattedAddress282445876")
.addAllAddressComponents(new ArrayList<Place.AddressComponent>())
.setPlusCode(Place.PlusCode.newBuilder().build())
.setLocation(LatLng.newBuilder().build())
Expand Down Expand Up @@ -402,9 +405,12 @@ public void getPlaceTest2() throws Exception {
.setId("id3355")
.setDisplayName(LocalizedText.newBuilder().build())
.addAllTypes(new ArrayList<String>())
.setPrimaryType("primaryType-867549092")
.setPrimaryTypeDisplayName(LocalizedText.newBuilder().build())
.setNationalPhoneNumber("nationalPhoneNumber-1432446651")
.setInternationalPhoneNumber("internationalPhoneNumber-74125591")
.setFormattedAddress("formattedAddress1036810136")
.setShortFormattedAddress("shortFormattedAddress282445876")
.addAllAddressComponents(new ArrayList<Place.AddressComponent>())
.setPlusCode(Place.PlusCode.newBuilder().build())
.setLocation(LatLng.newBuilder().build())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -304,9 +304,12 @@ public void getPlaceTest() throws Exception {
.setId("id3355")
.setDisplayName(LocalizedText.newBuilder().build())
.addAllTypes(new ArrayList<String>())
.setPrimaryType("primaryType-867549092")
.setPrimaryTypeDisplayName(LocalizedText.newBuilder().build())
.setNationalPhoneNumber("nationalPhoneNumber-1432446651")
.setInternationalPhoneNumber("internationalPhoneNumber-74125591")
.setFormattedAddress("formattedAddress1036810136")
.setShortFormattedAddress("shortFormattedAddress282445876")
.addAllAddressComponents(new ArrayList<Place.AddressComponent>())
.setPlusCode(Place.PlusCode.newBuilder().build())
.setLocation(LatLng.newBuilder().build())
Expand Down Expand Up @@ -398,9 +401,12 @@ public void getPlaceTest2() throws Exception {
.setId("id3355")
.setDisplayName(LocalizedText.newBuilder().build())
.addAllTypes(new ArrayList<String>())
.setPrimaryType("primaryType-867549092")
.setPrimaryTypeDisplayName(LocalizedText.newBuilder().build())
.setNationalPhoneNumber("nationalPhoneNumber-1432446651")
.setInternationalPhoneNumber("internationalPhoneNumber-74125591")
.setFormattedAddress("formattedAddress1036810136")
.setShortFormattedAddress("shortFormattedAddress282445876")
.addAllAddressComponents(new ArrayList<Place.AddressComponent>())
.setPlusCode(Place.PlusCode.newBuilder().build())
.setLocation(LatLng.newBuilder().build())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@
*
* <pre>
* Service definition for the Places API.
* Note: every request actually requires a field mask set outside of the request
* proto (all/'*' is not assumed). That can be set via either a side channel
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
* See: https://cloud.google.com/apis/docs/system-parameters
* Note: every request actually requires a field mask set outside of
* the request proto (all/'*', is not assumed). That can be set via either a
* side channel (SystemParameterContext) over RPC, or a header
* (X-Goog-FieldMask) over HTTP. See:
* https://cloud.google.com/apis/docs/system-parameters
* </pre>
*/
@javax.annotation.Generated(
Expand Down Expand Up @@ -251,10 +252,11 @@ public PlacesFutureStub newStub(
*
* <pre>
* Service definition for the Places API.
* Note: every request actually requires a field mask set outside of the request
* proto (all/'*' is not assumed). That can be set via either a side channel
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
* See: https://cloud.google.com/apis/docs/system-parameters
* Note: every request actually requires a field mask set outside of
* the request proto (all/'*', is not assumed). That can be set via either a
* side channel (SystemParameterContext) over RPC, or a header
* (X-Goog-FieldMask) over HTTP. See:
* https://cloud.google.com/apis/docs/system-parameters
* </pre>
*/
public interface AsyncService {
Expand Down Expand Up @@ -306,7 +308,7 @@ default void getPhotoMedia(
*
*
* <pre>
* Get a Place with a place id (in a name) string.
* Get place details with a place id (in a name) string.
* </pre>
*/
default void getPlace(
Expand All @@ -321,10 +323,11 @@ default void getPlace(
*
* <pre>
* Service definition for the Places API.
* Note: every request actually requires a field mask set outside of the request
* proto (all/'*' is not assumed). That can be set via either a side channel
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
* See: https://cloud.google.com/apis/docs/system-parameters
* Note: every request actually requires a field mask set outside of
* the request proto (all/'*', is not assumed). That can be set via either a
* side channel (SystemParameterContext) over RPC, or a header
* (X-Goog-FieldMask) over HTTP. See:
* https://cloud.google.com/apis/docs/system-parameters
* </pre>
*/
public abstract static class PlacesImplBase implements io.grpc.BindableService, AsyncService {
Expand All @@ -340,10 +343,11 @@ public final io.grpc.ServerServiceDefinition bindService() {
*
* <pre>
* Service definition for the Places API.
* Note: every request actually requires a field mask set outside of the request
* proto (all/'*' is not assumed). That can be set via either a side channel
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
* See: https://cloud.google.com/apis/docs/system-parameters
* Note: every request actually requires a field mask set outside of
* the request proto (all/'*', is not assumed). That can be set via either a
* side channel (SystemParameterContext) over RPC, or a header
* (X-Goog-FieldMask) over HTTP. See:
* https://cloud.google.com/apis/docs/system-parameters
* </pre>
*/
public static final class PlacesStub extends io.grpc.stub.AbstractAsyncStub<PlacesStub> {
Expand Down Expand Up @@ -408,7 +412,7 @@ public void getPhotoMedia(
*
*
* <pre>
* Get a Place with a place id (in a name) string.
* Get place details with a place id (in a name) string.
* </pre>
*/
public void getPlace(
Expand All @@ -424,10 +428,11 @@ public void getPlace(
*
* <pre>
* Service definition for the Places API.
* Note: every request actually requires a field mask set outside of the request
* proto (all/'*' is not assumed). That can be set via either a side channel
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
* See: https://cloud.google.com/apis/docs/system-parameters
* Note: every request actually requires a field mask set outside of
* the request proto (all/'*', is not assumed). That can be set via either a
* side channel (SystemParameterContext) over RPC, or a header
* (X-Goog-FieldMask) over HTTP. See:
* https://cloud.google.com/apis/docs/system-parameters
* </pre>
*/
public static final class PlacesBlockingStub
Expand Down Expand Up @@ -484,7 +489,7 @@ public com.google.maps.places.v1.PhotoMedia getPhotoMedia(
*
*
* <pre>
* Get a Place with a place id (in a name) string.
* Get place details with a place id (in a name) string.
* </pre>
*/
public com.google.maps.places.v1.Place getPlace(
Expand All @@ -499,10 +504,11 @@ public com.google.maps.places.v1.Place getPlace(
*
* <pre>
* Service definition for the Places API.
* Note: every request actually requires a field mask set outside of the request
* proto (all/'*' is not assumed). That can be set via either a side channel
* (SystemParameterContext) over RPC, or a header (X-Goog-FieldMask) over HTTP.
* See: https://cloud.google.com/apis/docs/system-parameters
* Note: every request actually requires a field mask set outside of
* the request proto (all/'*', is not assumed). That can be set via either a
* side channel (SystemParameterContext) over RPC, or a header
* (X-Goog-FieldMask) over HTTP. See:
* https://cloud.google.com/apis/docs/system-parameters
* </pre>
*/
public static final class PlacesFutureStub
Expand Down Expand Up @@ -561,7 +567,7 @@ protected PlacesFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
*
*
* <pre>
* Get a Place with a place id (in a name) string.
* Get place details with a place id (in a name) string.
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.maps.places.v1.Place>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,22 +41,17 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
static {
java.lang.String[] descriptorData = {
"\n\'google/maps/places/v1/attribution.prot"
+ "o\022\025google.maps.places.v1\032\037google/api/fie"
+ "ld_behavior.proto\"[\n\021AuthorAttribution\022\032"
+ "\n\014display_name\030\001 \001(\tB\004\342A\001\003\022\021\n\003uri\030\002 \001(\tB"
+ "\004\342A\001\003\022\027\n\tphoto_uri\030\003 \001(\tB\004\342A\001\003B\244\001\n\031com.g"
+ "oogle.maps.places.v1B\020AttributionProtoP\001"
+ "Z7cloud.google.com/go/maps/places/apiv1/"
+ "placespb;placespb\370\001\001\242\002\006GMPSV1\252\002\025Google.M"
+ "aps.Places.V1\312\002\025Google\\Maps\\Places\\V1b\006p"
+ "roto3"
+ "o\022\025google.maps.places.v1\"I\n\021AuthorAttrib"
+ "ution\022\024\n\014display_name\030\001 \001(\t\022\013\n\003uri\030\002 \001(\t"
+ "\022\021\n\tphoto_uri\030\003 \001(\tB\244\001\n\031com.google.maps."
+ "places.v1B\020AttributionProtoP\001Z7cloud.goo"
+ "gle.com/go/maps/places/apiv1/placespb;pl"
+ "acespb\370\001\001\242\002\006GMPSV1\252\002\025Google.Maps.Places."
+ "V1\312\002\025Google\\Maps\\Places\\V1b\006proto3"
};
descriptor =
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
descriptorData,
new com.google.protobuf.Descriptors.FileDescriptor[] {
com.google.api.FieldBehaviorProto.getDescriptor(),
});
descriptorData, new com.google.protobuf.Descriptors.FileDescriptor[] {});
internal_static_google_maps_places_v1_AuthorAttribution_descriptor =
getDescriptor().getMessageTypes().get(0);
internal_static_google_maps_places_v1_AuthorAttribution_fieldAccessorTable =
Expand All @@ -65,12 +60,6 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
new java.lang.String[] {
"DisplayName", "Uri", "PhotoUri",
});
com.google.protobuf.ExtensionRegistry registry =
com.google.protobuf.ExtensionRegistry.newInstance();
registry.add(com.google.api.FieldBehaviorProto.fieldBehavior);
com.google.protobuf.Descriptors.FileDescriptor.internalUpdateFileDescriptor(
descriptor, registry);
com.google.api.FieldBehaviorProto.getDescriptor();
}

// @@protoc_insertion_point(outer_class_scope)
Expand Down
Loading
Loading