Class: Google::Apis::VectortileV1::SemanticTileService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/vectortile_v1/service.rb

Overview

Semantic Tile API

Serves vector tiles containing geospatial data.

Examples:

require 'google/apis/vectortile_v1'

Vectortile = Google::Apis::VectortileV1 # Alias the module
service = Vectortile::SemanticTileService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SemanticTileService

Returns a new instance of SemanticTileService.

[View source]

45
46
47
48
49
50
 
# File 'lib/google/apis/vectortile_v1/service.rb', line 45

def initialize
  super('https://vectortile.googleapis.com/', '',
        client_name: 'google-apis-vectortile_v1',
        client_version: Google::Apis::VectortileV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


38
39
40
 
# File 'lib/google/apis/vectortile_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


43
44
45
 
# File 'lib/google/apis/vectortile_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#get_featuretile(name, always_include_building_footprints: nil, client_info_api_client: nil, client_info_application_id: nil, client_info_application_version: nil, client_info_device_model: nil, client_info_operating_system: nil, client_info_platform: nil, client_info_user_id: nil, client_tile_version_id: nil, enable_detailed_highway_types: nil, enable_feature_names: nil, enable_modeled_volumes: nil, enable_political_features: nil, enable_private_roads: nil, enable_unclipped_buildings: nil, language_code: nil, region_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VectortileV1::FeatureTile

Gets a feature tile by its tile resource name.

Parameters:

  • name (String) —

    Required. Resource name of the tile. The tile resource name is prefixed by its collection ID tiles/ followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as @,,z. For example, tiles/@1,2, 3z.

  • always_include_building_footprints (Boolean) (defaults to: nil) —

    Flag indicating whether the returned tile will always contain 2.5D footprints for structures. If enabled_modeled_volumes is set, this will mean that structures will have both their 3D models and 2.5D footprints returned.

  • client_info_api_client (String) (defaults to: nil) —

    API client name and version. For example, the SDK calling the API. The exact format is up to the client.

  • client_info_application_id (String) (defaults to: nil) —

    Application ID, such as the package name on Android and the bundle identifier on iOS platforms.

  • client_info_application_version (String) (defaults to: nil) —

    Application version number, such as "1.2.3". The exact format is application- dependent.

  • client_info_device_model (String) (defaults to: nil) —

    Device model as reported by the device. The exact format is platform-dependent.

  • client_info_operating_system (String) (defaults to: nil) —

    Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent.

  • client_info_platform (String) (defaults to: nil) —

    Platform where the application is running.

  • client_info_user_id (String) (defaults to: nil) —

    Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest. client_info).

  • client_tile_version_id (String) (defaults to: nil) —

    Optional version id identifying the tile that is already in the client's cache. This field should be populated with the most recent version_id value returned by the API for the requested tile. If the version id is empty the server always returns a newly rendered tile. If it is provided the server checks if the tile contents would be identical to one that's already on the client, and if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED instead.

  • enable_detailed_highway_types (Boolean) (defaults to: nil) —

    Flag indicating whether detailed highway types should be returned. If this is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways will have the generic HIGHWAY type. This exists for backwards compatibility reasons.

  • enable_feature_names (Boolean) (defaults to: nil) —

    Flag indicating whether human-readable names should be returned for features. If this is set, the display_name field on the feature will be filled out.

  • enable_modeled_volumes (Boolean) (defaults to: nil) —

    Flag indicating whether 3D building models should be enabled. If this is set structures will be returned as 3D modeled volumes rather than 2.5D extruded areas where possible.

  • enable_political_features (Boolean) (defaults to: nil) —

    Flag indicating whether political features should be returned.

  • enable_private_roads (Boolean) (defaults to: nil) —

    Flag indicating whether the returned tile will contain road features that are marked private. Private roads are indicated by the Feature.segment_info. road_info.is_private field.

  • enable_unclipped_buildings (Boolean) (defaults to: nil) —

    Flag indicating whether unclipped buildings should be returned. If this is set, building render ops will extend beyond the tile boundary. Buildings will only be returned on the tile that contains their centroid.

  • language_code (String) (defaults to: nil) —

    Required. The BCP-47 language code corresponding to the language in which the name was requested, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

  • region_code (String) (defaults to: nil) —

    Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as "US" and "419". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required

[View source]

139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/google/apis/vectortile_v1/service.rb', line 139

