azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.eventgr...

180 строки
13 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry"
name: "MapsGeofenceGeometry"
nameWithType: "MapsGeofenceGeometry"
summary: "The geofence geometry."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **MapsGeofenceGeometry**"
constructors:
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.MapsGeofenceGeometry()"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.MapsGeofenceGeometry()"
name: "MapsGeofenceGeometry()"
nameWithType: "MapsGeofenceGeometry.MapsGeofenceGeometry()"
syntax: "public MapsGeofenceGeometry()"
methods:
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.deviceId()"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.deviceId()"
name: "deviceId()"
nameWithType: "MapsGeofenceGeometry.deviceId()"
summary: "Get iD of the device."
syntax: "public String deviceId()"
desc: "Get iD of the device."
returns:
description: "the deviceId value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.distance()"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.distance()"
name: "distance()"
nameWithType: "MapsGeofenceGeometry.distance()"
summary: "Get distance from the coordinate to the closest border of the geofence."
syntax: "public Double distance()"
desc: "Get distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence."
returns:
description: "the distance value"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.geometryId()"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.geometryId()"
name: "geometryId()"
nameWithType: "MapsGeofenceGeometry.geometryId()"
summary: "Get the unique ID for the geofence geometry."
syntax: "public String geometryId()"
desc: "Get the unique ID for the geofence geometry."
returns:
description: "the geometryId value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.nearestLat()"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.nearestLat()"
name: "nearestLat()"
nameWithType: "MapsGeofenceGeometry.nearestLat()"
summary: "Get latitude of the nearest point of the geometry."
syntax: "public Double nearestLat()"
desc: "Get latitude of the nearest point of the geometry."
returns:
description: "the nearestLat value"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.nearestLon()"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.nearestLon()"
name: "nearestLon()"
nameWithType: "MapsGeofenceGeometry.nearestLon()"
summary: "Get longitude of the nearest point of the geometry."
syntax: "public Double nearestLon()"
desc: "Get longitude of the nearest point of the geometry."
returns:
description: "the nearestLon value"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.udId()"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.udId()"
name: "udId()"
nameWithType: "MapsGeofenceGeometry.udId()"
summary: "Get the unique id returned from user upload service when uploading a geofence."
syntax: "public String udId()"
desc: "Get the unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API."
returns:
description: "the udId value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withDeviceId(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withDeviceId(String deviceId)"
name: "withDeviceId(String deviceId)"
nameWithType: "MapsGeofenceGeometry.withDeviceId(String deviceId)"
summary: "Set iD of the device."
parameters:
- description: "the deviceId value to set"
name: "deviceId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public MapsGeofenceGeometry withDeviceId(String deviceId)"
desc: "Set iD of the device."
returns:
description: "the MapsGeofenceGeometry object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry?alt=com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry&text=MapsGeofenceGeometry\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withDistance(java.lang.Double)"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withDistance(Double distance)"
name: "withDistance(Double distance)"
nameWithType: "MapsGeofenceGeometry.withDistance(Double distance)"
summary: "Set distance from the coordinate to the closest border of the geofence."
parameters:
- description: "the distance value to set"
name: "distance"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
syntax: "public MapsGeofenceGeometry withDistance(Double distance)"
desc: "Set distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence."
returns:
description: "the MapsGeofenceGeometry object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry?alt=com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry&text=MapsGeofenceGeometry\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withGeometryId(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withGeometryId(String geometryId)"
name: "withGeometryId(String geometryId)"
nameWithType: "MapsGeofenceGeometry.withGeometryId(String geometryId)"
summary: "Set the unique ID for the geofence geometry."
parameters:
- description: "the geometryId value to set"
name: "geometryId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public MapsGeofenceGeometry withGeometryId(String geometryId)"
desc: "Set the unique ID for the geofence geometry."
returns:
description: "the MapsGeofenceGeometry object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry?alt=com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry&text=MapsGeofenceGeometry\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withNearestLat(java.lang.Double)"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withNearestLat(Double nearestLat)"
name: "withNearestLat(Double nearestLat)"
nameWithType: "MapsGeofenceGeometry.withNearestLat(Double nearestLat)"
summary: "Set latitude of the nearest point of the geometry."
parameters:
- description: "the nearestLat value to set"
name: "nearestLat"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
syntax: "public MapsGeofenceGeometry withNearestLat(Double nearestLat)"
desc: "Set latitude of the nearest point of the geometry."
returns:
description: "the MapsGeofenceGeometry object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry?alt=com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry&text=MapsGeofenceGeometry\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withNearestLon(java.lang.Double)"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withNearestLon(Double nearestLon)"
name: "withNearestLon(Double nearestLon)"
nameWithType: "MapsGeofenceGeometry.withNearestLon(Double nearestLon)"
summary: "Set longitude of the nearest point of the geometry."
parameters:
- description: "the nearestLon value to set"
name: "nearestLon"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
syntax: "public MapsGeofenceGeometry withNearestLon(Double nearestLon)"
desc: "Set longitude of the nearest point of the geometry."
returns:
description: "the MapsGeofenceGeometry object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry?alt=com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry&text=MapsGeofenceGeometry\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withUdId(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry.withUdId(String udId)"
name: "withUdId(String udId)"
nameWithType: "MapsGeofenceGeometry.withUdId(String udId)"
summary: "Set the unique id returned from user upload service when uploading a geofence."
parameters:
- description: "the udId value to set"
name: "udId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public MapsGeofenceGeometry withUdId(String udId)"
desc: "Set the unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API."
returns:
description: "the MapsGeofenceGeometry object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry?alt=com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry&text=MapsGeofenceGeometry\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The geofence geometry."
metadata: {}
package: "com.microsoft.azure.eventgrid.models"
artifact: com.microsoft.azure:azure-eventgrid:1.3.0