def get_featuretile(name, always_include_building_footprints: nil, client_info_api_client: nil, client_info_application_id: nil, client_info_application_version: nil, client_info_device_model: nil, client_info_operating_system: nil, client_info_platform: nil, client_info_user_id: nil, client_tile_version_id: nil, enable_detailed_highway_types: nil, enable_feature_names: nil, enable_modeled_volumes: nil, enable_political_features: nil, enable_private_roads: nil, enable_unclipped_buildings: nil, language_code: nil, region_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::VectortileV1::FeatureTile::Representation
  command.response_class = Google::Apis::VectortileV1::FeatureTile
  command.params['name'] = name unless name.nil?
  command.query['alwaysIncludeBuildingFootprints'] = always_include_building_footprints unless always_include_building_footprints.nil?
  command.query['clientInfo.apiClient'] = client_info_api_client unless client_info_api_client.nil?
  command.query['clientInfo.applicationId'] = client_info_application_id unless client_info_application_id.nil?
  command.query['clientInfo.applicationVersion'] = client_info_application_version unless client_info_application_version.nil?
  command.query['clientInfo.deviceModel'] = client_info_device_model unless client_info_device_model.nil?
  command.query['clientInfo.operatingSystem'] = client_info_operating_system unless client_info_operating_system.nil?
  command.query['clientInfo.platform'] = client_info_platform unless client_info_platform.nil?
  command.query['clientInfo.userId'] = client_info_user_id unless client_info_user_id.nil?
  command.query['clientTileVersionId'] = client_tile_version_id unless client_tile_version_id.nil?
  command.query['enableDetailedHighwayTypes'] = enable_detailed_highway_types unless enable_detailed_highway_types.nil?
  command.query['enableFeatureNames'] = enable_feature_names unless enable_feature_names.nil?
  command.query['enableModeledVolumes'] = enable_modeled_volumes unless enable_modeled_volumes.nil?
  command.query['enablePoliticalFeatures'] = enable_political_features unless enable_political_features.nil?
  command.query['enablePrivateRoads'] = enable_private_roads unless enable_private_roads.nil?
  command.query['enableUnclippedBuildings'] = enable_unclipped_buildings unless enable_unclipped_buildings.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['regionCode'] = region_code unless region_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_terraintile(name, altitude_precision_centimeters: nil, client_info_api_client: nil, client_info_application_id: nil, client_info_application_version: nil, client_info_device_model: nil, client_info_operating_system: nil, client_info_platform: nil, client_info_user_id: nil, max_elevation_resolution_cells: nil, min_elevation_resolution_cells: nil, terrain_formats: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VectortileV1::TerrainTile

Gets a terrain tile by its tile resource name.

Parameters:

  • name (String) —

    Required. Resource name of the tile. The tile resource name is prefixed by its collection ID terraintiles/ followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as @,,z. For example, terraintiles/@1,2,3z.

  • altitude_precision_centimeters (Fixnum) (defaults to: nil) —

    The precision of terrain altitudes in centimeters. Possible values: between 1 ( cm level precision) and 1,000,000 (10-kilometer level precision).

  • client_info_api_client (String) (defaults to: nil) —

    API client name and version. For example, the SDK calling the API. The exact format is up to the client.

  • client_info_application_id (String) (defaults to: nil) —

    Application ID, such as the package name on Android and the bundle identifier on iOS platforms.

  • client_info_application_version (String) (defaults to: nil) —

    Application version number, such as "1.2.3". The exact format is application- dependent.

  • client_info_device_model (String) (defaults to: nil) —

    Device model as reported by the device. The exact format is platform-dependent.

  • client_info_operating_system (String) (defaults to: nil) —

    Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent.

  • client_info_platform (String) (defaults to: nil) —

    Platform where the application is running.

  • client_info_user_id (String) (defaults to: nil) —

    Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest. client_info).

  • max_elevation_resolution_cells (Fixnum) (defaults to: nil) —

    The maximum allowed resolution for the returned elevation heightmap. Possible values: between 1 and 1024 (and not less than min_elevation_resolution_cells). Over-sized heightmaps will be non-uniformly down-sampled such that each edge is no longer than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 100px (width) * 30px ( height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px ( height)

  • min_elevation_resolution_cells (Fixnum) (defaults to: nil) —

    The minimum allowed resolution for the returned elevation heightmap. Possible values: between 0 and 1024 (and not more than max_elevation_resolution_cells). Zero is supported for backward compatibility. Under-sized heightmaps will be non-uniformly up-sampled such that each edge is no shorter than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 30px (width) * 10px (height) min_elevation_resolution: 30 New resolution: 30px (width) * 30px (height)

  • terrain_formats (Array<String>, String) (defaults to: nil) —

    Terrain formats that the client understands.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required

[View source]

232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/google/apis/vectortile_v1/service.rb', line 232

def get_terraintile(name, altitude_precision_centimeters: nil, client_info_api_client: nil, client_info_application_id: nil, client_info_application_version: nil, client_info_device_model: nil, client_info_operating_system: nil, client_info_platform: nil, client_info_user_id: nil, max_elevation_resolution_cells: nil, min_elevation_resolution_cells: nil, terrain_formats: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::VectortileV1::TerrainTile::Representation
  command.response_class = Google::Apis::VectortileV1::TerrainTile
  command.params['name'] = name unless name.nil?
  command.query['altitudePrecisionCentimeters'] = altitude_precision_centimeters unless altitude_precision_centimeters.nil?
  command.query['clientInfo.apiClient'] = client_info_api_client unless client_info_api_client.nil?
  command.query['clientInfo.applicationId'] = client_info_application_id unless client_info_application_id.nil?
  command.query['clientInfo.applicationVersion'] = client_info_application_version unless client_info_application_version.nil?
  command.query['clientInfo.deviceModel'] = client_info_device_model unless client_info_device_model.nil?
  command.query['clientInfo.operatingSystem'] = client_info_operating_system unless client_info_operating_system.nil?
  command.query['clientInfo.platform'] = client_info_platform unless client_info_platform.nil?
  command.query['clientInfo.userId'] = client_info_user_id unless client_info_user_id.nil?
  command.query['maxElevationResolutionCells'] = max_elevation_resolution_cells unless max_elevation_resolution_cells.nil?
  command.query['minElevationResolutionCells'] = min_elevation_resolution_cells unless min_elevation_resolution_cells.nil?
  command.query['terrainFormats'] = terrain_formats unless terrain_formats.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end