id
int32 0
252k
| repo
stringlengths 7
55
| path
stringlengths 4
127
| func_name
stringlengths 1
88
| original_string
stringlengths 75
19.8k
| language
stringclasses 1
value | code
stringlengths 75
19.8k
| code_tokens
list | docstring
stringlengths 3
17.3k
| docstring_tokens
list | sha
stringlengths 40
40
| url
stringlengths 87
242
|
|---|---|---|---|---|---|---|---|---|---|---|---|
12,900
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Federation.validateAllServers
|
def validateAllServers(self):
"""
This operation provides status information about a specific ArcGIS
Server federated with Portal for ArcGIS.
Parameters:
serverId - unique id of the server
"""
url = self._url + "/servers/validate"
params = {"f" : "json"}
return self._get(url=url,
param_dict=params,
proxy_port=self._proxy_port,
proxy_url=self._proxy_ur)
|
python
|
def validateAllServers(self):
"""
This operation provides status information about a specific ArcGIS
Server federated with Portal for ArcGIS.
Parameters:
serverId - unique id of the server
"""
url = self._url + "/servers/validate"
params = {"f" : "json"}
return self._get(url=url,
param_dict=params,
proxy_port=self._proxy_port,
proxy_url=self._proxy_ur)
|
[
"def",
"validateAllServers",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/servers/validate\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_ur",
")"
] |
This operation provides status information about a specific ArcGIS
Server federated with Portal for ArcGIS.
Parameters:
serverId - unique id of the server
|
[
"This",
"operation",
"provides",
"status",
"information",
"about",
"a",
"specific",
"ArcGIS",
"Server",
"federated",
"with",
"Portal",
"for",
"ArcGIS",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L120-L133
|
12,901
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_log.editLogSettings
|
def editLogSettings(self, logLocation, logLevel="WARNING", maxLogFileAge=90):
"""
edits the log settings for the portal site
Inputs:
logLocation - file path to where you want the log files saved
on disk
logLevel - this is the level of detail saved in the log files
Levels are: OFF, SEVERE, WARNING, INFO, FINE, VERBOSE, and
DEBUG
maxLogFileAge - the numbers of days to keep a single log file
"""
url = self._url + "/settings/edit"
params = {
"f" : "json",
"logDir" : logLocation,
"logLevel" : logLevel,
"maxLogFileAge" : maxLogFileAge
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def editLogSettings(self, logLocation, logLevel="WARNING", maxLogFileAge=90):
"""
edits the log settings for the portal site
Inputs:
logLocation - file path to where you want the log files saved
on disk
logLevel - this is the level of detail saved in the log files
Levels are: OFF, SEVERE, WARNING, INFO, FINE, VERBOSE, and
DEBUG
maxLogFileAge - the numbers of days to keep a single log file
"""
url = self._url + "/settings/edit"
params = {
"f" : "json",
"logDir" : logLocation,
"logLevel" : logLevel,
"maxLogFileAge" : maxLogFileAge
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"editLogSettings",
"(",
"self",
",",
"logLocation",
",",
"logLevel",
"=",
"\"WARNING\"",
",",
"maxLogFileAge",
"=",
"90",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/settings/edit\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"logDir\"",
":",
"logLocation",
",",
"\"logLevel\"",
":",
"logLevel",
",",
"\"maxLogFileAge\"",
":",
"maxLogFileAge",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
edits the log settings for the portal site
Inputs:
logLocation - file path to where you want the log files saved
on disk
logLevel - this is the level of detail saved in the log files
Levels are: OFF, SEVERE, WARNING, INFO, FINE, VERBOSE, and
DEBUG
maxLogFileAge - the numbers of days to keep a single log file
|
[
"edits",
"the",
"log",
"settings",
"for",
"the",
"portal",
"site"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L214-L237
|
12,902
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_log.query
|
def query(self, logLevel="WARNING", source="ALL",
startTime=None, endTime=None,
logCodes=None, users=None, messageCount=1000):
"""
allows users to look at the log files from a the REST endpoint
Inputs:
logLevel - this is the level of detail saved in the log files
Levels are: OFF, SEVERE, WARNING, INFO, FINE, VERBOSE, and
DEBUG
source - the type of information to search. Allowed values
are: ALL, PORTAL_ADMIN, SHARING, PORTAL
startTime - datetime object to start search at
endTime - datetime object to end search
logCodes - comma seperate list of codes to search
users - comma seperated list of users to query
messageCount - integer number of the max number of log
entries to return to the user.
"""
url = self._url + "/query"
filter_value = {"codes":[], "users":[], "source": "*"}
if source.lower() == "all":
filter_value['source'] = "*"
else:
filter_value['source'] = [source]
params = {
"f" : "json",
"level" : logLevel
}
if not startTime is None and \
isinstance(startTime, datetime):
params['startTime'] = startTime.strftime("%Y-%m-%dT%H:%M:%S")#2015-01-31T15:00:00
if not endTime is None and \
isinstance(endTime, datetime):
params['endTime'] = startTime.strftime("%Y-%m-%dT%H:%M:%S")
if not logCodes is None:
filter_value['codes'] = logCodes.split(',')
if not users is None:
filter_value['users'] = users.split(',')
if messageCount is None:
params['pageSize'] = 1000
elif isinstance(messageCount, (int, long, float)):
params['pageSize'] = int(messageCount)
else:
params['pageSize'] = 1000
params['filter'] = filter_value
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def query(self, logLevel="WARNING", source="ALL",
startTime=None, endTime=None,
logCodes=None, users=None, messageCount=1000):
"""
allows users to look at the log files from a the REST endpoint
Inputs:
logLevel - this is the level of detail saved in the log files
Levels are: OFF, SEVERE, WARNING, INFO, FINE, VERBOSE, and
DEBUG
source - the type of information to search. Allowed values
are: ALL, PORTAL_ADMIN, SHARING, PORTAL
startTime - datetime object to start search at
endTime - datetime object to end search
logCodes - comma seperate list of codes to search
users - comma seperated list of users to query
messageCount - integer number of the max number of log
entries to return to the user.
"""
url = self._url + "/query"
filter_value = {"codes":[], "users":[], "source": "*"}
if source.lower() == "all":
filter_value['source'] = "*"
else:
filter_value['source'] = [source]
params = {
"f" : "json",
"level" : logLevel
}
if not startTime is None and \
isinstance(startTime, datetime):
params['startTime'] = startTime.strftime("%Y-%m-%dT%H:%M:%S")#2015-01-31T15:00:00
if not endTime is None and \
isinstance(endTime, datetime):
params['endTime'] = startTime.strftime("%Y-%m-%dT%H:%M:%S")
if not logCodes is None:
filter_value['codes'] = logCodes.split(',')
if not users is None:
filter_value['users'] = users.split(',')
if messageCount is None:
params['pageSize'] = 1000
elif isinstance(messageCount, (int, long, float)):
params['pageSize'] = int(messageCount)
else:
params['pageSize'] = 1000
params['filter'] = filter_value
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"query",
"(",
"self",
",",
"logLevel",
"=",
"\"WARNING\"",
",",
"source",
"=",
"\"ALL\"",
",",
"startTime",
"=",
"None",
",",
"endTime",
"=",
"None",
",",
"logCodes",
"=",
"None",
",",
"users",
"=",
"None",
",",
"messageCount",
"=",
"1000",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/query\"",
"filter_value",
"=",
"{",
"\"codes\"",
":",
"[",
"]",
",",
"\"users\"",
":",
"[",
"]",
",",
"\"source\"",
":",
"\"*\"",
"}",
"if",
"source",
".",
"lower",
"(",
")",
"==",
"\"all\"",
":",
"filter_value",
"[",
"'source'",
"]",
"=",
"\"*\"",
"else",
":",
"filter_value",
"[",
"'source'",
"]",
"=",
"[",
"source",
"]",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"level\"",
":",
"logLevel",
"}",
"if",
"not",
"startTime",
"is",
"None",
"and",
"isinstance",
"(",
"startTime",
",",
"datetime",
")",
":",
"params",
"[",
"'startTime'",
"]",
"=",
"startTime",
".",
"strftime",
"(",
"\"%Y-%m-%dT%H:%M:%S\"",
")",
"#2015-01-31T15:00:00",
"if",
"not",
"endTime",
"is",
"None",
"and",
"isinstance",
"(",
"endTime",
",",
"datetime",
")",
":",
"params",
"[",
"'endTime'",
"]",
"=",
"startTime",
".",
"strftime",
"(",
"\"%Y-%m-%dT%H:%M:%S\"",
")",
"if",
"not",
"logCodes",
"is",
"None",
":",
"filter_value",
"[",
"'codes'",
"]",
"=",
"logCodes",
".",
"split",
"(",
"','",
")",
"if",
"not",
"users",
"is",
"None",
":",
"filter_value",
"[",
"'users'",
"]",
"=",
"users",
".",
"split",
"(",
"','",
")",
"if",
"messageCount",
"is",
"None",
":",
"params",
"[",
"'pageSize'",
"]",
"=",
"1000",
"elif",
"isinstance",
"(",
"messageCount",
",",
"(",
"int",
",",
"long",
",",
"float",
")",
")",
":",
"params",
"[",
"'pageSize'",
"]",
"=",
"int",
"(",
"messageCount",
")",
"else",
":",
"params",
"[",
"'pageSize'",
"]",
"=",
"1000",
"params",
"[",
"'filter'",
"]",
"=",
"filter_value",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
allows users to look at the log files from a the REST endpoint
Inputs:
logLevel - this is the level of detail saved in the log files
Levels are: OFF, SEVERE, WARNING, INFO, FINE, VERBOSE, and
DEBUG
source - the type of information to search. Allowed values
are: ALL, PORTAL_ADMIN, SHARING, PORTAL
startTime - datetime object to start search at
endTime - datetime object to end search
logCodes - comma seperate list of codes to search
users - comma seperated list of users to query
messageCount - integer number of the max number of log
entries to return to the user.
|
[
"allows",
"users",
"to",
"look",
"at",
"the",
"log",
"files",
"from",
"a",
"the",
"REST",
"endpoint"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L239-L290
|
12,903
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.deleteCertificate
|
def deleteCertificate(self, certName):
"""
This operation deletes an SSL certificate from the key store. Once
a certificate is deleted, it cannot be retrieved or used to enable
SSL.
Inputs:
certName - name of the cert to delete
"""
params = {"f" : "json"}
url = self._url + "/sslCertificates/{cert}/delete".format(
cert=certName)
return self._post(url=url, param_dict=params,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def deleteCertificate(self, certName):
"""
This operation deletes an SSL certificate from the key store. Once
a certificate is deleted, it cannot be retrieved or used to enable
SSL.
Inputs:
certName - name of the cert to delete
"""
params = {"f" : "json"}
url = self._url + "/sslCertificates/{cert}/delete".format(
cert=certName)
return self._post(url=url, param_dict=params,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"deleteCertificate",
"(",
"self",
",",
"certName",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/sslCertificates/{cert}/delete\"",
".",
"format",
"(",
"cert",
"=",
"certName",
")",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
This operation deletes an SSL certificate from the key store. Once
a certificate is deleted, it cannot be retrieved or used to enable
SSL.
Inputs:
certName - name of the cert to delete
|
[
"This",
"operation",
"deletes",
"an",
"SSL",
"certificate",
"from",
"the",
"key",
"store",
".",
"Once",
"a",
"certificate",
"is",
"deleted",
"it",
"cannot",
"be",
"retrieved",
"or",
"used",
"to",
"enable",
"SSL",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L421-L437
|
12,904
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.exportCertificate
|
def exportCertificate(self, certName, outFolder=None):
"""
This operation downloads an SSL certificate. The file returned by
the server is an X.509 certificate. The downloaded certificate can
be imported into a client that is making HTTP requests.
Inputs:
certName - name of the cert to export
outFolder - folder on disk to save the certificate.
"""
params = {"f" : "json"}
url = self._url + "/sslCertificates/{cert}/export".format(
cert=certName)
if outFolder is None:
outFolder = tempfile.gettempdir()
return self._post(url=url, param_dict=params,
out_folder=outFolder,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def exportCertificate(self, certName, outFolder=None):
"""
This operation downloads an SSL certificate. The file returned by
the server is an X.509 certificate. The downloaded certificate can
be imported into a client that is making HTTP requests.
Inputs:
certName - name of the cert to export
outFolder - folder on disk to save the certificate.
"""
params = {"f" : "json"}
url = self._url + "/sslCertificates/{cert}/export".format(
cert=certName)
if outFolder is None:
outFolder = tempfile.gettempdir()
return self._post(url=url, param_dict=params,
out_folder=outFolder,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"exportCertificate",
"(",
"self",
",",
"certName",
",",
"outFolder",
"=",
"None",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/sslCertificates/{cert}/export\"",
".",
"format",
"(",
"cert",
"=",
"certName",
")",
"if",
"outFolder",
"is",
"None",
":",
"outFolder",
"=",
"tempfile",
".",
"gettempdir",
"(",
")",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"out_folder",
"=",
"outFolder",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
This operation downloads an SSL certificate. The file returned by
the server is an X.509 certificate. The downloaded certificate can
be imported into a client that is making HTTP requests.
Inputs:
certName - name of the cert to export
outFolder - folder on disk to save the certificate.
|
[
"This",
"operation",
"downloads",
"an",
"SSL",
"certificate",
".",
"The",
"file",
"returned",
"by",
"the",
"server",
"is",
"an",
"X",
".",
"509",
"certificate",
".",
"The",
"downloaded",
"certificate",
"can",
"be",
"imported",
"into",
"a",
"client",
"that",
"is",
"making",
"HTTP",
"requests",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L439-L457
|
12,905
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.generateCertificate
|
def generateCertificate(self, alias,
commonName, organizationalUnit,
city, state, country,
keyalg="RSA", keysize=1024,
sigalg="SHA256withRSA",
validity=90
):
"""
Use this operation to create a self-signed certificate or as a
starting point for getting a production-ready CA-signed
certificate. The portal will generate a certificate for you and
store it in its keystore.
"""
params = {"f" : "json",
"alias" : alias,
"commonName" : commonName,
"organizationalUnit" : organizationalUnit,
"city" : city,
"state" : state,
"country" : country,
"keyalg" : keyalg,
"keysize" : keysize,
"sigalg" : sigalg,
"validity" : validity
}
url = self._url + "/SSLCertificate/ generateCertificate"
return self._post(url=url,
param_dict=params,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def generateCertificate(self, alias,
commonName, organizationalUnit,
city, state, country,
keyalg="RSA", keysize=1024,
sigalg="SHA256withRSA",
validity=90
):
"""
Use this operation to create a self-signed certificate or as a
starting point for getting a production-ready CA-signed
certificate. The portal will generate a certificate for you and
store it in its keystore.
"""
params = {"f" : "json",
"alias" : alias,
"commonName" : commonName,
"organizationalUnit" : organizationalUnit,
"city" : city,
"state" : state,
"country" : country,
"keyalg" : keyalg,
"keysize" : keysize,
"sigalg" : sigalg,
"validity" : validity
}
url = self._url + "/SSLCertificate/ generateCertificate"
return self._post(url=url,
param_dict=params,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"generateCertificate",
"(",
"self",
",",
"alias",
",",
"commonName",
",",
"organizationalUnit",
",",
"city",
",",
"state",
",",
"country",
",",
"keyalg",
"=",
"\"RSA\"",
",",
"keysize",
"=",
"1024",
",",
"sigalg",
"=",
"\"SHA256withRSA\"",
",",
"validity",
"=",
"90",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"alias\"",
":",
"alias",
",",
"\"commonName\"",
":",
"commonName",
",",
"\"organizationalUnit\"",
":",
"organizationalUnit",
",",
"\"city\"",
":",
"city",
",",
"\"state\"",
":",
"state",
",",
"\"country\"",
":",
"country",
",",
"\"keyalg\"",
":",
"keyalg",
",",
"\"keysize\"",
":",
"keysize",
",",
"\"sigalg\"",
":",
"sigalg",
",",
"\"validity\"",
":",
"validity",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/SSLCertificate/ generateCertificate\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
Use this operation to create a self-signed certificate or as a
starting point for getting a production-ready CA-signed
certificate. The portal will generate a certificate for you and
store it in its keystore.
|
[
"Use",
"this",
"operation",
"to",
"create",
"a",
"self",
"-",
"signed",
"certificate",
"or",
"as",
"a",
"starting",
"point",
"for",
"getting",
"a",
"production",
"-",
"ready",
"CA",
"-",
"signed",
"certificate",
".",
"The",
"portal",
"will",
"generate",
"a",
"certificate",
"for",
"you",
"and",
"store",
"it",
"in",
"its",
"keystore",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L459-L488
|
12,906
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.getAppInfo
|
def getAppInfo(self, appId):
"""
Every application registered with Portal for ArcGIS has a unique
client ID and a list of redirect URIs that are used for OAuth. This
operation returns these OAuth-specific properties of an application.
You can use this information to update the redirect URIs by using
the Update App Info operation.
Input:
appId - unique id of the application to get the information
about.
"""
params = {
"f" : "json",
"appID" : appId
}
url = self._url + "/oauth/getAppInfo"
return self._get(url=url, param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def getAppInfo(self, appId):
"""
Every application registered with Portal for ArcGIS has a unique
client ID and a list of redirect URIs that are used for OAuth. This
operation returns these OAuth-specific properties of an application.
You can use this information to update the redirect URIs by using
the Update App Info operation.
Input:
appId - unique id of the application to get the information
about.
"""
params = {
"f" : "json",
"appID" : appId
}
url = self._url + "/oauth/getAppInfo"
return self._get(url=url, param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"getAppInfo",
"(",
"self",
",",
"appId",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"appID\"",
":",
"appId",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/oauth/getAppInfo\"",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
Every application registered with Portal for ArcGIS has a unique
client ID and a list of redirect URIs that are used for OAuth. This
operation returns these OAuth-specific properties of an application.
You can use this information to update the redirect URIs by using
the Update App Info operation.
Input:
appId - unique id of the application to get the information
about.
|
[
"Every",
"application",
"registered",
"with",
"Portal",
"for",
"ArcGIS",
"has",
"a",
"unique",
"client",
"ID",
"and",
"a",
"list",
"of",
"redirect",
"URIs",
"that",
"are",
"used",
"for",
"OAuth",
".",
"This",
"operation",
"returns",
"these",
"OAuth",
"-",
"specific",
"properties",
"of",
"an",
"application",
".",
"You",
"can",
"use",
"this",
"information",
"to",
"update",
"the",
"redirect",
"URIs",
"by",
"using",
"the",
"Update",
"App",
"Info",
"operation",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L499-L518
|
12,907
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.getUsersEnterpriseGroups
|
def getUsersEnterpriseGroups(self, username, searchFilter, maxCount=100):
"""
This operation lists the groups assigned to a user account in the
configured enterprise group store. You can use the filter parameter
to narrow down the search results.
Inputs:
username - name of the user to find
searchFilter - helps narrow down results
maxCount - maximum number of results to return
"""
params = {
"f" : "json",
"username" : username,
"filter" : searchFilter,
"maxCount" : maxCount
}
url = self._url + "/Groups/getEnterpriseGroupsForUser"
return self._get(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def getUsersEnterpriseGroups(self, username, searchFilter, maxCount=100):
"""
This operation lists the groups assigned to a user account in the
configured enterprise group store. You can use the filter parameter
to narrow down the search results.
Inputs:
username - name of the user to find
searchFilter - helps narrow down results
maxCount - maximum number of results to return
"""
params = {
"f" : "json",
"username" : username,
"filter" : searchFilter,
"maxCount" : maxCount
}
url = self._url + "/Groups/getEnterpriseGroupsForUser"
return self._get(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"getUsersEnterpriseGroups",
"(",
"self",
",",
"username",
",",
"searchFilter",
",",
"maxCount",
"=",
"100",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"username\"",
":",
"username",
",",
"\"filter\"",
":",
"searchFilter",
",",
"\"maxCount\"",
":",
"maxCount",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/Groups/getEnterpriseGroupsForUser\"",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
This operation lists the groups assigned to a user account in the
configured enterprise group store. You can use the filter parameter
to narrow down the search results.
Inputs:
username - name of the user to find
searchFilter - helps narrow down results
maxCount - maximum number of results to return
|
[
"This",
"operation",
"lists",
"the",
"groups",
"assigned",
"to",
"a",
"user",
"account",
"in",
"the",
"configured",
"enterprise",
"group",
"store",
".",
"You",
"can",
"use",
"the",
"filter",
"parameter",
"to",
"narrow",
"down",
"the",
"search",
"results",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L520-L541
|
12,908
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.refreshGroupMembership
|
def refreshGroupMembership(self, groups):
"""
This operation iterates over every enterprise account configured in
the portal and determines if the user account is a part of the
input enterprise group. If there are any change in memberships, the
database and the indexes are updated for each group.
While portal automatically refreshes the memberships during a user
login and during a periodic refresh configured through the Update
Identity Store operation, this operation allows an administrator to
force a refresh.
Parameters:
groups - comma seperated list of group names
"""
params = {
"f" : "json",
"groups" : groups
}
url = self._url + "/groups/refreshMembership"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def refreshGroupMembership(self, groups):
"""
This operation iterates over every enterprise account configured in
the portal and determines if the user account is a part of the
input enterprise group. If there are any change in memberships, the
database and the indexes are updated for each group.
While portal automatically refreshes the memberships during a user
login and during a periodic refresh configured through the Update
Identity Store operation, this operation allows an administrator to
force a refresh.
Parameters:
groups - comma seperated list of group names
"""
params = {
"f" : "json",
"groups" : groups
}
url = self._url + "/groups/refreshMembership"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"refreshGroupMembership",
"(",
"self",
",",
"groups",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"groups\"",
":",
"groups",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/groups/refreshMembership\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
This operation iterates over every enterprise account configured in
the portal and determines if the user account is a part of the
input enterprise group. If there are any change in memberships, the
database and the indexes are updated for each group.
While portal automatically refreshes the memberships during a user
login and during a periodic refresh configured through the Update
Identity Store operation, this operation allows an administrator to
force a refresh.
Parameters:
groups - comma seperated list of group names
|
[
"This",
"operation",
"iterates",
"over",
"every",
"enterprise",
"account",
"configured",
"in",
"the",
"portal",
"and",
"determines",
"if",
"the",
"user",
"account",
"is",
"a",
"part",
"of",
"the",
"input",
"enterprise",
"group",
".",
"If",
"there",
"are",
"any",
"change",
"in",
"memberships",
"the",
"database",
"and",
"the",
"indexes",
"are",
"updated",
"for",
"each",
"group",
".",
"While",
"portal",
"automatically",
"refreshes",
"the",
"memberships",
"during",
"a",
"user",
"login",
"and",
"during",
"a",
"periodic",
"refresh",
"configured",
"through",
"the",
"Update",
"Identity",
"Store",
"operation",
"this",
"operation",
"allows",
"an",
"administrator",
"to",
"force",
"a",
"refresh",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L654-L676
|
12,909
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.searchEnterpriseGroups
|
def searchEnterpriseGroups(self, searchFilter="", maxCount=100):
"""
This operation searches groups in the configured enterprise group
store. You can narrow down the search using the search filter
parameter.
Parameters:
searchFilter - text value to narrow the search down
maxCount - maximum number of records to return
"""
params = {
"f" : "json",
"filter" : searchFilter,
"maxCount" : maxCount
}
url = self._url + "/groups/searchEnterpriseGroups"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def searchEnterpriseGroups(self, searchFilter="", maxCount=100):
"""
This operation searches groups in the configured enterprise group
store. You can narrow down the search using the search filter
parameter.
Parameters:
searchFilter - text value to narrow the search down
maxCount - maximum number of records to return
"""
params = {
"f" : "json",
"filter" : searchFilter,
"maxCount" : maxCount
}
url = self._url + "/groups/searchEnterpriseGroups"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"searchEnterpriseGroups",
"(",
"self",
",",
"searchFilter",
"=",
"\"\"",
",",
"maxCount",
"=",
"100",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"filter\"",
":",
"searchFilter",
",",
"\"maxCount\"",
":",
"maxCount",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/groups/searchEnterpriseGroups\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
This operation searches groups in the configured enterprise group
store. You can narrow down the search using the search filter
parameter.
Parameters:
searchFilter - text value to narrow the search down
maxCount - maximum number of records to return
|
[
"This",
"operation",
"searches",
"groups",
"in",
"the",
"configured",
"enterprise",
"group",
"store",
".",
"You",
"can",
"narrow",
"down",
"the",
"search",
"using",
"the",
"search",
"filter",
"parameter",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L702-L721
|
12,910
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.SSLCertificates
|
def SSLCertificates(self):
"""
Lists certificates.
"""
url = self._url + "/SSLCertificate"
params = {"f" : "json"}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def SSLCertificates(self):
"""
Lists certificates.
"""
url = self._url + "/SSLCertificate"
params = {"f" : "json"}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"SSLCertificates",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/SSLCertificate\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
Lists certificates.
|
[
"Lists",
"certificates",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L745-L754
|
12,911
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.updateAppInfo
|
def updateAppInfo(self, appInfo):
"""
This operation allows you to update the OAuth-specific properties
associated with an application. Use the Get App Info operation to
obtain the existing OAuth properties that can be edited.
"""
params = {"f" : "json",
"appInfo" : appInfo}
url = self._url + "/oauth/updateAppInfo"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def updateAppInfo(self, appInfo):
"""
This operation allows you to update the OAuth-specific properties
associated with an application. Use the Get App Info operation to
obtain the existing OAuth properties that can be edited.
"""
params = {"f" : "json",
"appInfo" : appInfo}
url = self._url + "/oauth/updateAppInfo"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"updateAppInfo",
"(",
"self",
",",
"appInfo",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"appInfo\"",
":",
"appInfo",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/oauth/updateAppInfo\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
This operation allows you to update the OAuth-specific properties
associated with an application. Use the Get App Info operation to
obtain the existing OAuth properties that can be edited.
|
[
"This",
"operation",
"allows",
"you",
"to",
"update",
"the",
"OAuth",
"-",
"specific",
"properties",
"associated",
"with",
"an",
"application",
".",
"Use",
"the",
"Get",
"App",
"Info",
"operation",
"to",
"obtain",
"the",
"existing",
"OAuth",
"properties",
"that",
"can",
"be",
"edited",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L796-L808
|
12,912
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.updateEnterpriseUser
|
def updateEnterpriseUser(self, username, idpUsername):
"""
This operation allows an administrator to update the idpUsername
for an enterprise user in the portal. This is used when migrating
from accounts used with web-tier authentication to SAML
authentication.
Parameters:
username - username of the enterprise account
idpUsername - username used by the SAML identity provider
"""
params = {
"f" : "json",
"username" : username,
"idpUsername" : idpUsername
}
url = self._url + "/users/updateEnterpriseUser"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def updateEnterpriseUser(self, username, idpUsername):
"""
This operation allows an administrator to update the idpUsername
for an enterprise user in the portal. This is used when migrating
from accounts used with web-tier authentication to SAML
authentication.
Parameters:
username - username of the enterprise account
idpUsername - username used by the SAML identity provider
"""
params = {
"f" : "json",
"username" : username,
"idpUsername" : idpUsername
}
url = self._url + "/users/updateEnterpriseUser"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"updateEnterpriseUser",
"(",
"self",
",",
"username",
",",
"idpUsername",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"username\"",
":",
"username",
",",
"\"idpUsername\"",
":",
"idpUsername",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/users/updateEnterpriseUser\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
This operation allows an administrator to update the idpUsername
for an enterprise user in the portal. This is used when migrating
from accounts used with web-tier authentication to SAML
authentication.
Parameters:
username - username of the enterprise account
idpUsername - username used by the SAML identity provider
|
[
"This",
"operation",
"allows",
"an",
"administrator",
"to",
"update",
"the",
"idpUsername",
"for",
"an",
"enterprise",
"user",
"in",
"the",
"portal",
".",
"This",
"is",
"used",
"when",
"migrating",
"from",
"accounts",
"used",
"with",
"web",
"-",
"tier",
"authentication",
"to",
"SAML",
"authentication",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L810-L830
|
12,913
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_Security.updateIdenityStore
|
def updateIdenityStore(self,
userPassword,
user,
userFullnameAttribute,
ldapURLForUsers,
userEmailAttribute,
usernameAttribute,
isPasswordEncrypted=False,
caseSensitive=True):
r"""
You can use this operation to change the identity provider
configuration in your portal. When Portal for ArcGIS is first
installed, it supports token-based authentication using the
built-in identity store for accounts. To configure your portal to
connect to your enterprise authentication mechanism, it must be
configured to use an enterprise identity store such as Windows
Active Directory or LDAP.
Inputs:
userPassword -The password for the domain account, for example,
secret.
isPasswordEncrypted - Indicates if the userPassword property is
an encrypted password or plain text. If
the property is false, the API will
encrypt the password automatically.
user - A user account with at least read permissions to look up
the email addresses and user names of users in your
organization. If possible, use an account whose password
does not expire.
Windows Active Directory example: mydomain\\winaccount
LDAP example: uid=admin\,ou=system
userFullnameAttribute - The attribute in Windows Active
Directory or LDAP that contains the full
name of the users, for example, cn.
ldapURLForUsers - The URL to your LDAP that points to the user
accounts, for example,
ldap://bar2:10389/ou=users\,ou=ags\,dc=example\,dc=com.
The URL to your LDAP will need to be provided
by your LDAP administrator.
This property is not applicable when
configuring Windows Active Directory.
userEmailAttribute - The attribute in Windows Active Directory
or LDAP that contains the email addresses
of the users, for example, email.
usernameAttribute - The LDAP attribute of the user entry that is
to be treated as the user name, for example, cn.
This property is not applicable when
configuring Windows Active Directory.
caseSensitive - In the rare case where your Windows Active
Directory is configured to be case sensitive,
set this property to true.
If your LDAP is configured to be case
insensitive, set parameter to false.
"""
url = self._url + "/config/updateIdentityStore"
params = {
"f" : "json",
"userPassword" : userPassword,
"isPasswordEncrypted" : isPasswordEncrypted,
"user" : user,
"userFullnameAttribute": userFullnameAttribute,
"ldapURLForUsers" : ldapURLForUsers,
"userEmailAttribute" : userEmailAttribute,
"usernameAttribute" : usernameAttribute,
"caseSensitive" : caseSensitive
}
return self._post(url=url, param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def updateIdenityStore(self,
userPassword,
user,
userFullnameAttribute,
ldapURLForUsers,
userEmailAttribute,
usernameAttribute,
isPasswordEncrypted=False,
caseSensitive=True):
r"""
You can use this operation to change the identity provider
configuration in your portal. When Portal for ArcGIS is first
installed, it supports token-based authentication using the
built-in identity store for accounts. To configure your portal to
connect to your enterprise authentication mechanism, it must be
configured to use an enterprise identity store such as Windows
Active Directory or LDAP.
Inputs:
userPassword -The password for the domain account, for example,
secret.
isPasswordEncrypted - Indicates if the userPassword property is
an encrypted password or plain text. If
the property is false, the API will
encrypt the password automatically.
user - A user account with at least read permissions to look up
the email addresses and user names of users in your
organization. If possible, use an account whose password
does not expire.
Windows Active Directory example: mydomain\\winaccount
LDAP example: uid=admin\,ou=system
userFullnameAttribute - The attribute in Windows Active
Directory or LDAP that contains the full
name of the users, for example, cn.
ldapURLForUsers - The URL to your LDAP that points to the user
accounts, for example,
ldap://bar2:10389/ou=users\,ou=ags\,dc=example\,dc=com.
The URL to your LDAP will need to be provided
by your LDAP administrator.
This property is not applicable when
configuring Windows Active Directory.
userEmailAttribute - The attribute in Windows Active Directory
or LDAP that contains the email addresses
of the users, for example, email.
usernameAttribute - The LDAP attribute of the user entry that is
to be treated as the user name, for example, cn.
This property is not applicable when
configuring Windows Active Directory.
caseSensitive - In the rare case where your Windows Active
Directory is configured to be case sensitive,
set this property to true.
If your LDAP is configured to be case
insensitive, set parameter to false.
"""
url = self._url + "/config/updateIdentityStore"
params = {
"f" : "json",
"userPassword" : userPassword,
"isPasswordEncrypted" : isPasswordEncrypted,
"user" : user,
"userFullnameAttribute": userFullnameAttribute,
"ldapURLForUsers" : ldapURLForUsers,
"userEmailAttribute" : userEmailAttribute,
"usernameAttribute" : usernameAttribute,
"caseSensitive" : caseSensitive
}
return self._post(url=url, param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"updateIdenityStore",
"(",
"self",
",",
"userPassword",
",",
"user",
",",
"userFullnameAttribute",
",",
"ldapURLForUsers",
",",
"userEmailAttribute",
",",
"usernameAttribute",
",",
"isPasswordEncrypted",
"=",
"False",
",",
"caseSensitive",
"=",
"True",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/config/updateIdentityStore\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"userPassword\"",
":",
"userPassword",
",",
"\"isPasswordEncrypted\"",
":",
"isPasswordEncrypted",
",",
"\"user\"",
":",
"user",
",",
"\"userFullnameAttribute\"",
":",
"userFullnameAttribute",
",",
"\"ldapURLForUsers\"",
":",
"ldapURLForUsers",
",",
"\"userEmailAttribute\"",
":",
"userEmailAttribute",
",",
"\"usernameAttribute\"",
":",
"usernameAttribute",
",",
"\"caseSensitive\"",
":",
"caseSensitive",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
r"""
You can use this operation to change the identity provider
configuration in your portal. When Portal for ArcGIS is first
installed, it supports token-based authentication using the
built-in identity store for accounts. To configure your portal to
connect to your enterprise authentication mechanism, it must be
configured to use an enterprise identity store such as Windows
Active Directory or LDAP.
Inputs:
userPassword -The password for the domain account, for example,
secret.
isPasswordEncrypted - Indicates if the userPassword property is
an encrypted password or plain text. If
the property is false, the API will
encrypt the password automatically.
user - A user account with at least read permissions to look up
the email addresses and user names of users in your
organization. If possible, use an account whose password
does not expire.
Windows Active Directory example: mydomain\\winaccount
LDAP example: uid=admin\,ou=system
userFullnameAttribute - The attribute in Windows Active
Directory or LDAP that contains the full
name of the users, for example, cn.
ldapURLForUsers - The URL to your LDAP that points to the user
accounts, for example,
ldap://bar2:10389/ou=users\,ou=ags\,dc=example\,dc=com.
The URL to your LDAP will need to be provided
by your LDAP administrator.
This property is not applicable when
configuring Windows Active Directory.
userEmailAttribute - The attribute in Windows Active Directory
or LDAP that contains the email addresses
of the users, for example, email.
usernameAttribute - The LDAP attribute of the user entry that is
to be treated as the user name, for example, cn.
This property is not applicable when
configuring Windows Active Directory.
caseSensitive - In the rare case where your Windows Active
Directory is configured to be case sensitive,
set this property to true.
If your LDAP is configured to be case
insensitive, set parameter to false.
|
[
"r",
"You",
"can",
"use",
"this",
"operation",
"to",
"change",
"the",
"identity",
"provider",
"configuration",
"in",
"your",
"portal",
".",
"When",
"Portal",
"for",
"ArcGIS",
"is",
"first",
"installed",
"it",
"supports",
"token",
"-",
"based",
"authentication",
"using",
"the",
"built",
"-",
"in",
"identity",
"store",
"for",
"accounts",
".",
"To",
"configure",
"your",
"portal",
"to",
"connect",
"to",
"your",
"enterprise",
"authentication",
"mechanism",
"it",
"must",
"be",
"configured",
"to",
"use",
"an",
"enterprise",
"identity",
"store",
"such",
"as",
"Windows",
"Active",
"Directory",
"or",
"LDAP",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L889-L958
|
12,914
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_System.editDirectory
|
def editDirectory(self, directoryName, physicalPath, description):
"""
The edit operation on a directory can be used to change the
physical path and description properties of the directory. This is
useful when changing the location of a directory from a local path
to a network share. However, the API does not copy your content and
data from the old path to the new path. This has to be done
independently by the system administrator.
Input:
directoryName - name of the directory to change
physicalPath - new path for directroy
description - new description of the directory
"""
url = self._url + "/directories/%s/edit" % directoryName
params = {
"f" : "json",
"physicalPath": physicalPath,
"description" : description
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def editDirectory(self, directoryName, physicalPath, description):
"""
The edit operation on a directory can be used to change the
physical path and description properties of the directory. This is
useful when changing the location of a directory from a local path
to a network share. However, the API does not copy your content and
data from the old path to the new path. This has to be done
independently by the system administrator.
Input:
directoryName - name of the directory to change
physicalPath - new path for directroy
description - new description of the directory
"""
url = self._url + "/directories/%s/edit" % directoryName
params = {
"f" : "json",
"physicalPath": physicalPath,
"description" : description
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"editDirectory",
"(",
"self",
",",
"directoryName",
",",
"physicalPath",
",",
"description",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/directories/%s/edit\"",
"%",
"directoryName",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"physicalPath\"",
":",
"physicalPath",
",",
"\"description\"",
":",
"description",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
The edit operation on a directory can be used to change the
physical path and description properties of the directory. This is
useful when changing the location of a directory from a local path
to a network share. However, the API does not copy your content and
data from the old path to the new path. This has to be done
independently by the system administrator.
Input:
directoryName - name of the directory to change
physicalPath - new path for directroy
description - new description of the directory
|
[
"The",
"edit",
"operation",
"on",
"a",
"directory",
"can",
"be",
"used",
"to",
"change",
"the",
"physical",
"path",
"and",
"description",
"properties",
"of",
"the",
"directory",
".",
"This",
"is",
"useful",
"when",
"changing",
"the",
"location",
"of",
"a",
"directory",
"from",
"a",
"local",
"path",
"to",
"a",
"network",
"share",
".",
"However",
"the",
"API",
"does",
"not",
"copy",
"your",
"content",
"and",
"data",
"from",
"the",
"old",
"path",
"to",
"the",
"new",
"path",
".",
"This",
"has",
"to",
"be",
"done",
"independently",
"by",
"the",
"system",
"administrator",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1233-L1257
|
12,915
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_System.releaseLicense
|
def releaseLicense(self, username):
"""
If a user checks out an ArcGIS Pro license for offline or
disconnected use, this operation releases the license for the
specified account. A license can only be used with a single device
running ArcGIS Pro. To check in the license, a valid access token
and refresh token is required. If the refresh token for the device
is lost, damaged, corrupted, or formatted, the user will not be
able to check in the license. This prevents the user from logging
in to ArcGIS Pro from any other device. As an administrator, you
can release the license. This frees the outstanding license and
allows the user to check out a new license or use ArcGIS Pro in a
connected environment.
Parameters:
username - username of the account
"""
url = self._url + "/licenses/releaseLicense"
params = {
"username" : username,
"f" : "json"
}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def releaseLicense(self, username):
"""
If a user checks out an ArcGIS Pro license for offline or
disconnected use, this operation releases the license for the
specified account. A license can only be used with a single device
running ArcGIS Pro. To check in the license, a valid access token
and refresh token is required. If the refresh token for the device
is lost, damaged, corrupted, or formatted, the user will not be
able to check in the license. This prevents the user from logging
in to ArcGIS Pro from any other device. As an administrator, you
can release the license. This frees the outstanding license and
allows the user to check out a new license or use ArcGIS Pro in a
connected environment.
Parameters:
username - username of the account
"""
url = self._url + "/licenses/releaseLicense"
params = {
"username" : username,
"f" : "json"
}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"releaseLicense",
"(",
"self",
",",
"username",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/licenses/releaseLicense\"",
"params",
"=",
"{",
"\"username\"",
":",
"username",
",",
"\"f\"",
":",
"\"json\"",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
If a user checks out an ArcGIS Pro license for offline or
disconnected use, this operation releases the license for the
specified account. A license can only be used with a single device
running ArcGIS Pro. To check in the license, a valid access token
and refresh token is required. If the refresh token for the device
is lost, damaged, corrupted, or formatted, the user will not be
able to check in the license. This prevents the user from logging
in to ArcGIS Pro from any other device. As an administrator, you
can release the license. This frees the outstanding license and
allows the user to check out a new license or use ArcGIS Pro in a
connected environment.
Parameters:
username - username of the account
|
[
"If",
"a",
"user",
"checks",
"out",
"an",
"ArcGIS",
"Pro",
"license",
"for",
"offline",
"or",
"disconnected",
"use",
"this",
"operation",
"releases",
"the",
"license",
"for",
"the",
"specified",
"account",
".",
"A",
"license",
"can",
"only",
"be",
"used",
"with",
"a",
"single",
"device",
"running",
"ArcGIS",
"Pro",
".",
"To",
"check",
"in",
"the",
"license",
"a",
"valid",
"access",
"token",
"and",
"refresh",
"token",
"is",
"required",
".",
"If",
"the",
"refresh",
"token",
"for",
"the",
"device",
"is",
"lost",
"damaged",
"corrupted",
"or",
"formatted",
"the",
"user",
"will",
"not",
"be",
"able",
"to",
"check",
"in",
"the",
"license",
".",
"This",
"prevents",
"the",
"user",
"from",
"logging",
"in",
"to",
"ArcGIS",
"Pro",
"from",
"any",
"other",
"device",
".",
"As",
"an",
"administrator",
"you",
"can",
"release",
"the",
"license",
".",
"This",
"frees",
"the",
"outstanding",
"license",
"and",
"allows",
"the",
"user",
"to",
"check",
"out",
"a",
"new",
"license",
"or",
"use",
"ArcGIS",
"Pro",
"in",
"a",
"connected",
"environment",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1303-L1328
|
12,916
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_System.removeAllEntitlements
|
def removeAllEntitlements(self, appId):
"""
This operation removes all entitlements from the portal for ArcGIS
Pro or additional products such as Navigator for ArcGIS and revokes
all entitlements assigned to users for the specified product. The
portal is no longer a licensing portal for that product.
License assignments are retained on disk. Therefore, if you decide
to configure this portal as a licensing portal for the product
again in the future, all licensing assignments will be available in
the website.
Parameters:
appId - The identifier for the application for which the
entitlements are being removed.
"""
params = {
"f" : "json",
"appId" : appId
}
url = self._url + "/licenses/removeAllEntitlements"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def removeAllEntitlements(self, appId):
"""
This operation removes all entitlements from the portal for ArcGIS
Pro or additional products such as Navigator for ArcGIS and revokes
all entitlements assigned to users for the specified product. The
portal is no longer a licensing portal for that product.
License assignments are retained on disk. Therefore, if you decide
to configure this portal as a licensing portal for the product
again in the future, all licensing assignments will be available in
the website.
Parameters:
appId - The identifier for the application for which the
entitlements are being removed.
"""
params = {
"f" : "json",
"appId" : appId
}
url = self._url + "/licenses/removeAllEntitlements"
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"removeAllEntitlements",
"(",
"self",
",",
"appId",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"appId\"",
":",
"appId",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/licenses/removeAllEntitlements\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
This operation removes all entitlements from the portal for ArcGIS
Pro or additional products such as Navigator for ArcGIS and revokes
all entitlements assigned to users for the specified product. The
portal is no longer a licensing portal for that product.
License assignments are retained on disk. Therefore, if you decide
to configure this portal as a licensing portal for the product
again in the future, all licensing assignments will be available in
the website.
Parameters:
appId - The identifier for the application for which the
entitlements are being removed.
|
[
"This",
"operation",
"removes",
"all",
"entitlements",
"from",
"the",
"portal",
"for",
"ArcGIS",
"Pro",
"or",
"additional",
"products",
"such",
"as",
"Navigator",
"for",
"ArcGIS",
"and",
"revokes",
"all",
"entitlements",
"assigned",
"to",
"users",
"for",
"the",
"specified",
"product",
".",
"The",
"portal",
"is",
"no",
"longer",
"a",
"licensing",
"portal",
"for",
"that",
"product",
".",
"License",
"assignments",
"are",
"retained",
"on",
"disk",
".",
"Therefore",
"if",
"you",
"decide",
"to",
"configure",
"this",
"portal",
"as",
"a",
"licensing",
"portal",
"for",
"the",
"product",
"again",
"in",
"the",
"future",
"all",
"licensing",
"assignments",
"will",
"be",
"available",
"in",
"the",
"website",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1330-L1353
|
12,917
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_System.updateLanguages
|
def updateLanguages(self, languages):
"""
You can use this operation to change which languages will have
content displayed in portal search results.
Parameters:
languages - The JSON object containing all of the possible
portal languages and their corresponding status (true or
false).
"""
url = self._url = "/languages/update"
params = {
"f" : "json",
"languages" : languages
}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def updateLanguages(self, languages):
"""
You can use this operation to change which languages will have
content displayed in portal search results.
Parameters:
languages - The JSON object containing all of the possible
portal languages and their corresponding status (true or
false).
"""
url = self._url = "/languages/update"
params = {
"f" : "json",
"languages" : languages
}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"updateLanguages",
"(",
"self",
",",
"languages",
")",
":",
"url",
"=",
"self",
".",
"_url",
"=",
"\"/languages/update\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"languages\"",
":",
"languages",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
You can use this operation to change which languages will have
content displayed in portal search results.
Parameters:
languages - The JSON object containing all of the possible
portal languages and their corresponding status (true or
false).
|
[
"You",
"can",
"use",
"this",
"operation",
"to",
"change",
"which",
"languages",
"will",
"have",
"content",
"displayed",
"in",
"portal",
"search",
"results",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1368-L1386
|
12,918
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_System.updateLicenseManager
|
def updateLicenseManager(self, licenseManagerInfo):
"""
ArcGIS License Server Administrator works with your portal and
enforces licenses for ArcGIS Pro. This operation allows you to
change the license server connection information for your portal.
When you import entitlements into portal using the Import
Entitlements operation, a license server is automatically configured
for you. If your license server changes after the entitlements have
been imported, you only need to change the license server
connection information.
You can register a backup license manager for high availability of
your licensing portal. When configuring a backup license manager,
you need to make sure that the backup license manager has been
authorized with the same organizational entitlements. After
configuring the backup license manager, Portal for ArcGIS is
restarted automatically. When the restart completes, the portal is
configured with the backup license server you specified.
Parameters:
licenseManagerInfo - The JSON representation of the license
server connection information.
"""
url = self._url + "/licenses/updateLicenseManager"
params = {
"f" : "json",
"licenseManagerInfo" : licenseManagerInfo
}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def updateLicenseManager(self, licenseManagerInfo):
"""
ArcGIS License Server Administrator works with your portal and
enforces licenses for ArcGIS Pro. This operation allows you to
change the license server connection information for your portal.
When you import entitlements into portal using the Import
Entitlements operation, a license server is automatically configured
for you. If your license server changes after the entitlements have
been imported, you only need to change the license server
connection information.
You can register a backup license manager for high availability of
your licensing portal. When configuring a backup license manager,
you need to make sure that the backup license manager has been
authorized with the same organizational entitlements. After
configuring the backup license manager, Portal for ArcGIS is
restarted automatically. When the restart completes, the portal is
configured with the backup license server you specified.
Parameters:
licenseManagerInfo - The JSON representation of the license
server connection information.
"""
url = self._url + "/licenses/updateLicenseManager"
params = {
"f" : "json",
"licenseManagerInfo" : licenseManagerInfo
}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"updateLicenseManager",
"(",
"self",
",",
"licenseManagerInfo",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/licenses/updateLicenseManager\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"licenseManagerInfo\"",
":",
"licenseManagerInfo",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
ArcGIS License Server Administrator works with your portal and
enforces licenses for ArcGIS Pro. This operation allows you to
change the license server connection information for your portal.
When you import entitlements into portal using the Import
Entitlements operation, a license server is automatically configured
for you. If your license server changes after the entitlements have
been imported, you only need to change the license server
connection information.
You can register a backup license manager for high availability of
your licensing portal. When configuring a backup license manager,
you need to make sure that the backup license manager has been
authorized with the same organizational entitlements. After
configuring the backup license manager, Portal for ArcGIS is
restarted automatically. When the restart completes, the portal is
configured with the backup license server you specified.
Parameters:
licenseManagerInfo - The JSON representation of the license
server connection information.
|
[
"ArcGIS",
"License",
"Server",
"Administrator",
"works",
"with",
"your",
"portal",
"and",
"enforces",
"licenses",
"for",
"ArcGIS",
"Pro",
".",
"This",
"operation",
"allows",
"you",
"to",
"change",
"the",
"license",
"server",
"connection",
"information",
"for",
"your",
"portal",
".",
"When",
"you",
"import",
"entitlements",
"into",
"portal",
"using",
"the",
"Import",
"Entitlements",
"operation",
"a",
"license",
"server",
"is",
"automatically",
"configured",
"for",
"you",
".",
"If",
"your",
"license",
"server",
"changes",
"after",
"the",
"entitlements",
"have",
"been",
"imported",
"you",
"only",
"need",
"to",
"change",
"the",
"license",
"server",
"connection",
"information",
".",
"You",
"can",
"register",
"a",
"backup",
"license",
"manager",
"for",
"high",
"availability",
"of",
"your",
"licensing",
"portal",
".",
"When",
"configuring",
"a",
"backup",
"license",
"manager",
"you",
"need",
"to",
"make",
"sure",
"that",
"the",
"backup",
"license",
"manager",
"has",
"been",
"authorized",
"with",
"the",
"same",
"organizational",
"entitlements",
".",
"After",
"configuring",
"the",
"backup",
"license",
"manager",
"Portal",
"for",
"ArcGIS",
"is",
"restarted",
"automatically",
".",
"When",
"the",
"restart",
"completes",
"the",
"portal",
"is",
"configured",
"with",
"the",
"backup",
"license",
"server",
"you",
"specified",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1388-L1418
|
12,919
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
_System.updateIndexConfiguration
|
def updateIndexConfiguration(self,
indexerHost="localhost",
indexerPort=7199):
"""
You can use this operation to change the connection information for
the indexing service. By default, Portal for ArcGIS runs an
indexing service that runs on port 7199. If you want the sharing
API to refer to the indexing service on another instance, you need
to provide the host and port parameters.
Input:
indexerHost - The name of the server (hostname) on which the
index service runs. The default value is localhost
indexerPort - The port number on which the index service is
listening. The default value is 7199
"""
url = self._url + "/indexer/update"
params = {
"f" : "json",
"indexerHost": indexerHost,
"indexerPort": indexerPort
}
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def updateIndexConfiguration(self,
indexerHost="localhost",
indexerPort=7199):
"""
You can use this operation to change the connection information for
the indexing service. By default, Portal for ArcGIS runs an
indexing service that runs on port 7199. If you want the sharing
API to refer to the indexing service on another instance, you need
to provide the host and port parameters.
Input:
indexerHost - The name of the server (hostname) on which the
index service runs. The default value is localhost
indexerPort - The port number on which the index service is
listening. The default value is 7199
"""
url = self._url + "/indexer/update"
params = {
"f" : "json",
"indexerHost": indexerHost,
"indexerPort": indexerPort
}
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"updateIndexConfiguration",
"(",
"self",
",",
"indexerHost",
"=",
"\"localhost\"",
",",
"indexerPort",
"=",
"7199",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/indexer/update\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"indexerHost\"",
":",
"indexerHost",
",",
"\"indexerPort\"",
":",
"indexerPort",
"}",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
You can use this operation to change the connection information for
the indexing service. By default, Portal for ArcGIS runs an
indexing service that runs on port 7199. If you want the sharing
API to refer to the indexing service on another instance, you need
to provide the host and port parameters.
Input:
indexerHost - The name of the server (hostname) on which the
index service runs. The default value is localhost
indexerPort - The port number on which the index service is
listening. The default value is 7199
|
[
"You",
"can",
"use",
"this",
"operation",
"to",
"change",
"the",
"connection",
"information",
"for",
"the",
"indexing",
"service",
".",
"By",
"default",
"Portal",
"for",
"ArcGIS",
"runs",
"an",
"indexing",
"service",
"that",
"runs",
"on",
"port",
"7199",
".",
"If",
"you",
"want",
"the",
"sharing",
"API",
"to",
"refer",
"to",
"the",
"indexing",
"service",
"on",
"another",
"instance",
"you",
"need",
"to",
"provide",
"the",
"host",
"and",
"port",
"parameters",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1536-L1562
|
12,920
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
PortalAdministration.exportSite
|
def exportSite(self, location):
"""
This operation exports the portal site configuration to a location
you specify.
"""
params = {
"location" : location,
"f" : "json"
}
url = self._url + "/exportSite"
return self._post(url=url, param_dict=params)
|
python
|
def exportSite(self, location):
"""
This operation exports the portal site configuration to a location
you specify.
"""
params = {
"location" : location,
"f" : "json"
}
url = self._url + "/exportSite"
return self._post(url=url, param_dict=params)
|
[
"def",
"exportSite",
"(",
"self",
",",
"location",
")",
":",
"params",
"=",
"{",
"\"location\"",
":",
"location",
",",
"\"f\"",
":",
"\"json\"",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/exportSite\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
")"
] |
This operation exports the portal site configuration to a location
you specify.
|
[
"This",
"operation",
"exports",
"the",
"portal",
"site",
"configuration",
"to",
"a",
"location",
"you",
"specify",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1722-L1732
|
12,921
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
PortalAdministration.importSite
|
def importSite(self, location):
"""
This operation imports the portal site configuration to a location
you specify.
"""
params = {
"location" : location,
"f" : "json"
}
url = self._url + "/importSite"
return self._post(url=url, param_dict=params)
|
python
|
def importSite(self, location):
"""
This operation imports the portal site configuration to a location
you specify.
"""
params = {
"location" : location,
"f" : "json"
}
url = self._url + "/importSite"
return self._post(url=url, param_dict=params)
|
[
"def",
"importSite",
"(",
"self",
",",
"location",
")",
":",
"params",
"=",
"{",
"\"location\"",
":",
"location",
",",
"\"f\"",
":",
"\"json\"",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/importSite\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
")"
] |
This operation imports the portal site configuration to a location
you specify.
|
[
"This",
"operation",
"imports",
"the",
"portal",
"site",
"configuration",
"to",
"a",
"location",
"you",
"specify",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1734-L1744
|
12,922
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
PortalAdministration.joinSite
|
def joinSite(self, machineAdminUrl,
username, password):
"""
The joinSite operation connects a portal machine to an existing
site. You must provide an account with administrative privileges to
the site for the operation to be successful.
"""
params = {
"machineAdminUrl" : machineAdminUrl,
"username" : username,
"password" : password,
"f" : "json"
}
url = self._url + "/joinSite"
return self._post(url=url, param_dict=params)
|
python
|
def joinSite(self, machineAdminUrl,
username, password):
"""
The joinSite operation connects a portal machine to an existing
site. You must provide an account with administrative privileges to
the site for the operation to be successful.
"""
params = {
"machineAdminUrl" : machineAdminUrl,
"username" : username,
"password" : password,
"f" : "json"
}
url = self._url + "/joinSite"
return self._post(url=url, param_dict=params)
|
[
"def",
"joinSite",
"(",
"self",
",",
"machineAdminUrl",
",",
"username",
",",
"password",
")",
":",
"params",
"=",
"{",
"\"machineAdminUrl\"",
":",
"machineAdminUrl",
",",
"\"username\"",
":",
"username",
",",
"\"password\"",
":",
"password",
",",
"\"f\"",
":",
"\"json\"",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/joinSite\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
")"
] |
The joinSite operation connects a portal machine to an existing
site. You must provide an account with administrative privileges to
the site for the operation to be successful.
|
[
"The",
"joinSite",
"operation",
"connects",
"a",
"portal",
"machine",
"to",
"an",
"existing",
"site",
".",
"You",
"must",
"provide",
"an",
"account",
"with",
"administrative",
"privileges",
"to",
"the",
"site",
"for",
"the",
"operation",
"to",
"be",
"successful",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1746-L1760
|
12,923
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
PortalAdministration.unregisterMachine
|
def unregisterMachine(self, machineName):
"""
This operation unregisters a portal machine from a portal site. The
operation can only performed when there are two machines
participating in a portal site.
"""
url = self._url + "/machines/unregister"
params = {
"f" : "json",
"machineName" : machineName
}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def unregisterMachine(self, machineName):
"""
This operation unregisters a portal machine from a portal site. The
operation can only performed when there are two machines
participating in a portal site.
"""
url = self._url + "/machines/unregister"
params = {
"f" : "json",
"machineName" : machineName
}
return self._post(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"unregisterMachine",
"(",
"self",
",",
"machineName",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/machines/unregister\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"machineName\"",
":",
"machineName",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
This operation unregisters a portal machine from a portal site. The
operation can only performed when there are two machines
participating in a portal site.
|
[
"This",
"operation",
"unregisters",
"a",
"portal",
"machine",
"from",
"a",
"portal",
"site",
".",
"The",
"operation",
"can",
"only",
"performed",
"when",
"there",
"are",
"two",
"machines",
"participating",
"in",
"a",
"portal",
"site",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1762-L1776
|
12,924
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
PortalAdministration.federation
|
def federation(self):
"""returns the class that controls federation"""
url = self._url + "/federation"
return _Federation(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def federation(self):
"""returns the class that controls federation"""
url = self._url + "/federation"
return _Federation(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"federation",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/federation\"",
"return",
"_Federation",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
returns the class that controls federation
|
[
"returns",
"the",
"class",
"that",
"controls",
"federation"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1779-L1785
|
12,925
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
PortalAdministration.system
|
def system(self):
"""
Creates a reference to the System operations for Portal
"""
url = self._url + "/system"
return _System(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def system(self):
"""
Creates a reference to the System operations for Portal
"""
url = self._url + "/system"
return _System(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"system",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/system\"",
"return",
"_System",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
Creates a reference to the System operations for Portal
|
[
"Creates",
"a",
"reference",
"to",
"the",
"System",
"operations",
"for",
"Portal"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1788-L1796
|
12,926
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
PortalAdministration.security
|
def security(self):
"""
Creates a reference to the Security operations for Portal
"""
url = self._url + "/security"
return _Security(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def security(self):
"""
Creates a reference to the Security operations for Portal
"""
url = self._url + "/security"
return _Security(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"security",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/security\"",
"return",
"_Security",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
Creates a reference to the Security operations for Portal
|
[
"Creates",
"a",
"reference",
"to",
"the",
"Security",
"operations",
"for",
"Portal"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1799-L1807
|
12,927
|
Esri/ArcREST
|
src/arcrest/manageportal/administration.py
|
PortalAdministration.logs
|
def logs(self):
"""returns the portals log information"""
url = self._url + "/logs"
return _log(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def logs(self):
"""returns the portals log information"""
url = self._url + "/logs"
return _log(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"logs",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/logs\"",
"return",
"_log",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
returns the portals log information
|
[
"returns",
"the",
"portals",
"log",
"information"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageportal/administration.py#L1810-L1816
|
12,928
|
Esri/ArcREST
|
src/arcrest/opendata/opendata.py
|
OpenData.search
|
def search(self,
q=None,
per_page=None,
page=None,
bbox=None,
sort_by="relavance",
sort_order="asc"):
"""
searches the opendata site and returns the dataset results
"""
url = self._url + "/datasets.json"
param_dict = {
"sort_by" : sort_by,
"f" : "json"
}
if q is not None:
param_dict['q'] = q
if per_page is not None:
param_dict['per_page'] = per_page
if page is not None:
param_dict['page'] = page
if bbox is not None:
param_dict['bbox'] = bbox
if sort_by is not None:
param_dict['sort_by'] = sort_by
if sort_order is not None:
param_dict['sort_order'] = sort_order
ds_data = self._get(url=url,
param_dict=param_dict,
securityHandler=self._securityHandler,
additional_headers=[],
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
return ds_data
|
python
|
def search(self,
q=None,
per_page=None,
page=None,
bbox=None,
sort_by="relavance",
sort_order="asc"):
"""
searches the opendata site and returns the dataset results
"""
url = self._url + "/datasets.json"
param_dict = {
"sort_by" : sort_by,
"f" : "json"
}
if q is not None:
param_dict['q'] = q
if per_page is not None:
param_dict['per_page'] = per_page
if page is not None:
param_dict['page'] = page
if bbox is not None:
param_dict['bbox'] = bbox
if sort_by is not None:
param_dict['sort_by'] = sort_by
if sort_order is not None:
param_dict['sort_order'] = sort_order
ds_data = self._get(url=url,
param_dict=param_dict,
securityHandler=self._securityHandler,
additional_headers=[],
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
return ds_data
|
[
"def",
"search",
"(",
"self",
",",
"q",
"=",
"None",
",",
"per_page",
"=",
"None",
",",
"page",
"=",
"None",
",",
"bbox",
"=",
"None",
",",
"sort_by",
"=",
"\"relavance\"",
",",
"sort_order",
"=",
"\"asc\"",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/datasets.json\"",
"param_dict",
"=",
"{",
"\"sort_by\"",
":",
"sort_by",
",",
"\"f\"",
":",
"\"json\"",
"}",
"if",
"q",
"is",
"not",
"None",
":",
"param_dict",
"[",
"'q'",
"]",
"=",
"q",
"if",
"per_page",
"is",
"not",
"None",
":",
"param_dict",
"[",
"'per_page'",
"]",
"=",
"per_page",
"if",
"page",
"is",
"not",
"None",
":",
"param_dict",
"[",
"'page'",
"]",
"=",
"page",
"if",
"bbox",
"is",
"not",
"None",
":",
"param_dict",
"[",
"'bbox'",
"]",
"=",
"bbox",
"if",
"sort_by",
"is",
"not",
"None",
":",
"param_dict",
"[",
"'sort_by'",
"]",
"=",
"sort_by",
"if",
"sort_order",
"is",
"not",
"None",
":",
"param_dict",
"[",
"'sort_order'",
"]",
"=",
"sort_order",
"ds_data",
"=",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"param_dict",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"additional_headers",
"=",
"[",
"]",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"return",
"ds_data"
] |
searches the opendata site and returns the dataset results
|
[
"searches",
"the",
"opendata",
"site",
"and",
"returns",
"the",
"dataset",
"results"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/opendata/opendata.py#L42-L75
|
12,929
|
Esri/ArcREST
|
src/arcrest/opendata/opendata.py
|
OpenData.getDataset
|
def getDataset(self, itemId):
"""gets a dataset class"""
if self._url.lower().find('datasets') > -1:
url = self._url
else:
url = self._url + "/datasets"
return OpenDataItem(url=url,
itemId=itemId,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def getDataset(self, itemId):
"""gets a dataset class"""
if self._url.lower().find('datasets') > -1:
url = self._url
else:
url = self._url + "/datasets"
return OpenDataItem(url=url,
itemId=itemId,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"getDataset",
"(",
"self",
",",
"itemId",
")",
":",
"if",
"self",
".",
"_url",
".",
"lower",
"(",
")",
".",
"find",
"(",
"'datasets'",
")",
">",
"-",
"1",
":",
"url",
"=",
"self",
".",
"_url",
"else",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/datasets\"",
"return",
"OpenDataItem",
"(",
"url",
"=",
"url",
",",
"itemId",
"=",
"itemId",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
gets a dataset class
|
[
"gets",
"a",
"dataset",
"class"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/opendata/opendata.py#L77-L87
|
12,930
|
Esri/ArcREST
|
src/arcrest/opendata/opendata.py
|
OpenDataItem.__init
|
def __init(self):
"""gets the properties for the site"""
url = "%s/%s.json" % (self._url, self._itemId)
params = {"f": "json"}
json_dict = self._get(url, params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
self._json_dict = json_dict
self._json = json.dumps(self._json_dict)
setattr(self, "data", json_dict['data'])
if 'data' in json_dict:
for k,v in json_dict['data'].items():
setattr(self, k, v)
del k,v
|
python
|
def __init(self):
"""gets the properties for the site"""
url = "%s/%s.json" % (self._url, self._itemId)
params = {"f": "json"}
json_dict = self._get(url, params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
self._json_dict = json_dict
self._json = json.dumps(self._json_dict)
setattr(self, "data", json_dict['data'])
if 'data' in json_dict:
for k,v in json_dict['data'].items():
setattr(self, k, v)
del k,v
|
[
"def",
"__init",
"(",
"self",
")",
":",
"url",
"=",
"\"%s/%s.json\"",
"%",
"(",
"self",
".",
"_url",
",",
"self",
".",
"_itemId",
")",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"json_dict",
"=",
"self",
".",
"_get",
"(",
"url",
",",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")",
"self",
".",
"_json_dict",
"=",
"json_dict",
"self",
".",
"_json",
"=",
"json",
".",
"dumps",
"(",
"self",
".",
"_json_dict",
")",
"setattr",
"(",
"self",
",",
"\"data\"",
",",
"json_dict",
"[",
"'data'",
"]",
")",
"if",
"'data'",
"in",
"json_dict",
":",
"for",
"k",
",",
"v",
"in",
"json_dict",
"[",
"'data'",
"]",
".",
"items",
"(",
")",
":",
"setattr",
"(",
"self",
",",
"k",
",",
"v",
")",
"del",
"k",
",",
"v"
] |
gets the properties for the site
|
[
"gets",
"the",
"properties",
"for",
"the",
"site"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/opendata/opendata.py#L125-L139
|
12,931
|
Esri/ArcREST
|
src/arcrest/opendata/opendata.py
|
OpenDataItem.export
|
def export(self, outFormat="shp", outFolder=None):
"""exports a dataset t"""
export_formats = {'shp':".zip", 'kml':'.kml', 'geojson':".geojson",'csv': '.csv'}
url = "%s/%s%s" % (self._url, self._itemId, export_formats[outFormat])
results = self._get(url=url,
securityHandler=self._securityHandler,
out_folder=outFolder)
if 'status' in results:
self.time.sleep(7)
results = self.export(outFormat=outFormat, outFolder=outFolder)
return results
|
python
|
def export(self, outFormat="shp", outFolder=None):
"""exports a dataset t"""
export_formats = {'shp':".zip", 'kml':'.kml', 'geojson':".geojson",'csv': '.csv'}
url = "%s/%s%s" % (self._url, self._itemId, export_formats[outFormat])
results = self._get(url=url,
securityHandler=self._securityHandler,
out_folder=outFolder)
if 'status' in results:
self.time.sleep(7)
results = self.export(outFormat=outFormat, outFolder=outFolder)
return results
|
[
"def",
"export",
"(",
"self",
",",
"outFormat",
"=",
"\"shp\"",
",",
"outFolder",
"=",
"None",
")",
":",
"export_formats",
"=",
"{",
"'shp'",
":",
"\".zip\"",
",",
"'kml'",
":",
"'.kml'",
",",
"'geojson'",
":",
"\".geojson\"",
",",
"'csv'",
":",
"'.csv'",
"}",
"url",
"=",
"\"%s/%s%s\"",
"%",
"(",
"self",
".",
"_url",
",",
"self",
".",
"_itemId",
",",
"export_formats",
"[",
"outFormat",
"]",
")",
"results",
"=",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"out_folder",
"=",
"outFolder",
")",
"if",
"'status'",
"in",
"results",
":",
"self",
".",
"time",
".",
"sleep",
"(",
"7",
")",
"results",
"=",
"self",
".",
"export",
"(",
"outFormat",
"=",
"outFormat",
",",
"outFolder",
"=",
"outFolder",
")",
"return",
"results"
] |
exports a dataset t
|
[
"exports",
"a",
"dataset",
"t"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/opendata/opendata.py#L142-L152
|
12,932
|
Esri/ArcREST
|
src/arcrest/web/_base.py
|
BaseOperation.error
|
def error(self):
if self._error is None:
try:
#__init is renamed to the class with an _
init = getattr(self, "_" + self.__class__.__name__ + "__init", None)
if init is not None and callable(init):
init()
except Exception as e:
pass
"""gets the error"""
return self._error
|
python
|
def error(self):
if self._error is None:
try:
#__init is renamed to the class with an _
init = getattr(self, "_" + self.__class__.__name__ + "__init", None)
if init is not None and callable(init):
init()
except Exception as e:
pass
"""gets the error"""
return self._error
|
[
"def",
"error",
"(",
"self",
")",
":",
"if",
"self",
".",
"_error",
"is",
"None",
":",
"try",
":",
"#__init is renamed to the class with an _",
"init",
"=",
"getattr",
"(",
"self",
",",
"\"_\"",
"+",
"self",
".",
"__class__",
".",
"__name__",
"+",
"\"__init\"",
",",
"None",
")",
"if",
"init",
"is",
"not",
"None",
"and",
"callable",
"(",
"init",
")",
":",
"init",
"(",
")",
"except",
"Exception",
"as",
"e",
":",
"pass",
"return",
"self",
".",
"_error"
] |
gets the error
|
[
"gets",
"the",
"error"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/web/_base.py#L39-L49
|
12,933
|
Esri/ArcREST
|
src/arcrest/web/_base.py
|
MultiPartForm._2
|
def _2(self):
"""python 2.x version of formatting body data"""
boundary = self.boundary
buf = StringIO()
for (key, value) in self.form_fields:
buf.write('--%s\r\n' % boundary)
buf.write('Content-Disposition: form-data; name="%s"' % key)
buf.write('\r\n\r\n%s\r\n' % value)
for (key, filename, mimetype, filepath) in self.files:
if os.path.isfile(filepath):
buf.write('--{boundary}\r\n'
'Content-Disposition: form-data; name="{key}"; '
'filename="{filename}"\r\n'
'Content-Type: {content_type}\r\n\r\n'.format(
boundary=boundary,
key=key,
filename=filename,
content_type=mimetype))
with open(filepath, "rb") as f:
shutil.copyfileobj(f, buf)
buf.write('\r\n')
buf.write('--' + boundary + '--\r\n\r\n')
buf = buf.getvalue()
self.form_data = buf
|
python
|
def _2(self):
"""python 2.x version of formatting body data"""
boundary = self.boundary
buf = StringIO()
for (key, value) in self.form_fields:
buf.write('--%s\r\n' % boundary)
buf.write('Content-Disposition: form-data; name="%s"' % key)
buf.write('\r\n\r\n%s\r\n' % value)
for (key, filename, mimetype, filepath) in self.files:
if os.path.isfile(filepath):
buf.write('--{boundary}\r\n'
'Content-Disposition: form-data; name="{key}"; '
'filename="{filename}"\r\n'
'Content-Type: {content_type}\r\n\r\n'.format(
boundary=boundary,
key=key,
filename=filename,
content_type=mimetype))
with open(filepath, "rb") as f:
shutil.copyfileobj(f, buf)
buf.write('\r\n')
buf.write('--' + boundary + '--\r\n\r\n')
buf = buf.getvalue()
self.form_data = buf
|
[
"def",
"_2",
"(",
"self",
")",
":",
"boundary",
"=",
"self",
".",
"boundary",
"buf",
"=",
"StringIO",
"(",
")",
"for",
"(",
"key",
",",
"value",
")",
"in",
"self",
".",
"form_fields",
":",
"buf",
".",
"write",
"(",
"'--%s\\r\\n'",
"%",
"boundary",
")",
"buf",
".",
"write",
"(",
"'Content-Disposition: form-data; name=\"%s\"'",
"%",
"key",
")",
"buf",
".",
"write",
"(",
"'\\r\\n\\r\\n%s\\r\\n'",
"%",
"value",
")",
"for",
"(",
"key",
",",
"filename",
",",
"mimetype",
",",
"filepath",
")",
"in",
"self",
".",
"files",
":",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
"filepath",
")",
":",
"buf",
".",
"write",
"(",
"'--{boundary}\\r\\n'",
"'Content-Disposition: form-data; name=\"{key}\"; '",
"'filename=\"{filename}\"\\r\\n'",
"'Content-Type: {content_type}\\r\\n\\r\\n'",
".",
"format",
"(",
"boundary",
"=",
"boundary",
",",
"key",
"=",
"key",
",",
"filename",
"=",
"filename",
",",
"content_type",
"=",
"mimetype",
")",
")",
"with",
"open",
"(",
"filepath",
",",
"\"rb\"",
")",
"as",
"f",
":",
"shutil",
".",
"copyfileobj",
"(",
"f",
",",
"buf",
")",
"buf",
".",
"write",
"(",
"'\\r\\n'",
")",
"buf",
".",
"write",
"(",
"'--'",
"+",
"boundary",
"+",
"'--\\r\\n\\r\\n'",
")",
"buf",
"=",
"buf",
".",
"getvalue",
"(",
")",
"self",
".",
"form_data",
"=",
"buf"
] |
python 2.x version of formatting body data
|
[
"python",
"2",
".",
"x",
"version",
"of",
"formatting",
"body",
"data"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/web/_base.py#L142-L165
|
12,934
|
Esri/ArcREST
|
src/arcrest/web/_base.py
|
MultiPartForm._3
|
def _3(self):
""" python 3 method"""
boundary = self.boundary
buf = BytesIO()
textwriter = io.TextIOWrapper(
buf, 'utf8', newline='', write_through=True)
for (key, value) in self.form_fields:
textwriter.write(
'--{boundary}\r\n'
'Content-Disposition: form-data; name="{key}"\r\n\r\n'
'{value}\r\n'.format(
boundary=boundary, key=key, value=value))
for(key, filename, mimetype, filepath) in self.files:
if os.path.isfile(filepath):
textwriter.write(
'--{boundary}\r\n'
'Content-Disposition: form-data; name="{key}"; '
'filename="{filename}"\r\n'
'Content-Type: {content_type}\r\n\r\n'.format(
boundary=boundary, key=key, filename=filename,
content_type=mimetype))
with open(filepath, "rb") as f:
shutil.copyfileobj(f, buf)
textwriter.write('\r\n')
textwriter.write('--{}--\r\n\r\n'.format(boundary))
self.form_data = buf.getvalue()
|
python
|
def _3(self):
""" python 3 method"""
boundary = self.boundary
buf = BytesIO()
textwriter = io.TextIOWrapper(
buf, 'utf8', newline='', write_through=True)
for (key, value) in self.form_fields:
textwriter.write(
'--{boundary}\r\n'
'Content-Disposition: form-data; name="{key}"\r\n\r\n'
'{value}\r\n'.format(
boundary=boundary, key=key, value=value))
for(key, filename, mimetype, filepath) in self.files:
if os.path.isfile(filepath):
textwriter.write(
'--{boundary}\r\n'
'Content-Disposition: form-data; name="{key}"; '
'filename="{filename}"\r\n'
'Content-Type: {content_type}\r\n\r\n'.format(
boundary=boundary, key=key, filename=filename,
content_type=mimetype))
with open(filepath, "rb") as f:
shutil.copyfileobj(f, buf)
textwriter.write('\r\n')
textwriter.write('--{}--\r\n\r\n'.format(boundary))
self.form_data = buf.getvalue()
|
[
"def",
"_3",
"(",
"self",
")",
":",
"boundary",
"=",
"self",
".",
"boundary",
"buf",
"=",
"BytesIO",
"(",
")",
"textwriter",
"=",
"io",
".",
"TextIOWrapper",
"(",
"buf",
",",
"'utf8'",
",",
"newline",
"=",
"''",
",",
"write_through",
"=",
"True",
")",
"for",
"(",
"key",
",",
"value",
")",
"in",
"self",
".",
"form_fields",
":",
"textwriter",
".",
"write",
"(",
"'--{boundary}\\r\\n'",
"'Content-Disposition: form-data; name=\"{key}\"\\r\\n\\r\\n'",
"'{value}\\r\\n'",
".",
"format",
"(",
"boundary",
"=",
"boundary",
",",
"key",
"=",
"key",
",",
"value",
"=",
"value",
")",
")",
"for",
"(",
"key",
",",
"filename",
",",
"mimetype",
",",
"filepath",
")",
"in",
"self",
".",
"files",
":",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
"filepath",
")",
":",
"textwriter",
".",
"write",
"(",
"'--{boundary}\\r\\n'",
"'Content-Disposition: form-data; name=\"{key}\"; '",
"'filename=\"{filename}\"\\r\\n'",
"'Content-Type: {content_type}\\r\\n\\r\\n'",
".",
"format",
"(",
"boundary",
"=",
"boundary",
",",
"key",
"=",
"key",
",",
"filename",
"=",
"filename",
",",
"content_type",
"=",
"mimetype",
")",
")",
"with",
"open",
"(",
"filepath",
",",
"\"rb\"",
")",
"as",
"f",
":",
"shutil",
".",
"copyfileobj",
"(",
"f",
",",
"buf",
")",
"textwriter",
".",
"write",
"(",
"'\\r\\n'",
")",
"textwriter",
".",
"write",
"(",
"'--{}--\\r\\n\\r\\n'",
".",
"format",
"(",
"boundary",
")",
")",
"self",
".",
"form_data",
"=",
"buf",
".",
"getvalue",
"(",
")"
] |
python 3 method
|
[
"python",
"3",
"method"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/web/_base.py#L167-L193
|
12,935
|
Esri/ArcREST
|
src/arcrest/web/_base.py
|
BaseWebOperations._get_file_name
|
def _get_file_name(self, contentDisposition,
url, ext=".unknown"):
""" gets the file name from the header or url if possible """
if self.PY2:
if contentDisposition is not None:
return re.findall(r'filename[^;=\n]*=(([\'"]).*?\2|[^;\n]*)',
contentDisposition.strip().replace('"', ''))[0][0]
elif os.path.basename(url).find('.') > -1:
return os.path.basename(url)
elif self.PY3:
if contentDisposition is not None:
p = re.compile(r'filename[^;=\n]*=(([\'"]).*?\2|[^;\n]*)')
return p.findall(contentDisposition.strip().replace('"', ''))[0][0]
elif os.path.basename(url).find('.') > -1:
return os.path.basename(url)
return "%s.%s" % (uuid.uuid4().get_hex(), ext)
|
python
|
def _get_file_name(self, contentDisposition,
url, ext=".unknown"):
""" gets the file name from the header or url if possible """
if self.PY2:
if contentDisposition is not None:
return re.findall(r'filename[^;=\n]*=(([\'"]).*?\2|[^;\n]*)',
contentDisposition.strip().replace('"', ''))[0][0]
elif os.path.basename(url).find('.') > -1:
return os.path.basename(url)
elif self.PY3:
if contentDisposition is not None:
p = re.compile(r'filename[^;=\n]*=(([\'"]).*?\2|[^;\n]*)')
return p.findall(contentDisposition.strip().replace('"', ''))[0][0]
elif os.path.basename(url).find('.') > -1:
return os.path.basename(url)
return "%s.%s" % (uuid.uuid4().get_hex(), ext)
|
[
"def",
"_get_file_name",
"(",
"self",
",",
"contentDisposition",
",",
"url",
",",
"ext",
"=",
"\".unknown\"",
")",
":",
"if",
"self",
".",
"PY2",
":",
"if",
"contentDisposition",
"is",
"not",
"None",
":",
"return",
"re",
".",
"findall",
"(",
"r'filename[^;=\\n]*=(([\\'\"]).*?\\2|[^;\\n]*)'",
",",
"contentDisposition",
".",
"strip",
"(",
")",
".",
"replace",
"(",
"'\"'",
",",
"''",
")",
")",
"[",
"0",
"]",
"[",
"0",
"]",
"elif",
"os",
".",
"path",
".",
"basename",
"(",
"url",
")",
".",
"find",
"(",
"'.'",
")",
">",
"-",
"1",
":",
"return",
"os",
".",
"path",
".",
"basename",
"(",
"url",
")",
"elif",
"self",
".",
"PY3",
":",
"if",
"contentDisposition",
"is",
"not",
"None",
":",
"p",
"=",
"re",
".",
"compile",
"(",
"r'filename[^;=\\n]*=(([\\'\"]).*?\\2|[^;\\n]*)'",
")",
"return",
"p",
".",
"findall",
"(",
"contentDisposition",
".",
"strip",
"(",
")",
".",
"replace",
"(",
"'\"'",
",",
"''",
")",
")",
"[",
"0",
"]",
"[",
"0",
"]",
"elif",
"os",
".",
"path",
".",
"basename",
"(",
"url",
")",
".",
"find",
"(",
"'.'",
")",
">",
"-",
"1",
":",
"return",
"os",
".",
"path",
".",
"basename",
"(",
"url",
")",
"return",
"\"%s.%s\"",
"%",
"(",
"uuid",
".",
"uuid4",
"(",
")",
".",
"get_hex",
"(",
")",
",",
"ext",
")"
] |
gets the file name from the header or url if possible
|
[
"gets",
"the",
"file",
"name",
"from",
"the",
"header",
"or",
"url",
"if",
"possible"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/web/_base.py#L247-L262
|
12,936
|
Esri/ArcREST
|
src/arcrest/web/_base.py
|
BaseWebOperations._mainType
|
def _mainType(self, resp):
""" gets the main type from the response object"""
if self.PY2:
return resp.headers.maintype
elif self.PY3:
return resp.headers.get_content_maintype()
else:
return None
|
python
|
def _mainType(self, resp):
""" gets the main type from the response object"""
if self.PY2:
return resp.headers.maintype
elif self.PY3:
return resp.headers.get_content_maintype()
else:
return None
|
[
"def",
"_mainType",
"(",
"self",
",",
"resp",
")",
":",
"if",
"self",
".",
"PY2",
":",
"return",
"resp",
".",
"headers",
".",
"maintype",
"elif",
"self",
".",
"PY3",
":",
"return",
"resp",
".",
"headers",
".",
"get_content_maintype",
"(",
")",
"else",
":",
"return",
"None"
] |
gets the main type from the response object
|
[
"gets",
"the",
"main",
"type",
"from",
"the",
"response",
"object"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/web/_base.py#L346-L353
|
12,937
|
Esri/ArcREST
|
src/arcrest/web/_base.py
|
BaseWebOperations._chunk
|
def _chunk(self, response, size=4096):
""" downloads a web response in pieces """
method = response.headers.get("content-encoding")
if method == "gzip":
d = zlib.decompressobj(16+zlib.MAX_WBITS)
b = response.read(size)
while b:
data = d.decompress(b)
yield data
b = response.read(size)
del data
else:
while True:
chunk = response.read(size)
if not chunk: break
yield chunk
|
python
|
def _chunk(self, response, size=4096):
""" downloads a web response in pieces """
method = response.headers.get("content-encoding")
if method == "gzip":
d = zlib.decompressobj(16+zlib.MAX_WBITS)
b = response.read(size)
while b:
data = d.decompress(b)
yield data
b = response.read(size)
del data
else:
while True:
chunk = response.read(size)
if not chunk: break
yield chunk
|
[
"def",
"_chunk",
"(",
"self",
",",
"response",
",",
"size",
"=",
"4096",
")",
":",
"method",
"=",
"response",
".",
"headers",
".",
"get",
"(",
"\"content-encoding\"",
")",
"if",
"method",
"==",
"\"gzip\"",
":",
"d",
"=",
"zlib",
".",
"decompressobj",
"(",
"16",
"+",
"zlib",
".",
"MAX_WBITS",
")",
"b",
"=",
"response",
".",
"read",
"(",
"size",
")",
"while",
"b",
":",
"data",
"=",
"d",
".",
"decompress",
"(",
"b",
")",
"yield",
"data",
"b",
"=",
"response",
".",
"read",
"(",
"size",
")",
"del",
"data",
"else",
":",
"while",
"True",
":",
"chunk",
"=",
"response",
".",
"read",
"(",
"size",
")",
"if",
"not",
"chunk",
":",
"break",
"yield",
"chunk"
] |
downloads a web response in pieces
|
[
"downloads",
"a",
"web",
"response",
"in",
"pieces"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/web/_base.py#L355-L370
|
12,938
|
Esri/ArcREST
|
src/arcrest/web/_base.py
|
BaseWebOperations._asString
|
def _asString(self, value):
"""converts the value as a string"""
if sys.version_info[0] == 3:
if isinstance(value, str):
return value
elif isinstance(value, bytes):
return value.decode('utf-8')
elif sys.version_info[0] == 2:
return value.encode('ascii')
|
python
|
def _asString(self, value):
"""converts the value as a string"""
if sys.version_info[0] == 3:
if isinstance(value, str):
return value
elif isinstance(value, bytes):
return value.decode('utf-8')
elif sys.version_info[0] == 2:
return value.encode('ascii')
|
[
"def",
"_asString",
"(",
"self",
",",
"value",
")",
":",
"if",
"sys",
".",
"version_info",
"[",
"0",
"]",
"==",
"3",
":",
"if",
"isinstance",
"(",
"value",
",",
"str",
")",
":",
"return",
"value",
"elif",
"isinstance",
"(",
"value",
",",
"bytes",
")",
":",
"return",
"value",
".",
"decode",
"(",
"'utf-8'",
")",
"elif",
"sys",
".",
"version_info",
"[",
"0",
"]",
"==",
"2",
":",
"return",
"value",
".",
"encode",
"(",
"'ascii'",
")"
] |
converts the value as a string
|
[
"converts",
"the",
"value",
"as",
"a",
"string"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/web/_base.py#L533-L541
|
12,939
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.machines
|
def machines(self):
"""gets a reference to the machines object"""
if self._resources is None:
self.__init()
if "machines" in self._resources:
url = self._url + "/machines"
return _machines.Machines(url,
securityHandler=self._securityHandler,
initialize=False,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
else:
return None
|
python
|
def machines(self):
"""gets a reference to the machines object"""
if self._resources is None:
self.__init()
if "machines" in self._resources:
url = self._url + "/machines"
return _machines.Machines(url,
securityHandler=self._securityHandler,
initialize=False,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
else:
return None
|
[
"def",
"machines",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"machines\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/machines\"",
"return",
"_machines",
".",
"Machines",
"(",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"initialize",
"=",
"False",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"else",
":",
"return",
"None"
] |
gets a reference to the machines object
|
[
"gets",
"a",
"reference",
"to",
"the",
"machines",
"object"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L323-L335
|
12,940
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.data
|
def data(self):
"""returns the reference to the data functions as a class"""
if self._resources is None:
self.__init()
if "data" in self._resources:
url = self._url + "/data"
return _data.Data(url=url,
securityHandler=self._securityHandler,
initialize=True,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
else:
return None
|
python
|
def data(self):
"""returns the reference to the data functions as a class"""
if self._resources is None:
self.__init()
if "data" in self._resources:
url = self._url + "/data"
return _data.Data(url=url,
securityHandler=self._securityHandler,
initialize=True,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
else:
return None
|
[
"def",
"data",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"data\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/data\"",
"return",
"_data",
".",
"Data",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"initialize",
"=",
"True",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"else",
":",
"return",
"None"
] |
returns the reference to the data functions as a class
|
[
"returns",
"the",
"reference",
"to",
"the",
"data",
"functions",
"as",
"a",
"class"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L338-L350
|
12,941
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.info
|
def info(self):
"""
A read-only resource that returns meta information about the server
"""
if self._resources is None:
self.__init()
url = self._url + "/info"
return _info.Info(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
|
python
|
def info(self):
"""
A read-only resource that returns meta information about the server
"""
if self._resources is None:
self.__init()
url = self._url + "/info"
return _info.Info(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
|
[
"def",
"info",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/info\"",
"return",
"_info",
".",
"Info",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")"
] |
A read-only resource that returns meta information about the server
|
[
"A",
"read",
"-",
"only",
"resource",
"that",
"returns",
"meta",
"information",
"about",
"the",
"server"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L353-L364
|
12,942
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.clusters
|
def clusters(self):
"""returns the clusters functions if supported in resources"""
if self._resources is None:
self.__init()
if "clusters" in self._resources:
url = self._url + "/clusters"
return _clusters.Cluster(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
python
|
def clusters(self):
"""returns the clusters functions if supported in resources"""
if self._resources is None:
self.__init()
if "clusters" in self._resources:
url = self._url + "/clusters"
return _clusters.Cluster(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
[
"def",
"clusters",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"clusters\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/clusters\"",
"return",
"_clusters",
".",
"Cluster",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
"else",
":",
"return",
"None"
] |
returns the clusters functions if supported in resources
|
[
"returns",
"the",
"clusters",
"functions",
"if",
"supported",
"in",
"resources"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L367-L379
|
12,943
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.services
|
def services(self):
"""
Gets the services object which will provide the ArcGIS Server's
admin information about services and folders.
"""
if self._resources is None:
self.__init()
if "services" in self._resources:
url = self._url + "/services"
return _services.Services(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
python
|
def services(self):
"""
Gets the services object which will provide the ArcGIS Server's
admin information about services and folders.
"""
if self._resources is None:
self.__init()
if "services" in self._resources:
url = self._url + "/services"
return _services.Services(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
[
"def",
"services",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"services\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/services\"",
"return",
"_services",
".",
"Services",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
"else",
":",
"return",
"None"
] |
Gets the services object which will provide the ArcGIS Server's
admin information about services and folders.
|
[
"Gets",
"the",
"services",
"object",
"which",
"will",
"provide",
"the",
"ArcGIS",
"Server",
"s",
"admin",
"information",
"about",
"services",
"and",
"folders",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L382-L397
|
12,944
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.usagereports
|
def usagereports(self):
"""
Gets the services object which will provide the ArcGIS Server's
admin information about the usagereports.
"""
if self._resources is None:
self.__init()
if "usagereports" in self._resources:
url = self._url + "/usagereports"
return _usagereports.UsageReports(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
python
|
def usagereports(self):
"""
Gets the services object which will provide the ArcGIS Server's
admin information about the usagereports.
"""
if self._resources is None:
self.__init()
if "usagereports" in self._resources:
url = self._url + "/usagereports"
return _usagereports.UsageReports(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
[
"def",
"usagereports",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"usagereports\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/usagereports\"",
"return",
"_usagereports",
".",
"UsageReports",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
"else",
":",
"return",
"None"
] |
Gets the services object which will provide the ArcGIS Server's
admin information about the usagereports.
|
[
"Gets",
"the",
"services",
"object",
"which",
"will",
"provide",
"the",
"ArcGIS",
"Server",
"s",
"admin",
"information",
"about",
"the",
"usagereports",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L400-L415
|
12,945
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.kml
|
def kml(self):
"""returns the kml functions for server"""
url = self._url + "/kml"
return _kml.KML(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
|
python
|
def kml(self):
"""returns the kml functions for server"""
url = self._url + "/kml"
return _kml.KML(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
|
[
"def",
"kml",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/kml\"",
"return",
"_kml",
".",
"KML",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")"
] |
returns the kml functions for server
|
[
"returns",
"the",
"kml",
"functions",
"for",
"server"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L418-L425
|
12,946
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.logs
|
def logs(self):
"""returns an object to work with the site logs"""
if self._resources is None:
self.__init()
if "logs" in self._resources:
url = self._url + "/logs"
return _logs.Log(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
python
|
def logs(self):
"""returns an object to work with the site logs"""
if self._resources is None:
self.__init()
if "logs" in self._resources:
url = self._url + "/logs"
return _logs.Log(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
[
"def",
"logs",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"logs\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/logs\"",
"return",
"_logs",
".",
"Log",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
"else",
":",
"return",
"None"
] |
returns an object to work with the site logs
|
[
"returns",
"an",
"object",
"to",
"work",
"with",
"the",
"site",
"logs"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L428-L440
|
12,947
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.mode
|
def mode(self):
"""returns an object to work with the site mode"""
if self._resources is None:
self.__init()
if "mode" in self._resources:
url = self._url + "/mode"
return _mode.Mode(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
python
|
def mode(self):
"""returns an object to work with the site mode"""
if self._resources is None:
self.__init()
if "mode" in self._resources:
url = self._url + "/mode"
return _mode.Mode(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
[
"def",
"mode",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"mode\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/mode\"",
"return",
"_mode",
".",
"Mode",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
"else",
":",
"return",
"None"
] |
returns an object to work with the site mode
|
[
"returns",
"an",
"object",
"to",
"work",
"with",
"the",
"site",
"mode"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L443-L455
|
12,948
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.security
|
def security(self):
"""returns an object to work with the site security"""
if self._resources is None:
self.__init()
if "security" in self._resources:
url = self._url + "/security"
return _security.Security(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
python
|
def security(self):
"""returns an object to work with the site security"""
if self._resources is None:
self.__init()
if "security" in self._resources:
url = self._url + "/security"
return _security.Security(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
[
"def",
"security",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"security\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/security\"",
"return",
"_security",
".",
"Security",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
"else",
":",
"return",
"None"
] |
returns an object to work with the site security
|
[
"returns",
"an",
"object",
"to",
"work",
"with",
"the",
"site",
"security"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L458-L470
|
12,949
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.system
|
def system(self):
"""returns an object to work with the site system"""
if self._resources is None:
self.__init()
if "system" in self._resources:
url = self._url + "/system"
return _system.System(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
python
|
def system(self):
"""returns an object to work with the site system"""
if self._resources is None:
self.__init()
if "system" in self._resources:
url = self._url + "/system"
return _system.System(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
[
"def",
"system",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"system\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/system\"",
"return",
"_system",
".",
"System",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
"else",
":",
"return",
"None"
] |
returns an object to work with the site system
|
[
"returns",
"an",
"object",
"to",
"work",
"with",
"the",
"site",
"system"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L473-L485
|
12,950
|
Esri/ArcREST
|
src/arcrest/manageags/administration.py
|
AGSAdministration.uploads
|
def uploads(self):
"""returns an object to work with the site uploads"""
if self._resources is None:
self.__init()
if "uploads" in self._resources:
url = self._url + "/uploads"
return _uploads.Uploads(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
python
|
def uploads(self):
"""returns an object to work with the site uploads"""
if self._resources is None:
self.__init()
if "uploads" in self._resources:
url = self._url + "/uploads"
return _uploads.Uploads(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True)
else:
return None
|
[
"def",
"uploads",
"(",
"self",
")",
":",
"if",
"self",
".",
"_resources",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"if",
"\"uploads\"",
"in",
"self",
".",
"_resources",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/uploads\"",
"return",
"_uploads",
".",
"Uploads",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
"else",
":",
"return",
"None"
] |
returns an object to work with the site uploads
|
[
"returns",
"an",
"object",
"to",
"work",
"with",
"the",
"site",
"uploads"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/administration.py#L488-L500
|
12,951
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Community.getGroupIDs
|
def getGroupIDs(self, groupNames,communityInfo=None):
"""
This function retrieves the group IDs
Inputs:
group_names - tuple of group names
Output:
dict - list of group IDs
"""
group_ids=[]
if communityInfo is None:
communityInfo = self.communitySelf
if isinstance(groupNames,list):
groupNames = map(str.upper, groupNames)
else:
groupNames = groupNames.upper()
if 'groups' in communityInfo:
for gp in communityInfo['groups']:
if str(gp['title']).upper() in groupNames:
group_ids.append(gp['id'])
del communityInfo
return group_ids
|
python
|
def getGroupIDs(self, groupNames,communityInfo=None):
"""
This function retrieves the group IDs
Inputs:
group_names - tuple of group names
Output:
dict - list of group IDs
"""
group_ids=[]
if communityInfo is None:
communityInfo = self.communitySelf
if isinstance(groupNames,list):
groupNames = map(str.upper, groupNames)
else:
groupNames = groupNames.upper()
if 'groups' in communityInfo:
for gp in communityInfo['groups']:
if str(gp['title']).upper() in groupNames:
group_ids.append(gp['id'])
del communityInfo
return group_ids
|
[
"def",
"getGroupIDs",
"(",
"self",
",",
"groupNames",
",",
"communityInfo",
"=",
"None",
")",
":",
"group_ids",
"=",
"[",
"]",
"if",
"communityInfo",
"is",
"None",
":",
"communityInfo",
"=",
"self",
".",
"communitySelf",
"if",
"isinstance",
"(",
"groupNames",
",",
"list",
")",
":",
"groupNames",
"=",
"map",
"(",
"str",
".",
"upper",
",",
"groupNames",
")",
"else",
":",
"groupNames",
"=",
"groupNames",
".",
"upper",
"(",
")",
"if",
"'groups'",
"in",
"communityInfo",
":",
"for",
"gp",
"in",
"communityInfo",
"[",
"'groups'",
"]",
":",
"if",
"str",
"(",
"gp",
"[",
"'title'",
"]",
")",
".",
"upper",
"(",
")",
"in",
"groupNames",
":",
"group_ids",
".",
"append",
"(",
"gp",
"[",
"'id'",
"]",
")",
"del",
"communityInfo",
"return",
"group_ids"
] |
This function retrieves the group IDs
Inputs:
group_names - tuple of group names
Output:
dict - list of group IDs
|
[
"This",
"function",
"retrieves",
"the",
"group",
"IDs"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L119-L143
|
12,952
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Community.groups
|
def groups(self):
""" returns the group object """
return Groups(url="%s/groups" % self.root,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initalize=False)
|
python
|
def groups(self):
""" returns the group object """
return Groups(url="%s/groups" % self.root,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initalize=False)
|
[
"def",
"groups",
"(",
"self",
")",
":",
"return",
"Groups",
"(",
"url",
"=",
"\"%s/groups\"",
"%",
"self",
".",
"root",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initalize",
"=",
"False",
")"
] |
returns the group object
|
[
"returns",
"the",
"group",
"object"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L250-L256
|
12,953
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Groups.group
|
def group(self, groupId):
"""
gets a group based on it's ID
"""
url = "%s/%s" % (self.root, groupId)
return Group(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initalize=False)
|
python
|
def group(self, groupId):
"""
gets a group based on it's ID
"""
url = "%s/%s" % (self.root, groupId)
return Group(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initalize=False)
|
[
"def",
"group",
"(",
"self",
",",
"groupId",
")",
":",
"url",
"=",
"\"%s/%s\"",
"%",
"(",
"self",
".",
"root",
",",
"groupId",
")",
"return",
"Group",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initalize",
"=",
"False",
")"
] |
gets a group based on it's ID
|
[
"gets",
"a",
"group",
"based",
"on",
"it",
"s",
"ID"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L399-L408
|
12,954
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Group.invite
|
def invite(self, users, role, expiration=1440):
"""
A group administrator can invite users to join their group using
the Invite to Group operation. This creates a new user invitation,
which the users accept or decline. The role of the user and the
invitation expiration date can be set in the invitation.
A notification is created for the user indicating that they were
invited to join the group. Available only to authenticated users.
Inputs:
users - A comma separated list of usernames to be invited to the
group. If a user is already a member of the group or an
invitation has already been sent, the call still returns
a success.
Example: users=regularusername1,regularusername2
role - Allows administrators to set the user's role in the group
Roles are:
group_member: Ability to view and share items with
group.
group_admin: In addition to viewing and sharing items,
the group_admin has the same capabilities
as the group owner-invite users to the
group, accept or decline group
applications, delete content, and remove
users.
expiration - Expiration date on the invitation can be set for
one day, three days, one week, or two weeks, in
minutes. Default is 1440
"""
params = {
"f" : "json",
"users" : users,
"role" : role,
"expiration" : expiration
}
return self._post(url=self._url + "/invite",
securityHandler=self._securityHandler,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def invite(self, users, role, expiration=1440):
"""
A group administrator can invite users to join their group using
the Invite to Group operation. This creates a new user invitation,
which the users accept or decline. The role of the user and the
invitation expiration date can be set in the invitation.
A notification is created for the user indicating that they were
invited to join the group. Available only to authenticated users.
Inputs:
users - A comma separated list of usernames to be invited to the
group. If a user is already a member of the group or an
invitation has already been sent, the call still returns
a success.
Example: users=regularusername1,regularusername2
role - Allows administrators to set the user's role in the group
Roles are:
group_member: Ability to view and share items with
group.
group_admin: In addition to viewing and sharing items,
the group_admin has the same capabilities
as the group owner-invite users to the
group, accept or decline group
applications, delete content, and remove
users.
expiration - Expiration date on the invitation can be set for
one day, three days, one week, or two weeks, in
minutes. Default is 1440
"""
params = {
"f" : "json",
"users" : users,
"role" : role,
"expiration" : expiration
}
return self._post(url=self._url + "/invite",
securityHandler=self._securityHandler,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"invite",
"(",
"self",
",",
"users",
",",
"role",
",",
"expiration",
"=",
"1440",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"users\"",
":",
"users",
",",
"\"role\"",
":",
"role",
",",
"\"expiration\"",
":",
"expiration",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/invite\"",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
A group administrator can invite users to join their group using
the Invite to Group operation. This creates a new user invitation,
which the users accept or decline. The role of the user and the
invitation expiration date can be set in the invitation.
A notification is created for the user indicating that they were
invited to join the group. Available only to authenticated users.
Inputs:
users - A comma separated list of usernames to be invited to the
group. If a user is already a member of the group or an
invitation has already been sent, the call still returns
a success.
Example: users=regularusername1,regularusername2
role - Allows administrators to set the user's role in the group
Roles are:
group_member: Ability to view and share items with
group.
group_admin: In addition to viewing and sharing items,
the group_admin has the same capabilities
as the group owner-invite users to the
group, accept or decline group
applications, delete content, and remove
users.
expiration - Expiration date on the invitation can be set for
one day, three days, one week, or two weeks, in
minutes. Default is 1440
|
[
"A",
"group",
"administrator",
"can",
"invite",
"users",
"to",
"join",
"their",
"group",
"using",
"the",
"Invite",
"to",
"Group",
"operation",
".",
"This",
"creates",
"a",
"new",
"user",
"invitation",
"which",
"the",
"users",
"accept",
"or",
"decline",
".",
"The",
"role",
"of",
"the",
"user",
"and",
"the",
"invitation",
"expiration",
"date",
"can",
"be",
"set",
"in",
"the",
"invitation",
".",
"A",
"notification",
"is",
"created",
"for",
"the",
"user",
"indicating",
"that",
"they",
"were",
"invited",
"to",
"join",
"the",
"group",
".",
"Available",
"only",
"to",
"authenticated",
"users",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L861-L900
|
12,955
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Group.applications
|
def applications(self):
"""returns all the group applications to join"""
url = self._url + "/applications"
params = {"f" : "json"}
res = self._get(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
items = []
if "applications" in res.keys():
for apps in res['applications']:
items.append(
self.Application(url="%s/%s" % (self._url, apps['username']),
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
)
return items
|
python
|
def applications(self):
"""returns all the group applications to join"""
url = self._url + "/applications"
params = {"f" : "json"}
res = self._get(url=url,
param_dict=params,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
items = []
if "applications" in res.keys():
for apps in res['applications']:
items.append(
self.Application(url="%s/%s" % (self._url, apps['username']),
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
)
return items
|
[
"def",
"applications",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/applications\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"res",
"=",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"items",
"=",
"[",
"]",
"if",
"\"applications\"",
"in",
"res",
".",
"keys",
"(",
")",
":",
"for",
"apps",
"in",
"res",
"[",
"'applications'",
"]",
":",
"items",
".",
"append",
"(",
"self",
".",
"Application",
"(",
"url",
"=",
"\"%s/%s\"",
"%",
"(",
"self",
".",
"_url",
",",
"apps",
"[",
"'username'",
"]",
")",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
")",
"return",
"items"
] |
returns all the group applications to join
|
[
"returns",
"all",
"the",
"group",
"applications",
"to",
"join"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L987-L1004
|
12,956
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Users.search
|
def search(self,
q,
start=1,
num=10,
sortField="username",
sortOrder="asc"):
"""
The User Search operation searches for users in the portal. The
search index is updated whenever users are created, updated, or
deleted. There can be a lag between the time that the user is
updated and the time when it's reflected in the search results. The
results only contain users that the calling user has permissions to
see. Users can control this visibility by changing the access
property of their user.
Inputs:
q -The query string to search the users against.
start - The number of the first entry in the result set response.
The index number is 1-based. The default value of start is
1 (for example, the first search result). The start
parameter, along with the num parameter can be used to
paginate the search results.
num - The maximum number of results to be included in the result
set response. The default value is 10, and the maximum
allowed value is 100. The start parameter, along with the num
parameter can be used to paginate the search results. The
actual number of returned results may be less than num. This
happens when the number of results remaining after start is
less than num.
sortField - Field to sort by. The allowed field names are username
and created.
sortOrder - Describes whether the returned results are in ascending
or descending order. Default is ascending.
Values: asc | desc
"""
params = {
"f" : "json",
"q" : q,
"start" : start,
"num" : num,
"sortField" : sortField,
"sortOrder" : sortOrder
}
url = self._url
return self._get(
url = url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def search(self,
q,
start=1,
num=10,
sortField="username",
sortOrder="asc"):
"""
The User Search operation searches for users in the portal. The
search index is updated whenever users are created, updated, or
deleted. There can be a lag between the time that the user is
updated and the time when it's reflected in the search results. The
results only contain users that the calling user has permissions to
see. Users can control this visibility by changing the access
property of their user.
Inputs:
q -The query string to search the users against.
start - The number of the first entry in the result set response.
The index number is 1-based. The default value of start is
1 (for example, the first search result). The start
parameter, along with the num parameter can be used to
paginate the search results.
num - The maximum number of results to be included in the result
set response. The default value is 10, and the maximum
allowed value is 100. The start parameter, along with the num
parameter can be used to paginate the search results. The
actual number of returned results may be less than num. This
happens when the number of results remaining after start is
less than num.
sortField - Field to sort by. The allowed field names are username
and created.
sortOrder - Describes whether the returned results are in ascending
or descending order. Default is ascending.
Values: asc | desc
"""
params = {
"f" : "json",
"q" : q,
"start" : start,
"num" : num,
"sortField" : sortField,
"sortOrder" : sortOrder
}
url = self._url
return self._get(
url = url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"search",
"(",
"self",
",",
"q",
",",
"start",
"=",
"1",
",",
"num",
"=",
"10",
",",
"sortField",
"=",
"\"username\"",
",",
"sortOrder",
"=",
"\"asc\"",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"q\"",
":",
"q",
",",
"\"start\"",
":",
"start",
",",
"\"num\"",
":",
"num",
",",
"\"sortField\"",
":",
"sortField",
",",
"\"sortOrder\"",
":",
"sortOrder",
"}",
"url",
"=",
"self",
".",
"_url",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
The User Search operation searches for users in the portal. The
search index is updated whenever users are created, updated, or
deleted. There can be a lag between the time that the user is
updated and the time when it's reflected in the search results. The
results only contain users that the calling user has permissions to
see. Users can control this visibility by changing the access
property of their user.
Inputs:
q -The query string to search the users against.
start - The number of the first entry in the result set response.
The index number is 1-based. The default value of start is
1 (for example, the first search result). The start
parameter, along with the num parameter can be used to
paginate the search results.
num - The maximum number of results to be included in the result
set response. The default value is 10, and the maximum
allowed value is 100. The start parameter, along with the num
parameter can be used to paginate the search results. The
actual number of returned results may be less than num. This
happens when the number of results remaining after start is
less than num.
sortField - Field to sort by. The allowed field names are username
and created.
sortOrder - Describes whether the returned results are in ascending
or descending order. Default is ascending.
Values: asc | desc
|
[
"The",
"User",
"Search",
"operation",
"searches",
"for",
"users",
"in",
"the",
"portal",
".",
"The",
"search",
"index",
"is",
"updated",
"whenever",
"users",
"are",
"created",
"updated",
"or",
"deleted",
".",
"There",
"can",
"be",
"a",
"lag",
"between",
"the",
"time",
"that",
"the",
"user",
"is",
"updated",
"and",
"the",
"time",
"when",
"it",
"s",
"reflected",
"in",
"the",
"search",
"results",
".",
"The",
"results",
"only",
"contain",
"users",
"that",
"the",
"calling",
"user",
"has",
"permissions",
"to",
"see",
".",
"Users",
"can",
"control",
"this",
"visibility",
"by",
"changing",
"the",
"access",
"property",
"of",
"their",
"user",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L1157-L1206
|
12,957
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Users.__getUsername
|
def __getUsername(self):
"""tries to parse the user name from various objects"""
if self._securityHandler is not None and \
not self._securityHandler._username is None:
return self._securityHandler._username
elif self._securityHandler is not None and \
hasattr(self._securityHandler, "org_url") and \
self._securityHandler.org_url is not None:
from .administration import Administration
user = Administration(url=self._securityHandler.org_url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port).portals.portalSelf.user
return user['username']
else:
from .administration import Administration
url = self._url.lower().split('/content/')[0]
user = Administration(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port).portals.portalSelf.user
return user['username']
|
python
|
def __getUsername(self):
"""tries to parse the user name from various objects"""
if self._securityHandler is not None and \
not self._securityHandler._username is None:
return self._securityHandler._username
elif self._securityHandler is not None and \
hasattr(self._securityHandler, "org_url") and \
self._securityHandler.org_url is not None:
from .administration import Administration
user = Administration(url=self._securityHandler.org_url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port).portals.portalSelf.user
return user['username']
else:
from .administration import Administration
url = self._url.lower().split('/content/')[0]
user = Administration(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port).portals.portalSelf.user
return user['username']
|
[
"def",
"__getUsername",
"(",
"self",
")",
":",
"if",
"self",
".",
"_securityHandler",
"is",
"not",
"None",
"and",
"not",
"self",
".",
"_securityHandler",
".",
"_username",
"is",
"None",
":",
"return",
"self",
".",
"_securityHandler",
".",
"_username",
"elif",
"self",
".",
"_securityHandler",
"is",
"not",
"None",
"and",
"hasattr",
"(",
"self",
".",
"_securityHandler",
",",
"\"org_url\"",
")",
"and",
"self",
".",
"_securityHandler",
".",
"org_url",
"is",
"not",
"None",
":",
"from",
".",
"administration",
"import",
"Administration",
"user",
"=",
"Administration",
"(",
"url",
"=",
"self",
".",
"_securityHandler",
".",
"org_url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
".",
"portals",
".",
"portalSelf",
".",
"user",
"return",
"user",
"[",
"'username'",
"]",
"else",
":",
"from",
".",
"administration",
"import",
"Administration",
"url",
"=",
"self",
".",
"_url",
".",
"lower",
"(",
")",
".",
"split",
"(",
"'/content/'",
")",
"[",
"0",
"]",
"user",
"=",
"Administration",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
".",
"portals",
".",
"portalSelf",
".",
"user",
"return",
"user",
"[",
"'username'",
"]"
] |
tries to parse the user name from various objects
|
[
"tries",
"to",
"parse",
"the",
"user",
"name",
"from",
"various",
"objects"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L1208-L1230
|
12,958
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Users.user
|
def user(self, username=None):
"""A user resource that represents a registered user in the portal."""
if username is None:
username = self.__getUsername()
parsedUsername = urlparse.quote(username)
url = self.root + "/%s" % parsedUsername
return User(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=False)
|
python
|
def user(self, username=None):
"""A user resource that represents a registered user in the portal."""
if username is None:
username = self.__getUsername()
parsedUsername = urlparse.quote(username)
url = self.root + "/%s" % parsedUsername
return User(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=False)
|
[
"def",
"user",
"(",
"self",
",",
"username",
"=",
"None",
")",
":",
"if",
"username",
"is",
"None",
":",
"username",
"=",
"self",
".",
"__getUsername",
"(",
")",
"parsedUsername",
"=",
"urlparse",
".",
"quote",
"(",
"username",
")",
"url",
"=",
"self",
".",
"root",
"+",
"\"/%s\"",
"%",
"parsedUsername",
"return",
"User",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"False",
")"
] |
A user resource that represents a registered user in the portal.
|
[
"A",
"user",
"resource",
"that",
"represents",
"a",
"registered",
"user",
"in",
"the",
"portal",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L1233-L1243
|
12,959
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
User.userContent
|
def userContent(self):
"""allows access into the individual user's content to get at the
items owned by the current user"""
replace_start = self._url.lower().find("/community/")
len_replace = len("/community/")
url = self._url.replace(self._url[replace_start:replace_start+len_replace],
'/content/')
from ._content import User as UserContent
return UserContent(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def userContent(self):
"""allows access into the individual user's content to get at the
items owned by the current user"""
replace_start = self._url.lower().find("/community/")
len_replace = len("/community/")
url = self._url.replace(self._url[replace_start:replace_start+len_replace],
'/content/')
from ._content import User as UserContent
return UserContent(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"userContent",
"(",
"self",
")",
":",
"replace_start",
"=",
"self",
".",
"_url",
".",
"lower",
"(",
")",
".",
"find",
"(",
"\"/community/\"",
")",
"len_replace",
"=",
"len",
"(",
"\"/community/\"",
")",
"url",
"=",
"self",
".",
"_url",
".",
"replace",
"(",
"self",
".",
"_url",
"[",
"replace_start",
":",
"replace_start",
"+",
"len_replace",
"]",
",",
"'/content/'",
")",
"from",
".",
"_content",
"import",
"User",
"as",
"UserContent",
"return",
"UserContent",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
allows access into the individual user's content to get at the
items owned by the current user
|
[
"allows",
"access",
"into",
"the",
"individual",
"user",
"s",
"content",
"to",
"get",
"at",
"the",
"items",
"owned",
"by",
"the",
"current",
"user"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L1348-L1359
|
12,960
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
User.invitations
|
def invitations(self):
"""returns a class to access the current user's invitations"""
url = "%s/invitations" % self.root
return Invitations(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def invitations(self):
"""returns a class to access the current user's invitations"""
url = "%s/invitations" % self.root
return Invitations(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"invitations",
"(",
"self",
")",
":",
"url",
"=",
"\"%s/invitations\"",
"%",
"self",
".",
"root",
"return",
"Invitations",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
returns a class to access the current user's invitations
|
[
"returns",
"a",
"class",
"to",
"access",
"the",
"current",
"user",
"s",
"invitations"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L1634-L1640
|
12,961
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
User.notifications
|
def notifications(self):
"""The notifications that are available for the given user.
Notifications are events that need the user's attention-application
for joining a group administered by the user, acceptance of a group
membership application, and so on. A notification is initially
marked as new. The user can mark it as read or delete the notification.
"""
params = {"f": "json"}
url = "%s/notifications" % self.root
return Notifications(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def notifications(self):
"""The notifications that are available for the given user.
Notifications are events that need the user's attention-application
for joining a group administered by the user, acceptance of a group
membership application, and so on. A notification is initially
marked as new. The user can mark it as read or delete the notification.
"""
params = {"f": "json"}
url = "%s/notifications" % self.root
return Notifications(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"notifications",
"(",
"self",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"url",
"=",
"\"%s/notifications\"",
"%",
"self",
".",
"root",
"return",
"Notifications",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
The notifications that are available for the given user.
Notifications are events that need the user's attention-application
for joining a group administered by the user, acceptance of a group
membership application, and so on. A notification is initially
marked as new. The user can mark it as read or delete the notification.
|
[
"The",
"notifications",
"that",
"are",
"available",
"for",
"the",
"given",
"user",
".",
"Notifications",
"are",
"events",
"that",
"need",
"the",
"user",
"s",
"attention",
"-",
"application",
"for",
"joining",
"a",
"group",
"administered",
"by",
"the",
"user",
"acceptance",
"of",
"a",
"group",
"membership",
"application",
"and",
"so",
"on",
".",
"A",
"notification",
"is",
"initially",
"marked",
"as",
"new",
".",
"The",
"user",
"can",
"mark",
"it",
"as",
"read",
"or",
"delete",
"the",
"notification",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L1643-L1655
|
12,962
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
User.resetPassword
|
def resetPassword(self, email=True):
"""
resets a users password for an account. The password will be randomly
generated and emailed by the system.
Input:
email - boolean that an email password will be sent to the
user's profile email address. The default is True.
"""
url = self.root + "/reset"
params = {
"f" : "json",
"email" : email
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def resetPassword(self, email=True):
"""
resets a users password for an account. The password will be randomly
generated and emailed by the system.
Input:
email - boolean that an email password will be sent to the
user's profile email address. The default is True.
"""
url = self.root + "/reset"
params = {
"f" : "json",
"email" : email
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"resetPassword",
"(",
"self",
",",
"email",
"=",
"True",
")",
":",
"url",
"=",
"self",
".",
"root",
"+",
"\"/reset\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"email\"",
":",
"email",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
resets a users password for an account. The password will be randomly
generated and emailed by the system.
Input:
email - boolean that an email password will be sent to the
user's profile email address. The default is True.
|
[
"resets",
"a",
"users",
"password",
"for",
"an",
"account",
".",
"The",
"password",
"will",
"be",
"randomly",
"generated",
"and",
"emailed",
"by",
"the",
"system",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L1692-L1711
|
12,963
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
User.expirePassword
|
def expirePassword(self,
hours="now"):
"""sets a time when a user must reset their password"""
params = {
"f" : "json"
}
expiration = -1
if isinstance(hours, str):
if expiration == "now":
expiration = -1
elif expiration == "never":
expiration = 0
else:
expiration = -1
elif isinstance(expiration, (int, long)):
dt = datetime.now() + timedelta(hours=hours)
expiration = local_time_to_online(dt=dt)
else:
expiration = -1
params['expiration'] = expiration
url = "%s/expirePassword" % self.root
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def expirePassword(self,
hours="now"):
"""sets a time when a user must reset their password"""
params = {
"f" : "json"
}
expiration = -1
if isinstance(hours, str):
if expiration == "now":
expiration = -1
elif expiration == "never":
expiration = 0
else:
expiration = -1
elif isinstance(expiration, (int, long)):
dt = datetime.now() + timedelta(hours=hours)
expiration = local_time_to_online(dt=dt)
else:
expiration = -1
params['expiration'] = expiration
url = "%s/expirePassword" % self.root
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"expirePassword",
"(",
"self",
",",
"hours",
"=",
"\"now\"",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"expiration",
"=",
"-",
"1",
"if",
"isinstance",
"(",
"hours",
",",
"str",
")",
":",
"if",
"expiration",
"==",
"\"now\"",
":",
"expiration",
"=",
"-",
"1",
"elif",
"expiration",
"==",
"\"never\"",
":",
"expiration",
"=",
"0",
"else",
":",
"expiration",
"=",
"-",
"1",
"elif",
"isinstance",
"(",
"expiration",
",",
"(",
"int",
",",
"long",
")",
")",
":",
"dt",
"=",
"datetime",
".",
"now",
"(",
")",
"+",
"timedelta",
"(",
"hours",
"=",
"hours",
")",
"expiration",
"=",
"local_time_to_online",
"(",
"dt",
"=",
"dt",
")",
"else",
":",
"expiration",
"=",
"-",
"1",
"params",
"[",
"'expiration'",
"]",
"=",
"expiration",
"url",
"=",
"\"%s/expirePassword\"",
"%",
"self",
".",
"root",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
sets a time when a user must reset their password
|
[
"sets",
"a",
"time",
"when",
"a",
"user",
"must",
"reset",
"their",
"password"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L1713-L1739
|
12,964
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Invitations.userInvitations
|
def userInvitations(self):
"""gets all user invitations"""
self.__init()
items = []
for n in self._userInvitations:
if "id" in n:
url = "%s/%s" % (self.root, n['id'])
items.append(self.Invitation(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True))
return items
|
python
|
def userInvitations(self):
"""gets all user invitations"""
self.__init()
items = []
for n in self._userInvitations:
if "id" in n:
url = "%s/%s" % (self.root, n['id'])
items.append(self.Invitation(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True))
return items
|
[
"def",
"userInvitations",
"(",
"self",
")",
":",
"self",
".",
"__init",
"(",
")",
"items",
"=",
"[",
"]",
"for",
"n",
"in",
"self",
".",
"_userInvitations",
":",
"if",
"\"id\"",
"in",
"n",
":",
"url",
"=",
"\"%s/%s\"",
"%",
"(",
"self",
".",
"root",
",",
"n",
"[",
"'id'",
"]",
")",
"items",
".",
"append",
"(",
"self",
".",
"Invitation",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
")",
"return",
"items"
] |
gets all user invitations
|
[
"gets",
"all",
"user",
"invitations"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L2169-L2181
|
12,965
|
Esri/ArcREST
|
src/arcrest/manageorg/_community.py
|
Notifications.notifications
|
def notifications(self):
"""gets the user's notifications"""
self.__init()
items = []
for n in self._notifications:
if "id" in n:
url = "%s/%s" % (self.root, n['id'])
items.append(self.Notification(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port))
return items
|
python
|
def notifications(self):
"""gets the user's notifications"""
self.__init()
items = []
for n in self._notifications:
if "id" in n:
url = "%s/%s" % (self.root, n['id'])
items.append(self.Notification(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port))
return items
|
[
"def",
"notifications",
"(",
"self",
")",
":",
"self",
".",
"__init",
"(",
")",
"items",
"=",
"[",
"]",
"for",
"n",
"in",
"self",
".",
"_notifications",
":",
"if",
"\"id\"",
"in",
"n",
":",
"url",
"=",
"\"%s/%s\"",
"%",
"(",
"self",
".",
"root",
",",
"n",
"[",
"'id'",
"]",
")",
"items",
".",
"append",
"(",
"self",
".",
"Notification",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
")",
"return",
"items"
] |
gets the user's notifications
|
[
"gets",
"the",
"user",
"s",
"notifications"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageorg/_community.py#L2378-L2389
|
12,966
|
Esri/ArcREST
|
src/arcrest/common/filters.py
|
StatisticFilter.add
|
def add(self, statisticType, onStatisticField, outStatisticFieldName=None):
"""
Adds the statistics group to the filter.
outStatistics - is supported on only those layers/tables that
indicate supportsStatistics is true.
outStatisticFieldName is empty or missing, the map server assigns a
field name to the returned statistic field. A valid field name
can only contain alphanumeric characters and an underscore.
outStatisticFieldName is a reserved keyword of the underlying DBMS,
the operation can fail. Try specifying an alternative
outStatisticFieldName. When using outStatistics, the only other
parameters that can be used are groupByFieldsForStatistics,
orderByFields, time, and where.
"""
val = {
"statisticType" : statisticType,
"onStatisticField" : onStatisticField,
"outStatisticFieldName" : outStatisticFieldName
}
if outStatisticFieldName is None:
del val['outStatisticFieldName']
self._array.append(val)
|
python
|
def add(self, statisticType, onStatisticField, outStatisticFieldName=None):
"""
Adds the statistics group to the filter.
outStatistics - is supported on only those layers/tables that
indicate supportsStatistics is true.
outStatisticFieldName is empty or missing, the map server assigns a
field name to the returned statistic field. A valid field name
can only contain alphanumeric characters and an underscore.
outStatisticFieldName is a reserved keyword of the underlying DBMS,
the operation can fail. Try specifying an alternative
outStatisticFieldName. When using outStatistics, the only other
parameters that can be used are groupByFieldsForStatistics,
orderByFields, time, and where.
"""
val = {
"statisticType" : statisticType,
"onStatisticField" : onStatisticField,
"outStatisticFieldName" : outStatisticFieldName
}
if outStatisticFieldName is None:
del val['outStatisticFieldName']
self._array.append(val)
|
[
"def",
"add",
"(",
"self",
",",
"statisticType",
",",
"onStatisticField",
",",
"outStatisticFieldName",
"=",
"None",
")",
":",
"val",
"=",
"{",
"\"statisticType\"",
":",
"statisticType",
",",
"\"onStatisticField\"",
":",
"onStatisticField",
",",
"\"outStatisticFieldName\"",
":",
"outStatisticFieldName",
"}",
"if",
"outStatisticFieldName",
"is",
"None",
":",
"del",
"val",
"[",
"'outStatisticFieldName'",
"]",
"self",
".",
"_array",
".",
"append",
"(",
"val",
")"
] |
Adds the statistics group to the filter.
outStatistics - is supported on only those layers/tables that
indicate supportsStatistics is true.
outStatisticFieldName is empty or missing, the map server assigns a
field name to the returned statistic field. A valid field name
can only contain alphanumeric characters and an underscore.
outStatisticFieldName is a reserved keyword of the underlying DBMS,
the operation can fail. Try specifying an alternative
outStatisticFieldName. When using outStatistics, the only other
parameters that can be used are groupByFieldsForStatistics,
orderByFields, time, and where.
|
[
"Adds",
"the",
"statistics",
"group",
"to",
"the",
"filter",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/common/filters.py#L24-L46
|
12,967
|
Esri/ArcREST
|
src/arcrest/common/filters.py
|
LayerDefinitionFilter.addFilter
|
def addFilter(self, layer_id, where=None, outFields="*"):
""" adds a layer definition filter """
import copy
f = copy.deepcopy(self._filterTemplate)
f['layerId'] = layer_id
f['outFields'] = outFields
if where is not None:
f['where'] = where
if f not in self._filter:
self._filter.append(f)
|
python
|
def addFilter(self, layer_id, where=None, outFields="*"):
""" adds a layer definition filter """
import copy
f = copy.deepcopy(self._filterTemplate)
f['layerId'] = layer_id
f['outFields'] = outFields
if where is not None:
f['where'] = where
if f not in self._filter:
self._filter.append(f)
|
[
"def",
"addFilter",
"(",
"self",
",",
"layer_id",
",",
"where",
"=",
"None",
",",
"outFields",
"=",
"\"*\"",
")",
":",
"import",
"copy",
"f",
"=",
"copy",
".",
"deepcopy",
"(",
"self",
".",
"_filterTemplate",
")",
"f",
"[",
"'layerId'",
"]",
"=",
"layer_id",
"f",
"[",
"'outFields'",
"]",
"=",
"outFields",
"if",
"where",
"is",
"not",
"None",
":",
"f",
"[",
"'where'",
"]",
"=",
"where",
"if",
"f",
"not",
"in",
"self",
".",
"_filter",
":",
"self",
".",
"_filter",
".",
"append",
"(",
"f",
")"
] |
adds a layer definition filter
|
[
"adds",
"a",
"layer",
"definition",
"filter"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/common/filters.py#L76-L85
|
12,968
|
Esri/ArcREST
|
src/arcrest/common/filters.py
|
LayerDefinitionFilter.removeFilter
|
def removeFilter(self, filter_index):
""" removes a layer filter based on position in filter list """
f = self._filter[filter_index]
self._filter.remove(f)
|
python
|
def removeFilter(self, filter_index):
""" removes a layer filter based on position in filter list """
f = self._filter[filter_index]
self._filter.remove(f)
|
[
"def",
"removeFilter",
"(",
"self",
",",
"filter_index",
")",
":",
"f",
"=",
"self",
".",
"_filter",
"[",
"filter_index",
"]",
"self",
".",
"_filter",
".",
"remove",
"(",
"f",
")"
] |
removes a layer filter based on position in filter list
|
[
"removes",
"a",
"layer",
"filter",
"based",
"on",
"position",
"in",
"filter",
"list"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/common/filters.py#L87-L90
|
12,969
|
Esri/ArcREST
|
src/arcrest/common/filters.py
|
GeometryFilter.geometry
|
def geometry(self, geometry):
""" sets the geometry value """
if isinstance(geometry, AbstractGeometry):
self._geomObject = geometry
self._geomType = geometry.type
elif arcpyFound :
wkid = None
wkt = None
if (hasattr(geometry, 'spatialReference') and \
geometry.spatialReference is not None):
if (hasattr(geometry.spatialReference, 'factoryCode') and \
geometry.spatialReference.factoryCode is not None):
wkid = geometry.spatialReference.factoryCode
else:
wkt = geometry.spatialReference.exportToString()
if isinstance(geometry, arcpy.Polygon):
self._geomObject = Polygon(geometry, wkid=wkid, wkt=wkt)
self._geomType = "esriGeometryPolygon"
elif isinstance(geometry, arcpy.Point):
self._geomObject = Point(geometry, wkid=wkid, wkt=wkt)
self._geomType = "esriGeometryPoint"
elif isinstance(geometry, arcpy.Polyline):
self._geomObject = Polyline(geometry, wkid=wkid, wkt=wkt)
self._geomType = "esriGeometryPolyline"
elif isinstance(geometry, arcpy.Multipoint):
self._geomObject = MultiPoint(geometry, wkid=wkid, wkt=wkt)
self._geomType = "esriGeometryMultipoint"
else:
raise AttributeError("geometry must be a common.Geometry or arcpy.Geometry type.")
else:
raise AttributeError("geometry must be a common.Geometry or arcpy.Geometry type.")
|
python
|
def geometry(self, geometry):
""" sets the geometry value """
if isinstance(geometry, AbstractGeometry):
self._geomObject = geometry
self._geomType = geometry.type
elif arcpyFound :
wkid = None
wkt = None
if (hasattr(geometry, 'spatialReference') and \
geometry.spatialReference is not None):
if (hasattr(geometry.spatialReference, 'factoryCode') and \
geometry.spatialReference.factoryCode is not None):
wkid = geometry.spatialReference.factoryCode
else:
wkt = geometry.spatialReference.exportToString()
if isinstance(geometry, arcpy.Polygon):
self._geomObject = Polygon(geometry, wkid=wkid, wkt=wkt)
self._geomType = "esriGeometryPolygon"
elif isinstance(geometry, arcpy.Point):
self._geomObject = Point(geometry, wkid=wkid, wkt=wkt)
self._geomType = "esriGeometryPoint"
elif isinstance(geometry, arcpy.Polyline):
self._geomObject = Polyline(geometry, wkid=wkid, wkt=wkt)
self._geomType = "esriGeometryPolyline"
elif isinstance(geometry, arcpy.Multipoint):
self._geomObject = MultiPoint(geometry, wkid=wkid, wkt=wkt)
self._geomType = "esriGeometryMultipoint"
else:
raise AttributeError("geometry must be a common.Geometry or arcpy.Geometry type.")
else:
raise AttributeError("geometry must be a common.Geometry or arcpy.Geometry type.")
|
[
"def",
"geometry",
"(",
"self",
",",
"geometry",
")",
":",
"if",
"isinstance",
"(",
"geometry",
",",
"AbstractGeometry",
")",
":",
"self",
".",
"_geomObject",
"=",
"geometry",
"self",
".",
"_geomType",
"=",
"geometry",
".",
"type",
"elif",
"arcpyFound",
":",
"wkid",
"=",
"None",
"wkt",
"=",
"None",
"if",
"(",
"hasattr",
"(",
"geometry",
",",
"'spatialReference'",
")",
"and",
"geometry",
".",
"spatialReference",
"is",
"not",
"None",
")",
":",
"if",
"(",
"hasattr",
"(",
"geometry",
".",
"spatialReference",
",",
"'factoryCode'",
")",
"and",
"geometry",
".",
"spatialReference",
".",
"factoryCode",
"is",
"not",
"None",
")",
":",
"wkid",
"=",
"geometry",
".",
"spatialReference",
".",
"factoryCode",
"else",
":",
"wkt",
"=",
"geometry",
".",
"spatialReference",
".",
"exportToString",
"(",
")",
"if",
"isinstance",
"(",
"geometry",
",",
"arcpy",
".",
"Polygon",
")",
":",
"self",
".",
"_geomObject",
"=",
"Polygon",
"(",
"geometry",
",",
"wkid",
"=",
"wkid",
",",
"wkt",
"=",
"wkt",
")",
"self",
".",
"_geomType",
"=",
"\"esriGeometryPolygon\"",
"elif",
"isinstance",
"(",
"geometry",
",",
"arcpy",
".",
"Point",
")",
":",
"self",
".",
"_geomObject",
"=",
"Point",
"(",
"geometry",
",",
"wkid",
"=",
"wkid",
",",
"wkt",
"=",
"wkt",
")",
"self",
".",
"_geomType",
"=",
"\"esriGeometryPoint\"",
"elif",
"isinstance",
"(",
"geometry",
",",
"arcpy",
".",
"Polyline",
")",
":",
"self",
".",
"_geomObject",
"=",
"Polyline",
"(",
"geometry",
",",
"wkid",
"=",
"wkid",
",",
"wkt",
"=",
"wkt",
")",
"self",
".",
"_geomType",
"=",
"\"esriGeometryPolyline\"",
"elif",
"isinstance",
"(",
"geometry",
",",
"arcpy",
".",
"Multipoint",
")",
":",
"self",
".",
"_geomObject",
"=",
"MultiPoint",
"(",
"geometry",
",",
"wkid",
"=",
"wkid",
",",
"wkt",
"=",
"wkt",
")",
"self",
".",
"_geomType",
"=",
"\"esriGeometryMultipoint\"",
"else",
":",
"raise",
"AttributeError",
"(",
"\"geometry must be a common.Geometry or arcpy.Geometry type.\"",
")",
"else",
":",
"raise",
"AttributeError",
"(",
"\"geometry must be a common.Geometry or arcpy.Geometry type.\"",
")"
] |
sets the geometry value
|
[
"sets",
"the",
"geometry",
"value"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/common/filters.py#L189-L222
|
12,970
|
Esri/ArcREST
|
src/arcrest/ags/_mobileservice.py
|
MobileService.layers
|
def layers(self):
"""gets the service layers"""
if self._layers is None:
self.__init()
lyrs = []
for lyr in self._layers:
url = self._url + "/%s" % lyr['id']
lyr['object'] = MobileServiceLayer(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=False)
return self._layers
|
python
|
def layers(self):
"""gets the service layers"""
if self._layers is None:
self.__init()
lyrs = []
for lyr in self._layers:
url = self._url + "/%s" % lyr['id']
lyr['object'] = MobileServiceLayer(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=False)
return self._layers
|
[
"def",
"layers",
"(",
"self",
")",
":",
"if",
"self",
".",
"_layers",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"lyrs",
"=",
"[",
"]",
"for",
"lyr",
"in",
"self",
".",
"_layers",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/%s\"",
"%",
"lyr",
"[",
"'id'",
"]",
"lyr",
"[",
"'object'",
"]",
"=",
"MobileServiceLayer",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"False",
")",
"return",
"self",
".",
"_layers"
] |
gets the service layers
|
[
"gets",
"the",
"service",
"layers"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_mobileservice.py#L346-L358
|
12,971
|
Esri/ArcREST
|
src/arcrest/manageags/_clusters.py
|
Cluster.clusters
|
def clusters(self):
"""returns the cluster object for each server"""
if self._clusters is not None:
self.__init()
Cs = []
for c in self._clusters:
url = self._url + "/%s" % c['clusterName']
Cs.append(Cluster(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True))
self._clusters = Cs
return self._clusters
|
python
|
def clusters(self):
"""returns the cluster object for each server"""
if self._clusters is not None:
self.__init()
Cs = []
for c in self._clusters:
url = self._url + "/%s" % c['clusterName']
Cs.append(Cluster(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=True))
self._clusters = Cs
return self._clusters
|
[
"def",
"clusters",
"(",
"self",
")",
":",
"if",
"self",
".",
"_clusters",
"is",
"not",
"None",
":",
"self",
".",
"__init",
"(",
")",
"Cs",
"=",
"[",
"]",
"for",
"c",
"in",
"self",
".",
"_clusters",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/%s\"",
"%",
"c",
"[",
"'clusterName'",
"]",
"Cs",
".",
"append",
"(",
"Cluster",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"True",
")",
")",
"self",
".",
"_clusters",
"=",
"Cs",
"return",
"self",
".",
"_clusters"
] |
returns the cluster object for each server
|
[
"returns",
"the",
"cluster",
"object",
"for",
"each",
"server"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/_clusters.py#L184-L197
|
12,972
|
Esri/ArcREST
|
src/arcrest/manageags/_clusters.py
|
Cluster.editProtocol
|
def editProtocol(self, clusterProtocolObj):
"""
Updates the Cluster Protocol. This will cause the cluster to be
restarted with updated protocol configuration.
"""
if isinstance(clusterProtocolObj, ClusterProtocol): pass
else:
raise AttributeError("Invalid Input, must be a ClusterProtocal Object")
url = self._url + "/editProtocol"
params = {
"f" : "json",
"tcpClusterPort" : str(clusterProtocolObj.value['tcpClusterPort'])
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def editProtocol(self, clusterProtocolObj):
"""
Updates the Cluster Protocol. This will cause the cluster to be
restarted with updated protocol configuration.
"""
if isinstance(clusterProtocolObj, ClusterProtocol): pass
else:
raise AttributeError("Invalid Input, must be a ClusterProtocal Object")
url = self._url + "/editProtocol"
params = {
"f" : "json",
"tcpClusterPort" : str(clusterProtocolObj.value['tcpClusterPort'])
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"editProtocol",
"(",
"self",
",",
"clusterProtocolObj",
")",
":",
"if",
"isinstance",
"(",
"clusterProtocolObj",
",",
"ClusterProtocol",
")",
":",
"pass",
"else",
":",
"raise",
"AttributeError",
"(",
"\"Invalid Input, must be a ClusterProtocal Object\"",
")",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/editProtocol\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"tcpClusterPort\"",
":",
"str",
"(",
"clusterProtocolObj",
".",
"value",
"[",
"'tcpClusterPort'",
"]",
")",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
Updates the Cluster Protocol. This will cause the cluster to be
restarted with updated protocol configuration.
|
[
"Updates",
"the",
"Cluster",
"Protocol",
".",
"This",
"will",
"cause",
"the",
"cluster",
"to",
"be",
"restarted",
"with",
"updated",
"protocol",
"configuration",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/manageags/_clusters.py#L363-L380
|
12,973
|
Esri/ArcREST
|
src/arcrest/ags/_geoprocessing.py
|
GPTask.parameters
|
def parameters(self):
""" returns the default parameters """
if self._parameters is None:
self.__init()
for param in self._parameters:
if not isinstance(param['defaultValue'], BaseGPObject):
if param['dataType'] == "GPFeatureRecordSetLayer":
param['defaultValue'] = GPFeatureRecordSetLayer.fromJSON(json.dumps(param))
elif param['dataType'] == "GPString":
param['defaultValue'] = GPString.fromJSON(json.dumps(param))
elif param['dataType'] == "GPLong":
param['defaultValue'] = GPLong.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDouble":
param['defaultValue'] = GPDouble.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDate":
param['defaultValue'] = GPDate.fromJSON(json.dumps(param))
elif param['dataType'] == "GPBoolean":
param['defaultValue'] = GPBoolean.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDataFile":
param['defaultValue'] = GPDataFile.fromJSON(json.dumps(param))
elif param['dataType'] == "GPLinearUnit":
param['defaultValue'] = GPLinearUnit.fromJSON(json.dumps(param))
elif param['dataType'] == "GPMultiValue":
param['defaultValue'] = GPMultiValue.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRasterData":
param['defaultValue'] = GPRasterData.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRasterDataLayer":
param['defaultValue'] = GPRasterDataLayer.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRecordSet":
param['defaultValue'] = GPRecordSet.fromJSON(json.dumps(param))
return self._parameters
|
python
|
def parameters(self):
""" returns the default parameters """
if self._parameters is None:
self.__init()
for param in self._parameters:
if not isinstance(param['defaultValue'], BaseGPObject):
if param['dataType'] == "GPFeatureRecordSetLayer":
param['defaultValue'] = GPFeatureRecordSetLayer.fromJSON(json.dumps(param))
elif param['dataType'] == "GPString":
param['defaultValue'] = GPString.fromJSON(json.dumps(param))
elif param['dataType'] == "GPLong":
param['defaultValue'] = GPLong.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDouble":
param['defaultValue'] = GPDouble.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDate":
param['defaultValue'] = GPDate.fromJSON(json.dumps(param))
elif param['dataType'] == "GPBoolean":
param['defaultValue'] = GPBoolean.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDataFile":
param['defaultValue'] = GPDataFile.fromJSON(json.dumps(param))
elif param['dataType'] == "GPLinearUnit":
param['defaultValue'] = GPLinearUnit.fromJSON(json.dumps(param))
elif param['dataType'] == "GPMultiValue":
param['defaultValue'] = GPMultiValue.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRasterData":
param['defaultValue'] = GPRasterData.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRasterDataLayer":
param['defaultValue'] = GPRasterDataLayer.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRecordSet":
param['defaultValue'] = GPRecordSet.fromJSON(json.dumps(param))
return self._parameters
|
[
"def",
"parameters",
"(",
"self",
")",
":",
"if",
"self",
".",
"_parameters",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"for",
"param",
"in",
"self",
".",
"_parameters",
":",
"if",
"not",
"isinstance",
"(",
"param",
"[",
"'defaultValue'",
"]",
",",
"BaseGPObject",
")",
":",
"if",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPFeatureRecordSetLayer\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPFeatureRecordSetLayer",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPString\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPString",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPLong\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPLong",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPDouble\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPDouble",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPDate\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPDate",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPBoolean\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPBoolean",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPDataFile\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPDataFile",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPLinearUnit\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPLinearUnit",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPMultiValue\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPMultiValue",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPRasterData\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPRasterData",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPRasterDataLayer\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPRasterDataLayer",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPRecordSet\"",
":",
"param",
"[",
"'defaultValue'",
"]",
"=",
"GPRecordSet",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"return",
"self",
".",
"_parameters"
] |
returns the default parameters
|
[
"returns",
"the",
"default",
"parameters"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_geoprocessing.py#L228-L258
|
12,974
|
Esri/ArcREST
|
src/arcrest/ags/_geoprocessing.py
|
GPTask.getJob
|
def getJob(self, jobID):
""" returns the results or status of a job """
url = self._url + "/jobs/%s" % (jobID)
return GPJob(url=url,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def getJob(self, jobID):
""" returns the results or status of a job """
url = self._url + "/jobs/%s" % (jobID)
return GPJob(url=url,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"getJob",
"(",
"self",
",",
"jobID",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/jobs/%s\"",
"%",
"(",
"jobID",
")",
"return",
"GPJob",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
returns the results or status of a job
|
[
"returns",
"the",
"results",
"or",
"status",
"of",
"a",
"job"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_geoprocessing.py#L281-L287
|
12,975
|
Esri/ArcREST
|
src/arcrest/ags/_geoprocessing.py
|
GPTask.executeTask
|
def executeTask(self,
inputs,
outSR=None,
processSR=None,
returnZ=False,
returnM=False,
f="json",
method="POST"
):
"""
performs the execute task method
"""
params = {
"f" : f
}
url = self._url + "/execute"
params = { "f" : "json" }
if not outSR is None:
params['env:outSR'] = outSR
if not processSR is None:
params['end:processSR'] = processSR
params['returnZ'] = returnZ
params['returnM'] = returnM
for p in inputs:
if isinstance(p, BaseGPObject):
params[p.paramName] = p.value
del p
if method.lower() == "post":
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
else:
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def executeTask(self,
inputs,
outSR=None,
processSR=None,
returnZ=False,
returnM=False,
f="json",
method="POST"
):
"""
performs the execute task method
"""
params = {
"f" : f
}
url = self._url + "/execute"
params = { "f" : "json" }
if not outSR is None:
params['env:outSR'] = outSR
if not processSR is None:
params['end:processSR'] = processSR
params['returnZ'] = returnZ
params['returnM'] = returnM
for p in inputs:
if isinstance(p, BaseGPObject):
params[p.paramName] = p.value
del p
if method.lower() == "post":
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
else:
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"executeTask",
"(",
"self",
",",
"inputs",
",",
"outSR",
"=",
"None",
",",
"processSR",
"=",
"None",
",",
"returnZ",
"=",
"False",
",",
"returnM",
"=",
"False",
",",
"f",
"=",
"\"json\"",
",",
"method",
"=",
"\"POST\"",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"f",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/execute\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"if",
"not",
"outSR",
"is",
"None",
":",
"params",
"[",
"'env:outSR'",
"]",
"=",
"outSR",
"if",
"not",
"processSR",
"is",
"None",
":",
"params",
"[",
"'end:processSR'",
"]",
"=",
"processSR",
"params",
"[",
"'returnZ'",
"]",
"=",
"returnZ",
"params",
"[",
"'returnM'",
"]",
"=",
"returnM",
"for",
"p",
"in",
"inputs",
":",
"if",
"isinstance",
"(",
"p",
",",
"BaseGPObject",
")",
":",
"params",
"[",
"p",
".",
"paramName",
"]",
"=",
"p",
".",
"value",
"del",
"p",
"if",
"method",
".",
"lower",
"(",
")",
"==",
"\"post\"",
":",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"else",
":",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
performs the execute task method
|
[
"performs",
"the",
"execute",
"task",
"method"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_geoprocessing.py#L344-L382
|
12,976
|
Esri/ArcREST
|
src/arcrest/ags/_geoprocessing.py
|
GPJob._get_json
|
def _get_json(self, urlpart):
"""
gets the result object dictionary
"""
url = self._url + "/%s" % urlpart
params = {
"f" : "json",
}
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self.proxy_port)
|
python
|
def _get_json(self, urlpart):
"""
gets the result object dictionary
"""
url = self._url + "/%s" % urlpart
params = {
"f" : "json",
}
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self.proxy_port)
|
[
"def",
"_get_json",
"(",
"self",
",",
"urlpart",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/%s\"",
"%",
"urlpart",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"}",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"proxy_port",
")"
] |
gets the result object dictionary
|
[
"gets",
"the",
"result",
"object",
"dictionary"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_geoprocessing.py#L451-L464
|
12,977
|
Esri/ArcREST
|
src/arcrest/ags/_geoprocessing.py
|
GPJob.results
|
def results(self):
""" returns the results """
self.__init()
for k,v in self._results.items():
param = self._get_json(v['paramUrl'])
if param['dataType'] == "GPFeatureRecordSetLayer":
self._results[k] = GPFeatureRecordSetLayer.fromJSON(json.dumps(param))
elif param['dataType'].lower().find('gpmultivalue') > -1:
self._results[k] = GPMultiValue.fromJSON(json.dumps(param))
elif param['dataType'] == "GPString":
self._results[k] = GPString.fromJSON(json.dumps(param))
elif param['dataType'] == "GPLong":
self._results[k] = GPLong.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDouble":
self._results[k] = GPDouble.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDate":
self._results[k] = GPDate.fromJSON(json.dumps(param))
elif param['dataType'] == "GPBoolean":
self._results[k] = GPBoolean.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDataFile":
self._results[k] = GPDataFile.fromJSON(json.dumps(param))
elif param['dataType'] == "GPLinearUnit":
self._results[k] = GPLinearUnit.fromJSON(json.dumps(param))
elif param['dataType'] == "GPMultiValue":
self._results[k] = GPMultiValue.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRasterData":
self._results[k] = GPRasterData.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRasterDataLayer":
self._results[k] = GPRasterDataLayer.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRecordSet":
self._results[k] = GPRecordSet.fromJSON(json.dumps(param))
return self._results
|
python
|
def results(self):
""" returns the results """
self.__init()
for k,v in self._results.items():
param = self._get_json(v['paramUrl'])
if param['dataType'] == "GPFeatureRecordSetLayer":
self._results[k] = GPFeatureRecordSetLayer.fromJSON(json.dumps(param))
elif param['dataType'].lower().find('gpmultivalue') > -1:
self._results[k] = GPMultiValue.fromJSON(json.dumps(param))
elif param['dataType'] == "GPString":
self._results[k] = GPString.fromJSON(json.dumps(param))
elif param['dataType'] == "GPLong":
self._results[k] = GPLong.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDouble":
self._results[k] = GPDouble.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDate":
self._results[k] = GPDate.fromJSON(json.dumps(param))
elif param['dataType'] == "GPBoolean":
self._results[k] = GPBoolean.fromJSON(json.dumps(param))
elif param['dataType'] == "GPDataFile":
self._results[k] = GPDataFile.fromJSON(json.dumps(param))
elif param['dataType'] == "GPLinearUnit":
self._results[k] = GPLinearUnit.fromJSON(json.dumps(param))
elif param['dataType'] == "GPMultiValue":
self._results[k] = GPMultiValue.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRasterData":
self._results[k] = GPRasterData.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRasterDataLayer":
self._results[k] = GPRasterDataLayer.fromJSON(json.dumps(param))
elif param['dataType'] == "GPRecordSet":
self._results[k] = GPRecordSet.fromJSON(json.dumps(param))
return self._results
|
[
"def",
"results",
"(",
"self",
")",
":",
"self",
".",
"__init",
"(",
")",
"for",
"k",
",",
"v",
"in",
"self",
".",
"_results",
".",
"items",
"(",
")",
":",
"param",
"=",
"self",
".",
"_get_json",
"(",
"v",
"[",
"'paramUrl'",
"]",
")",
"if",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPFeatureRecordSetLayer\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPFeatureRecordSetLayer",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
".",
"lower",
"(",
")",
".",
"find",
"(",
"'gpmultivalue'",
")",
">",
"-",
"1",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPMultiValue",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPString\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPString",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPLong\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPLong",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPDouble\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPDouble",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPDate\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPDate",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPBoolean\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPBoolean",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPDataFile\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPDataFile",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPLinearUnit\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPLinearUnit",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPMultiValue\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPMultiValue",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPRasterData\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPRasterData",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPRasterDataLayer\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPRasterDataLayer",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"elif",
"param",
"[",
"'dataType'",
"]",
"==",
"\"GPRecordSet\"",
":",
"self",
".",
"_results",
"[",
"k",
"]",
"=",
"GPRecordSet",
".",
"fromJSON",
"(",
"json",
".",
"dumps",
"(",
"param",
")",
")",
"return",
"self",
".",
"_results"
] |
returns the results
|
[
"returns",
"the",
"results"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_geoprocessing.py#L467-L498
|
12,978
|
Esri/ArcREST
|
src/arcrest/ags/_geoprocessing.py
|
GPJob.getParameterValue
|
def getParameterValue(self, parameterName):
""" gets a parameter value """
if self._results is None:
self.__init()
parameter = self._results[parameterName]
return parameter
|
python
|
def getParameterValue(self, parameterName):
""" gets a parameter value """
if self._results is None:
self.__init()
parameter = self._results[parameterName]
return parameter
|
[
"def",
"getParameterValue",
"(",
"self",
",",
"parameterName",
")",
":",
"if",
"self",
".",
"_results",
"is",
"None",
":",
"self",
".",
"__init",
"(",
")",
"parameter",
"=",
"self",
".",
"_results",
"[",
"parameterName",
"]",
"return",
"parameter"
] |
gets a parameter value
|
[
"gets",
"a",
"parameter",
"value"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_geoprocessing.py#L519-L524
|
12,979
|
Esri/ArcREST
|
src/arcrest/ags/layer.py
|
FeatureLayer_Depricated.parentLayer
|
def parentLayer(self):
""" returns information about the parent """
if self._parentLayer is None:
from ..agol.services import FeatureService
self.__init()
url = os.path.dirname(self._url)
self._parentLayer = FeatureService(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
return self._parentLayer
|
python
|
def parentLayer(self):
""" returns information about the parent """
if self._parentLayer is None:
from ..agol.services import FeatureService
self.__init()
url = os.path.dirname(self._url)
self._parentLayer = FeatureService(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
return self._parentLayer
|
[
"def",
"parentLayer",
"(",
"self",
")",
":",
"if",
"self",
".",
"_parentLayer",
"is",
"None",
":",
"from",
".",
".",
"agol",
".",
"services",
"import",
"FeatureService",
"self",
".",
"__init",
"(",
")",
"url",
"=",
"os",
".",
"path",
".",
"dirname",
"(",
"self",
".",
"_url",
")",
"self",
".",
"_parentLayer",
"=",
"FeatureService",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"return",
"self",
".",
"_parentLayer"
] |
returns information about the parent
|
[
"returns",
"information",
"about",
"the",
"parent"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/layer.py#L289-L299
|
12,980
|
Esri/ArcREST
|
src/arcrest/ags/layer.py
|
FeatureLayer_Depricated._chunks
|
def _chunks(self, l, n):
""" Yield n successive chunks from a list l.
"""
l.sort()
newn = int(1.0 * len(l) / n + 0.5)
for i in range(0, n-1):
yield l[i*newn:i*newn+newn]
yield l[n*newn-newn:]
|
python
|
def _chunks(self, l, n):
""" Yield n successive chunks from a list l.
"""
l.sort()
newn = int(1.0 * len(l) / n + 0.5)
for i in range(0, n-1):
yield l[i*newn:i*newn+newn]
yield l[n*newn-newn:]
|
[
"def",
"_chunks",
"(",
"self",
",",
"l",
",",
"n",
")",
":",
"l",
".",
"sort",
"(",
")",
"newn",
"=",
"int",
"(",
"1.0",
"*",
"len",
"(",
"l",
")",
"/",
"n",
"+",
"0.5",
")",
"for",
"i",
"in",
"range",
"(",
"0",
",",
"n",
"-",
"1",
")",
":",
"yield",
"l",
"[",
"i",
"*",
"newn",
":",
"i",
"*",
"newn",
"+",
"newn",
"]",
"yield",
"l",
"[",
"n",
"*",
"newn",
"-",
"newn",
":",
"]"
] |
Yield n successive chunks from a list l.
|
[
"Yield",
"n",
"successive",
"chunks",
"from",
"a",
"list",
"l",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/layer.py#L512-L519
|
12,981
|
Esri/ArcREST
|
src/arcrest/ags/layer.py
|
FeatureLayer_Depricated.calculate
|
def calculate(self, where, calcExpression, sqlFormat="standard"):
"""
The calculate operation is performed on a feature service layer
resource. It updates the values of one or more fields in an
existing feature service layer based on SQL expressions or scalar
values. The calculate operation can only be used if the
supportsCalculate property of the layer is true.
Neither the Shape field nor system fields can be updated using
calculate. System fields include ObjectId and GlobalId.
See Calculate a field for more information on supported expressions
Inputs:
where - A where clause can be used to limit the updated records.
Any legal SQL where clause operating on the fields in
the layer is allowed.
calcExpression - The array of field/value info objects that
contain the field or fields to update and their
scalar values or SQL expression. Allowed types
are dictionary and list. List must be a list
of dictionary objects.
Calculation Format is as follows:
{"field" : "<field name>",
"value" : "<value>"}
sqlFormat - The SQL format for the calcExpression. It can be
either standard SQL92 (standard) or native SQL
(native). The default is standard.
Values: standard, native
Output:
JSON as string
Usage:
>>>sh = arcrest.AGOLTokenSecurityHandler("user", "pw")
>>>fl = arcrest.agol.FeatureLayer(url="someurl",
securityHandler=sh, initialize=True)
>>>print fl.calculate(where="OBJECTID < 2",
calcExpression={"field": "ZONE",
"value" : "R1"})
{'updatedFeatureCount': 1, 'success': True}
"""
url = self._url + "/calculate"
params = {
"f" : "json",
"where" : where,
}
if isinstance(calcExpression, dict):
params["calcExpression"] = json.dumps([calcExpression],
default=_date_handler)
elif isinstance(calcExpression, list):
params["calcExpression"] = json.dumps(calcExpression,
default=_date_handler)
if sqlFormat.lower() in ['native', 'standard']:
params['sqlFormat'] = sqlFormat.lower()
else:
params['sqlFormat'] = "standard"
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def calculate(self, where, calcExpression, sqlFormat="standard"):
"""
The calculate operation is performed on a feature service layer
resource. It updates the values of one or more fields in an
existing feature service layer based on SQL expressions or scalar
values. The calculate operation can only be used if the
supportsCalculate property of the layer is true.
Neither the Shape field nor system fields can be updated using
calculate. System fields include ObjectId and GlobalId.
See Calculate a field for more information on supported expressions
Inputs:
where - A where clause can be used to limit the updated records.
Any legal SQL where clause operating on the fields in
the layer is allowed.
calcExpression - The array of field/value info objects that
contain the field or fields to update and their
scalar values or SQL expression. Allowed types
are dictionary and list. List must be a list
of dictionary objects.
Calculation Format is as follows:
{"field" : "<field name>",
"value" : "<value>"}
sqlFormat - The SQL format for the calcExpression. It can be
either standard SQL92 (standard) or native SQL
(native). The default is standard.
Values: standard, native
Output:
JSON as string
Usage:
>>>sh = arcrest.AGOLTokenSecurityHandler("user", "pw")
>>>fl = arcrest.agol.FeatureLayer(url="someurl",
securityHandler=sh, initialize=True)
>>>print fl.calculate(where="OBJECTID < 2",
calcExpression={"field": "ZONE",
"value" : "R1"})
{'updatedFeatureCount': 1, 'success': True}
"""
url = self._url + "/calculate"
params = {
"f" : "json",
"where" : where,
}
if isinstance(calcExpression, dict):
params["calcExpression"] = json.dumps([calcExpression],
default=_date_handler)
elif isinstance(calcExpression, list):
params["calcExpression"] = json.dumps(calcExpression,
default=_date_handler)
if sqlFormat.lower() in ['native', 'standard']:
params['sqlFormat'] = sqlFormat.lower()
else:
params['sqlFormat'] = "standard"
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"calculate",
"(",
"self",
",",
"where",
",",
"calcExpression",
",",
"sqlFormat",
"=",
"\"standard\"",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/calculate\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"where\"",
":",
"where",
",",
"}",
"if",
"isinstance",
"(",
"calcExpression",
",",
"dict",
")",
":",
"params",
"[",
"\"calcExpression\"",
"]",
"=",
"json",
".",
"dumps",
"(",
"[",
"calcExpression",
"]",
",",
"default",
"=",
"_date_handler",
")",
"elif",
"isinstance",
"(",
"calcExpression",
",",
"list",
")",
":",
"params",
"[",
"\"calcExpression\"",
"]",
"=",
"json",
".",
"dumps",
"(",
"calcExpression",
",",
"default",
"=",
"_date_handler",
")",
"if",
"sqlFormat",
".",
"lower",
"(",
")",
"in",
"[",
"'native'",
",",
"'standard'",
"]",
":",
"params",
"[",
"'sqlFormat'",
"]",
"=",
"sqlFormat",
".",
"lower",
"(",
")",
"else",
":",
"params",
"[",
"'sqlFormat'",
"]",
"=",
"\"standard\"",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
The calculate operation is performed on a feature service layer
resource. It updates the values of one or more fields in an
existing feature service layer based on SQL expressions or scalar
values. The calculate operation can only be used if the
supportsCalculate property of the layer is true.
Neither the Shape field nor system fields can be updated using
calculate. System fields include ObjectId and GlobalId.
See Calculate a field for more information on supported expressions
Inputs:
where - A where clause can be used to limit the updated records.
Any legal SQL where clause operating on the fields in
the layer is allowed.
calcExpression - The array of field/value info objects that
contain the field or fields to update and their
scalar values or SQL expression. Allowed types
are dictionary and list. List must be a list
of dictionary objects.
Calculation Format is as follows:
{"field" : "<field name>",
"value" : "<value>"}
sqlFormat - The SQL format for the calcExpression. It can be
either standard SQL92 (standard) or native SQL
(native). The default is standard.
Values: standard, native
Output:
JSON as string
Usage:
>>>sh = arcrest.AGOLTokenSecurityHandler("user", "pw")
>>>fl = arcrest.agol.FeatureLayer(url="someurl",
securityHandler=sh, initialize=True)
>>>print fl.calculate(where="OBJECTID < 2",
calcExpression={"field": "ZONE",
"value" : "R1"})
{'updatedFeatureCount': 1, 'success': True}
|
[
"The",
"calculate",
"operation",
"is",
"performed",
"on",
"a",
"feature",
"service",
"layer",
"resource",
".",
"It",
"updates",
"the",
"values",
"of",
"one",
"or",
"more",
"fields",
"in",
"an",
"existing",
"feature",
"service",
"layer",
"based",
"on",
"SQL",
"expressions",
"or",
"scalar",
"values",
".",
"The",
"calculate",
"operation",
"can",
"only",
"be",
"used",
"if",
"the",
"supportsCalculate",
"property",
"of",
"the",
"layer",
"is",
"true",
".",
"Neither",
"the",
"Shape",
"field",
"nor",
"system",
"fields",
"can",
"be",
"updated",
"using",
"calculate",
".",
"System",
"fields",
"include",
"ObjectId",
"and",
"GlobalId",
".",
"See",
"Calculate",
"a",
"field",
"for",
"more",
"information",
"on",
"supported",
"expressions"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/layer.py#L1034-L1092
|
12,982
|
Esri/ArcREST
|
src/arcrest/ags/layer.py
|
FeatureLayer_Depricated.validateSQL
|
def validateSQL(self, sql, sqlType="where"):
"""
The validateSQL operation validates an SQL-92 expression or WHERE
clause.
The validateSQL operation ensures that an SQL-92 expression, such
as one written by a user through a user interface, is correct
before performing another operation that uses the expression. For
example, validateSQL can be used to validate information that is
subsequently passed in as part of the where parameter of the
calculate operation.
validateSQL also prevents SQL injection. In addition, all table and
field names used in the SQL expression or WHERE clause are
validated to ensure they are valid tables and fields.
Inputs:
sql - The SQL expression or WHERE clause to validate.
sqlType - Three SQL types are supported in validateSQL:
where (default) - Represents the custom WHERE clause the user
can compose when querying a layer or using calculate.
expression - Represents an SQL-92 expression. Currently,
expression is used as a default value expression when adding a
new field or using the calculate API.
statement - Represents the full SQL-92 statement that can be
passed directly to the database. No current ArcGIS REST API
resource or operation supports using the full SQL-92 SELECT
statement directly. It has been added to the validateSQL for
completeness.
Values: where | expression | statement
"""
url = self._url + "/validateSQL"
if not sqlType.lower() in ['where', 'expression', 'statement']:
raise Exception("Invalid Input for sqlType: %s" % sqlType)
params = {
"f" : "json",
"sql" : sql,
"sqlType" : sqlType
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def validateSQL(self, sql, sqlType="where"):
"""
The validateSQL operation validates an SQL-92 expression or WHERE
clause.
The validateSQL operation ensures that an SQL-92 expression, such
as one written by a user through a user interface, is correct
before performing another operation that uses the expression. For
example, validateSQL can be used to validate information that is
subsequently passed in as part of the where parameter of the
calculate operation.
validateSQL also prevents SQL injection. In addition, all table and
field names used in the SQL expression or WHERE clause are
validated to ensure they are valid tables and fields.
Inputs:
sql - The SQL expression or WHERE clause to validate.
sqlType - Three SQL types are supported in validateSQL:
where (default) - Represents the custom WHERE clause the user
can compose when querying a layer or using calculate.
expression - Represents an SQL-92 expression. Currently,
expression is used as a default value expression when adding a
new field or using the calculate API.
statement - Represents the full SQL-92 statement that can be
passed directly to the database. No current ArcGIS REST API
resource or operation supports using the full SQL-92 SELECT
statement directly. It has been added to the validateSQL for
completeness.
Values: where | expression | statement
"""
url = self._url + "/validateSQL"
if not sqlType.lower() in ['where', 'expression', 'statement']:
raise Exception("Invalid Input for sqlType: %s" % sqlType)
params = {
"f" : "json",
"sql" : sql,
"sqlType" : sqlType
}
return self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"validateSQL",
"(",
"self",
",",
"sql",
",",
"sqlType",
"=",
"\"where\"",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/validateSQL\"",
"if",
"not",
"sqlType",
".",
"lower",
"(",
")",
"in",
"[",
"'where'",
",",
"'expression'",
",",
"'statement'",
"]",
":",
"raise",
"Exception",
"(",
"\"Invalid Input for sqlType: %s\"",
"%",
"sqlType",
")",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"sql\"",
":",
"sql",
",",
"\"sqlType\"",
":",
"sqlType",
"}",
"return",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
The validateSQL operation validates an SQL-92 expression or WHERE
clause.
The validateSQL operation ensures that an SQL-92 expression, such
as one written by a user through a user interface, is correct
before performing another operation that uses the expression. For
example, validateSQL can be used to validate information that is
subsequently passed in as part of the where parameter of the
calculate operation.
validateSQL also prevents SQL injection. In addition, all table and
field names used in the SQL expression or WHERE clause are
validated to ensure they are valid tables and fields.
Inputs:
sql - The SQL expression or WHERE clause to validate.
sqlType - Three SQL types are supported in validateSQL:
where (default) - Represents the custom WHERE clause the user
can compose when querying a layer or using calculate.
expression - Represents an SQL-92 expression. Currently,
expression is used as a default value expression when adding a
new field or using the calculate API.
statement - Represents the full SQL-92 statement that can be
passed directly to the database. No current ArcGIS REST API
resource or operation supports using the full SQL-92 SELECT
statement directly. It has been added to the validateSQL for
completeness.
Values: where | expression | statement
|
[
"The",
"validateSQL",
"operation",
"validates",
"an",
"SQL",
"-",
"92",
"expression",
"or",
"WHERE",
"clause",
".",
"The",
"validateSQL",
"operation",
"ensures",
"that",
"an",
"SQL",
"-",
"92",
"expression",
"such",
"as",
"one",
"written",
"by",
"a",
"user",
"through",
"a",
"user",
"interface",
"is",
"correct",
"before",
"performing",
"another",
"operation",
"that",
"uses",
"the",
"expression",
".",
"For",
"example",
"validateSQL",
"can",
"be",
"used",
"to",
"validate",
"information",
"that",
"is",
"subsequently",
"passed",
"in",
"as",
"part",
"of",
"the",
"where",
"parameter",
"of",
"the",
"calculate",
"operation",
".",
"validateSQL",
"also",
"prevents",
"SQL",
"injection",
".",
"In",
"addition",
"all",
"table",
"and",
"field",
"names",
"used",
"in",
"the",
"SQL",
"expression",
"or",
"WHERE",
"clause",
"are",
"validated",
"to",
"ensure",
"they",
"are",
"valid",
"tables",
"and",
"fields",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/layer.py#L1094-L1135
|
12,983
|
Esri/ArcREST
|
src/arcrest/ags/layer.py
|
DynamicMapLayer.asDictionary
|
def asDictionary(self):
""" converts the object to a dictionary """
template = {"type" : self._type,
"mapLayerId" : self._mapLayerId}
if not self._gdbVersion is None and\
self._gdbVersion != "":
template['gdbVersion'] = self._gdbVersion
return template
|
python
|
def asDictionary(self):
""" converts the object to a dictionary """
template = {"type" : self._type,
"mapLayerId" : self._mapLayerId}
if not self._gdbVersion is None and\
self._gdbVersion != "":
template['gdbVersion'] = self._gdbVersion
return template
|
[
"def",
"asDictionary",
"(",
"self",
")",
":",
"template",
"=",
"{",
"\"type\"",
":",
"self",
".",
"_type",
",",
"\"mapLayerId\"",
":",
"self",
".",
"_mapLayerId",
"}",
"if",
"not",
"self",
".",
"_gdbVersion",
"is",
"None",
"and",
"self",
".",
"_gdbVersion",
"!=",
"\"\"",
":",
"template",
"[",
"'gdbVersion'",
"]",
"=",
"self",
".",
"_gdbVersion",
"return",
"template"
] |
converts the object to a dictionary
|
[
"converts",
"the",
"object",
"to",
"a",
"dictionary"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/layer.py#L1214-L1221
|
12,984
|
Esri/ArcREST
|
src/arcrest/ags/layer.py
|
DynamicDataLayer.asDictionary
|
def asDictionary(self):
""" returns the value as a dictionary """
template = {
"type": "dataLayer",
"dataSource": self._dataSource
}
if not self._fields is None:
template['fields'] = self._fields
return template
|
python
|
def asDictionary(self):
""" returns the value as a dictionary """
template = {
"type": "dataLayer",
"dataSource": self._dataSource
}
if not self._fields is None:
template['fields'] = self._fields
return template
|
[
"def",
"asDictionary",
"(",
"self",
")",
":",
"template",
"=",
"{",
"\"type\"",
":",
"\"dataLayer\"",
",",
"\"dataSource\"",
":",
"self",
".",
"_dataSource",
"}",
"if",
"not",
"self",
".",
"_fields",
"is",
"None",
":",
"template",
"[",
"'fields'",
"]",
"=",
"self",
".",
"_fields",
"return",
"template"
] |
returns the value as a dictionary
|
[
"returns",
"the",
"value",
"as",
"a",
"dictionary"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/layer.py#L1251-L1259
|
12,985
|
Esri/ArcREST
|
src/arcrest/ags/layer.py
|
DynamicDataLayer.dataSource
|
def dataSource(self, value):
""" sets the datasource object """
if isinstance(value, DataSource):
self._dataSource = value
else:
raise TypeError("value must be a DataSource object")
|
python
|
def dataSource(self, value):
""" sets the datasource object """
if isinstance(value, DataSource):
self._dataSource = value
else:
raise TypeError("value must be a DataSource object")
|
[
"def",
"dataSource",
"(",
"self",
",",
"value",
")",
":",
"if",
"isinstance",
"(",
"value",
",",
"DataSource",
")",
":",
"self",
".",
"_dataSource",
"=",
"value",
"else",
":",
"raise",
"TypeError",
"(",
"\"value must be a DataSource object\"",
")"
] |
sets the datasource object
|
[
"sets",
"the",
"datasource",
"object"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/layer.py#L1268-L1273
|
12,986
|
Esri/ArcREST
|
src/arcrest/ags/layer.py
|
DynamicDataLayer.fields
|
def fields(self, value):
"""sets the fields variable"""
if type(value) is list:
self._fields = value
else:
raise TypeError("Input must be a list")
|
python
|
def fields(self, value):
"""sets the fields variable"""
if type(value) is list:
self._fields = value
else:
raise TypeError("Input must be a list")
|
[
"def",
"fields",
"(",
"self",
",",
"value",
")",
":",
"if",
"type",
"(",
"value",
")",
"is",
"list",
":",
"self",
".",
"_fields",
"=",
"value",
"else",
":",
"raise",
"TypeError",
"(",
"\"Input must be a list\"",
")"
] |
sets the fields variable
|
[
"sets",
"the",
"fields",
"variable"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/layer.py#L1281-L1286
|
12,987
|
Esri/ArcREST
|
src/arcrest/common/domain.py
|
CodedValueDomain.addCodedValue
|
def addCodedValue(self, name, code):
"""
adds a coded value to the domain
Inputs:
name - name of the domain
code - value
"""
i = {"name" : name, "code" : code}
if i not in self._codedValues:
self._codedValues.append(i)
|
python
|
def addCodedValue(self, name, code):
"""
adds a coded value to the domain
Inputs:
name - name of the domain
code - value
"""
i = {"name" : name, "code" : code}
if i not in self._codedValues:
self._codedValues.append(i)
|
[
"def",
"addCodedValue",
"(",
"self",
",",
"name",
",",
"code",
")",
":",
"i",
"=",
"{",
"\"name\"",
":",
"name",
",",
"\"code\"",
":",
"code",
"}",
"if",
"i",
"not",
"in",
"self",
".",
"_codedValues",
":",
"self",
".",
"_codedValues",
".",
"append",
"(",
"i",
")"
] |
adds a coded value to the domain
Inputs:
name - name of the domain
code - value
|
[
"adds",
"a",
"coded",
"value",
"to",
"the",
"domain"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/common/domain.py#L59-L69
|
12,988
|
Esri/ArcREST
|
src/arcrest/common/domain.py
|
CodedValueDomain.removeCodedValue
|
def removeCodedValue(self, name):
"""removes a codedValue by name"""
for i in self._codedValues:
if i['name'] == name:
self._codedValues.remove(i)
return True
return False
|
python
|
def removeCodedValue(self, name):
"""removes a codedValue by name"""
for i in self._codedValues:
if i['name'] == name:
self._codedValues.remove(i)
return True
return False
|
[
"def",
"removeCodedValue",
"(",
"self",
",",
"name",
")",
":",
"for",
"i",
"in",
"self",
".",
"_codedValues",
":",
"if",
"i",
"[",
"'name'",
"]",
"==",
"name",
":",
"self",
".",
"_codedValues",
".",
"remove",
"(",
"i",
")",
"return",
"True",
"return",
"False"
] |
removes a codedValue by name
|
[
"removes",
"a",
"codedValue",
"by",
"name"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/common/domain.py#L71-L77
|
12,989
|
Esri/ArcREST
|
src/arcrest/common/domain.py
|
RangeDomain.value
|
def value(self):
"""gets the value as a dictionary"""
return {
"type" : self._type,
"name" : self._name,
"range" : [self._rangeMin, self._rangeMax]
}
|
python
|
def value(self):
"""gets the value as a dictionary"""
return {
"type" : self._type,
"name" : self._name,
"range" : [self._rangeMin, self._rangeMax]
}
|
[
"def",
"value",
"(",
"self",
")",
":",
"return",
"{",
"\"type\"",
":",
"self",
".",
"_type",
",",
"\"name\"",
":",
"self",
".",
"_name",
",",
"\"range\"",
":",
"[",
"self",
".",
"_rangeMin",
",",
"self",
".",
"_rangeMax",
"]",
"}"
] |
gets the value as a dictionary
|
[
"gets",
"the",
"value",
"as",
"a",
"dictionary"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/common/domain.py#L126-L132
|
12,990
|
Esri/ArcREST
|
src/arcrest/ags/_imageservice.py
|
ImageService.exportImage
|
def exportImage(self,
bbox,
imageSR,
bboxSR,
size=[400,400],
time=None,
format="jpgpng",
pixelType="UNKNOWN",
noData=None,
noDataInterpretation="esriNoDataMatchAny",
interpolation=None,
compression=None,
compressionQuality=75,
bandIds=None,
moasiacRule=None,
renderingRule="",
f="json",
saveFolder=None,
saveFile=None
):
"""
The exportImage operation is performed on an image service resource
The result of this operation is an image resource. This resource
provides information about the exported image, such as its URL,
extent, width, and height.
In addition to the usual response formats of HTML and JSON, you can
also request the image format while performing this operation. When
you perform an export with the image format , the server responds
by directly streaming the image bytes to the client. With this
approach, you don't get any information associated with the
exported image other than the image itself.
Inputs:
bbox - The extent (bounding box) of the exported image. Unless
the bboxSR parameter has been specified, the bbox is
assumed to be in the spatial reference of the image
service.
imageSR - The spatial reference of the exported image.
bboxSR - The spatial reference of the bbox.
size - The size (width * height) of the exported image in
pixels. If size is not specified, an image with a default
size of 400 * 400 will be exported.
time - The time instant or the time extent of the exported image.
format - The format of the exported image. The default format is
jpgpng.
Values: jpgpng | png | png8 | png24 | jpg | bmp | gif |
tiff | png32
pixelType - The pixel type, also known as data type, pertains to
the type of values stored in the raster, such as
signed integer, unsigned integer, or floating point.
Integers are whole numbers, whereas floating points
have decimals.
noDate - The pixel value representing no information.
noDataInterpretation - Interpretation of the noData setting. The
default is esriNoDataMatchAny when noData is
a number, and esriNoDataMatchAll when noData
is a comma-delimited string:
esriNoDataMatchAny | esriNoDataMatchAll.
interpolation - The resampling process of extrapolating the
pixel values while transforming the raster
dataset when it undergoes warping or when it
changes coordinate space.
compression - Controls how to compress the image when exporting
to TIFF format: None, JPEG, LZ77. It does not
control compression on other formats.
compressionQuality - Controls how much loss the image will be
subjected to by the compression algorithm.
Valid value ranges of compression quality
are from 0 to 100.
bandIds - If there are multiple bands, you can specify a single
band to export, or you can change the band combination
(red, green, blue) by specifying the band number. Band
number is 0 based.
mosaicRule - Specifies the mosaic rule when defining how
individual images should be mosaicked. When a mosaic
rule is not specified, the default mosaic rule of
the image service will be used (as advertised in
the root resource: defaultMosaicMethod,
mosaicOperator, sortField, sortValue).
renderingRule - Specifies the rendering rule for how the
requested image should be rendered.
f - The response format. default is json
Values: json | image | kmz
"""
params = {
"bbox" : bbox,
"imageSR": imageSR,
"bboxSR": bboxSR,
"size" : "%s %s" % (size[0], size[1]),
"pixelType" : pixelType,
"compressionQuality" : compressionQuality,
}
url = self._url + "/exportImage"
__allowedFormat = ["jpgpng", "png",
"png8", "png24",
"jpg", "bmp",
"gif", "tiff",
"png32"]
__allowedPixelTypes = [
"C128", "C64", "F32",
"F64", "S16", "S32",
"S8", "U1", "U16",
"U2", "U32", "U4",
"U8", "UNKNOWN"
]
__allowednoDataInt = [
"esriNoDataMatchAny",
"esriNoDataMatchAll"
]
__allowedInterpolation = [
"RSP_BilinearInterpolation",
"RSP_CubicConvolution",
"RSP_Majority",
"RSP_NearestNeighbor"
]
__allowedCompression = [
"JPEG", "LZ77"
]
if isinstance(moasiacRule,MosaicRuleObject):
params["moasiacRule"] = moasiacRule.value
if format in __allowedFormat:
params['format'] = format
if isinstance(time, datetime.datetime):
params['time'] = local_time_to_online(time)
if interpolation is not None and \
interpolation in __allowedInterpolation and \
isinstance(interpolation, str):
params['interpolation'] = interpolation
if pixelType is not None and \
pixelType in __allowedPixelTypes:
params['pixelType'] = pixelType
if noDataInterpretation in __allowedInterpolation:
params['noDataInterpretation'] = noDataInterpretation
if noData is not None:
params['noData'] = noData
if compression is not None and \
compression in __allowedCompression:
params['compression'] = compression
if bandIds is not None and \
isinstance(bandIds, list):
params['bandIds'] = ",".join(bandIds)
if renderingRule is not None:
params['renderingRule'] = renderingRule
params["f" ] = f
if f == "json":
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
elif f == "image":
result = self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
out_folder=saveFolder,
file_name=saveFile)
return result
elif f == "kmz":
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
out_folder=saveFolder,
file_name=saveFile)
|
python
|
def exportImage(self,
bbox,
imageSR,
bboxSR,
size=[400,400],
time=None,
format="jpgpng",
pixelType="UNKNOWN",
noData=None,
noDataInterpretation="esriNoDataMatchAny",
interpolation=None,
compression=None,
compressionQuality=75,
bandIds=None,
moasiacRule=None,
renderingRule="",
f="json",
saveFolder=None,
saveFile=None
):
"""
The exportImage operation is performed on an image service resource
The result of this operation is an image resource. This resource
provides information about the exported image, such as its URL,
extent, width, and height.
In addition to the usual response formats of HTML and JSON, you can
also request the image format while performing this operation. When
you perform an export with the image format , the server responds
by directly streaming the image bytes to the client. With this
approach, you don't get any information associated with the
exported image other than the image itself.
Inputs:
bbox - The extent (bounding box) of the exported image. Unless
the bboxSR parameter has been specified, the bbox is
assumed to be in the spatial reference of the image
service.
imageSR - The spatial reference of the exported image.
bboxSR - The spatial reference of the bbox.
size - The size (width * height) of the exported image in
pixels. If size is not specified, an image with a default
size of 400 * 400 will be exported.
time - The time instant or the time extent of the exported image.
format - The format of the exported image. The default format is
jpgpng.
Values: jpgpng | png | png8 | png24 | jpg | bmp | gif |
tiff | png32
pixelType - The pixel type, also known as data type, pertains to
the type of values stored in the raster, such as
signed integer, unsigned integer, or floating point.
Integers are whole numbers, whereas floating points
have decimals.
noDate - The pixel value representing no information.
noDataInterpretation - Interpretation of the noData setting. The
default is esriNoDataMatchAny when noData is
a number, and esriNoDataMatchAll when noData
is a comma-delimited string:
esriNoDataMatchAny | esriNoDataMatchAll.
interpolation - The resampling process of extrapolating the
pixel values while transforming the raster
dataset when it undergoes warping or when it
changes coordinate space.
compression - Controls how to compress the image when exporting
to TIFF format: None, JPEG, LZ77. It does not
control compression on other formats.
compressionQuality - Controls how much loss the image will be
subjected to by the compression algorithm.
Valid value ranges of compression quality
are from 0 to 100.
bandIds - If there are multiple bands, you can specify a single
band to export, or you can change the band combination
(red, green, blue) by specifying the band number. Band
number is 0 based.
mosaicRule - Specifies the mosaic rule when defining how
individual images should be mosaicked. When a mosaic
rule is not specified, the default mosaic rule of
the image service will be used (as advertised in
the root resource: defaultMosaicMethod,
mosaicOperator, sortField, sortValue).
renderingRule - Specifies the rendering rule for how the
requested image should be rendered.
f - The response format. default is json
Values: json | image | kmz
"""
params = {
"bbox" : bbox,
"imageSR": imageSR,
"bboxSR": bboxSR,
"size" : "%s %s" % (size[0], size[1]),
"pixelType" : pixelType,
"compressionQuality" : compressionQuality,
}
url = self._url + "/exportImage"
__allowedFormat = ["jpgpng", "png",
"png8", "png24",
"jpg", "bmp",
"gif", "tiff",
"png32"]
__allowedPixelTypes = [
"C128", "C64", "F32",
"F64", "S16", "S32",
"S8", "U1", "U16",
"U2", "U32", "U4",
"U8", "UNKNOWN"
]
__allowednoDataInt = [
"esriNoDataMatchAny",
"esriNoDataMatchAll"
]
__allowedInterpolation = [
"RSP_BilinearInterpolation",
"RSP_CubicConvolution",
"RSP_Majority",
"RSP_NearestNeighbor"
]
__allowedCompression = [
"JPEG", "LZ77"
]
if isinstance(moasiacRule,MosaicRuleObject):
params["moasiacRule"] = moasiacRule.value
if format in __allowedFormat:
params['format'] = format
if isinstance(time, datetime.datetime):
params['time'] = local_time_to_online(time)
if interpolation is not None and \
interpolation in __allowedInterpolation and \
isinstance(interpolation, str):
params['interpolation'] = interpolation
if pixelType is not None and \
pixelType in __allowedPixelTypes:
params['pixelType'] = pixelType
if noDataInterpretation in __allowedInterpolation:
params['noDataInterpretation'] = noDataInterpretation
if noData is not None:
params['noData'] = noData
if compression is not None and \
compression in __allowedCompression:
params['compression'] = compression
if bandIds is not None and \
isinstance(bandIds, list):
params['bandIds'] = ",".join(bandIds)
if renderingRule is not None:
params['renderingRule'] = renderingRule
params["f" ] = f
if f == "json":
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
elif f == "image":
result = self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
out_folder=saveFolder,
file_name=saveFile)
return result
elif f == "kmz":
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
out_folder=saveFolder,
file_name=saveFile)
|
[
"def",
"exportImage",
"(",
"self",
",",
"bbox",
",",
"imageSR",
",",
"bboxSR",
",",
"size",
"=",
"[",
"400",
",",
"400",
"]",
",",
"time",
"=",
"None",
",",
"format",
"=",
"\"jpgpng\"",
",",
"pixelType",
"=",
"\"UNKNOWN\"",
",",
"noData",
"=",
"None",
",",
"noDataInterpretation",
"=",
"\"esriNoDataMatchAny\"",
",",
"interpolation",
"=",
"None",
",",
"compression",
"=",
"None",
",",
"compressionQuality",
"=",
"75",
",",
"bandIds",
"=",
"None",
",",
"moasiacRule",
"=",
"None",
",",
"renderingRule",
"=",
"\"\"",
",",
"f",
"=",
"\"json\"",
",",
"saveFolder",
"=",
"None",
",",
"saveFile",
"=",
"None",
")",
":",
"params",
"=",
"{",
"\"bbox\"",
":",
"bbox",
",",
"\"imageSR\"",
":",
"imageSR",
",",
"\"bboxSR\"",
":",
"bboxSR",
",",
"\"size\"",
":",
"\"%s %s\"",
"%",
"(",
"size",
"[",
"0",
"]",
",",
"size",
"[",
"1",
"]",
")",
",",
"\"pixelType\"",
":",
"pixelType",
",",
"\"compressionQuality\"",
":",
"compressionQuality",
",",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/exportImage\"",
"__allowedFormat",
"=",
"[",
"\"jpgpng\"",
",",
"\"png\"",
",",
"\"png8\"",
",",
"\"png24\"",
",",
"\"jpg\"",
",",
"\"bmp\"",
",",
"\"gif\"",
",",
"\"tiff\"",
",",
"\"png32\"",
"]",
"__allowedPixelTypes",
"=",
"[",
"\"C128\"",
",",
"\"C64\"",
",",
"\"F32\"",
",",
"\"F64\"",
",",
"\"S16\"",
",",
"\"S32\"",
",",
"\"S8\"",
",",
"\"U1\"",
",",
"\"U16\"",
",",
"\"U2\"",
",",
"\"U32\"",
",",
"\"U4\"",
",",
"\"U8\"",
",",
"\"UNKNOWN\"",
"]",
"__allowednoDataInt",
"=",
"[",
"\"esriNoDataMatchAny\"",
",",
"\"esriNoDataMatchAll\"",
"]",
"__allowedInterpolation",
"=",
"[",
"\"RSP_BilinearInterpolation\"",
",",
"\"RSP_CubicConvolution\"",
",",
"\"RSP_Majority\"",
",",
"\"RSP_NearestNeighbor\"",
"]",
"__allowedCompression",
"=",
"[",
"\"JPEG\"",
",",
"\"LZ77\"",
"]",
"if",
"isinstance",
"(",
"moasiacRule",
",",
"MosaicRuleObject",
")",
":",
"params",
"[",
"\"moasiacRule\"",
"]",
"=",
"moasiacRule",
".",
"value",
"if",
"format",
"in",
"__allowedFormat",
":",
"params",
"[",
"'format'",
"]",
"=",
"format",
"if",
"isinstance",
"(",
"time",
",",
"datetime",
".",
"datetime",
")",
":",
"params",
"[",
"'time'",
"]",
"=",
"local_time_to_online",
"(",
"time",
")",
"if",
"interpolation",
"is",
"not",
"None",
"and",
"interpolation",
"in",
"__allowedInterpolation",
"and",
"isinstance",
"(",
"interpolation",
",",
"str",
")",
":",
"params",
"[",
"'interpolation'",
"]",
"=",
"interpolation",
"if",
"pixelType",
"is",
"not",
"None",
"and",
"pixelType",
"in",
"__allowedPixelTypes",
":",
"params",
"[",
"'pixelType'",
"]",
"=",
"pixelType",
"if",
"noDataInterpretation",
"in",
"__allowedInterpolation",
":",
"params",
"[",
"'noDataInterpretation'",
"]",
"=",
"noDataInterpretation",
"if",
"noData",
"is",
"not",
"None",
":",
"params",
"[",
"'noData'",
"]",
"=",
"noData",
"if",
"compression",
"is",
"not",
"None",
"and",
"compression",
"in",
"__allowedCompression",
":",
"params",
"[",
"'compression'",
"]",
"=",
"compression",
"if",
"bandIds",
"is",
"not",
"None",
"and",
"isinstance",
"(",
"bandIds",
",",
"list",
")",
":",
"params",
"[",
"'bandIds'",
"]",
"=",
"\",\"",
".",
"join",
"(",
"bandIds",
")",
"if",
"renderingRule",
"is",
"not",
"None",
":",
"params",
"[",
"'renderingRule'",
"]",
"=",
"renderingRule",
"params",
"[",
"\"f\"",
"]",
"=",
"f",
"if",
"f",
"==",
"\"json\"",
":",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")",
"elif",
"f",
"==",
"\"image\"",
":",
"result",
"=",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"out_folder",
"=",
"saveFolder",
",",
"file_name",
"=",
"saveFile",
")",
"return",
"result",
"elif",
"f",
"==",
"\"kmz\"",
":",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"out_folder",
"=",
"saveFolder",
",",
"file_name",
"=",
"saveFile",
")"
] |
The exportImage operation is performed on an image service resource
The result of this operation is an image resource. This resource
provides information about the exported image, such as its URL,
extent, width, and height.
In addition to the usual response formats of HTML and JSON, you can
also request the image format while performing this operation. When
you perform an export with the image format , the server responds
by directly streaming the image bytes to the client. With this
approach, you don't get any information associated with the
exported image other than the image itself.
Inputs:
bbox - The extent (bounding box) of the exported image. Unless
the bboxSR parameter has been specified, the bbox is
assumed to be in the spatial reference of the image
service.
imageSR - The spatial reference of the exported image.
bboxSR - The spatial reference of the bbox.
size - The size (width * height) of the exported image in
pixels. If size is not specified, an image with a default
size of 400 * 400 will be exported.
time - The time instant or the time extent of the exported image.
format - The format of the exported image. The default format is
jpgpng.
Values: jpgpng | png | png8 | png24 | jpg | bmp | gif |
tiff | png32
pixelType - The pixel type, also known as data type, pertains to
the type of values stored in the raster, such as
signed integer, unsigned integer, or floating point.
Integers are whole numbers, whereas floating points
have decimals.
noDate - The pixel value representing no information.
noDataInterpretation - Interpretation of the noData setting. The
default is esriNoDataMatchAny when noData is
a number, and esriNoDataMatchAll when noData
is a comma-delimited string:
esriNoDataMatchAny | esriNoDataMatchAll.
interpolation - The resampling process of extrapolating the
pixel values while transforming the raster
dataset when it undergoes warping or when it
changes coordinate space.
compression - Controls how to compress the image when exporting
to TIFF format: None, JPEG, LZ77. It does not
control compression on other formats.
compressionQuality - Controls how much loss the image will be
subjected to by the compression algorithm.
Valid value ranges of compression quality
are from 0 to 100.
bandIds - If there are multiple bands, you can specify a single
band to export, or you can change the band combination
(red, green, blue) by specifying the band number. Band
number is 0 based.
mosaicRule - Specifies the mosaic rule when defining how
individual images should be mosaicked. When a mosaic
rule is not specified, the default mosaic rule of
the image service will be used (as advertised in
the root resource: defaultMosaicMethod,
mosaicOperator, sortField, sortValue).
renderingRule - Specifies the rendering rule for how the
requested image should be rendered.
f - The response format. default is json
Values: json | image | kmz
|
[
"The",
"exportImage",
"operation",
"is",
"performed",
"on",
"an",
"image",
"service",
"resource",
"The",
"result",
"of",
"this",
"operation",
"is",
"an",
"image",
"resource",
".",
"This",
"resource",
"provides",
"information",
"about",
"the",
"exported",
"image",
"such",
"as",
"its",
"URL",
"extent",
"width",
"and",
"height",
".",
"In",
"addition",
"to",
"the",
"usual",
"response",
"formats",
"of",
"HTML",
"and",
"JSON",
"you",
"can",
"also",
"request",
"the",
"image",
"format",
"while",
"performing",
"this",
"operation",
".",
"When",
"you",
"perform",
"an",
"export",
"with",
"the",
"image",
"format",
"the",
"server",
"responds",
"by",
"directly",
"streaming",
"the",
"image",
"bytes",
"to",
"the",
"client",
".",
"With",
"this",
"approach",
"you",
"don",
"t",
"get",
"any",
"information",
"associated",
"with",
"the",
"exported",
"image",
"other",
"than",
"the",
"image",
"itself",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_imageservice.py#L435-L602
|
12,991
|
Esri/ArcREST
|
src/arcrest/ags/_imageservice.py
|
ImageService.measure
|
def measure(self,fromGeometry,toGeometry,measureOperation,
geometryType="esriGeometryPoint",pixelSize=None,mosaicRule=None,
linearUnit=None,angularUnit=None,areaUnit=None):
"""
The measure operation is performed on an image service resource. It
lets a user measure distance, direction, area, perimeter, and height
from an image service. The result of this operation includes the name
of the raster dataset being used, sensor name, and measured values.
The measure operation can be supported by image services from raster
datasets and mosaic datasets. Spatial reference is required to perform
basic measurement (distance, area, and so on). Sensor metadata (geodata
transformation) needs to be present in the data source used by an image
service to enable height measurement (for example, imagery with RPCs).
The mosaic dataset or service needs to include DEM to perform 3D measure.
Users can provide arguments to the measure operation as query parameters.
Inputs:
fromGeometry - A geometry that defines the "from" location of the
measurement. The structure of the geometry is the same as the structure
of the JSON geometry objects returned by the ArcGIS REST API. In addition
to the JSON structures, for points, you can specify the geometry with a
simple comma-separated syntax.
By default, the geometry is assumed to be in the spatial reference of
the image service. You can specify a different spatial reference by
using the JSON structure syntax for geometries.
toGeometry - A geometry that defines the "to" location of the measurement.
The type of geometry must be the same as fromGeometry. The structure of
the geometry is the same as the structure of the JSON geometry objects
returned by the ArcGIS REST API. In addition to the JSON structures, for
points, you can specify the geometry with a simple comma-separated syntax.
By default, the geometry is assumed to be in the spatial reference of
the image service. You can specify a different spatial reference by
using the JSON structure syntax for geometries.
geometryType - The type of geometry specified by the fromGeometry and
toGeometry parameters. The geometry type can be a point, polygon, or
envelope. The default geometry type is point.
Values: esriGeometryPoint | esriGeometryPolygon | esriGeometryEnvelope
measureOperation - Specifies the type of measure being performed.
Values: esriMensurationPoint | esriMensurationDistanceAndAngle |
esriMensurationAreaAndPerimeter | esriMensurationHeightFromBaseAndTop |
esriMensurationHeightFromBaseAndTopShadow |
esriMensurationHeightFromTopAndTopShadow | esriMensurationCentroid |
esriMensurationPoint3D | esriMensurationDistanceAndAngle3D |
esriMensurationAreaAndPerimeter3D | esriMensurationCentroid3D
pixelSize - The pixel level (resolution) being measured. If pixel size
is not specified, pixelSize will default to the base resolution of the
image service. The raster at the specified pixel size in the mosaic
dataset will be used for measurement.
The structure of the pixelSize parameter is the same as the structure
of the point object returned by the ArcGIS REST API. In addition to the
JSON structure, you can specify the pixel size with a simple
comma-separated syntax.
mosaicRule - Specifies the mosaic rule when defining how individual
images should be mosaicked. When a mosaic rule is not specified, the
default mosaic rule of the image service will be used (as advertised
in the root resource: defaultMosaicMethod, mosaicOperator, sortField,
sortValue). The first visible image is used by measure.
linearUnit - The linear unit in which height, length, or perimeters
will be calculated. It can be any of the following esriUnits constant.
If the unit is not specified, the default is esriMeters. The list of
valid esriUnits constants include:
esriInches | esriFeet | esriYards | esriMiles | esriNauticalMiles |
esriMillimeters | esriCentimeters | esriDecimeters | esriMeters |
esriKilometers
angularUnit - The angular unit in which directions of line segments
will be calculated. It can be one of the following esriDirectionUnits
constants: esriDURadians | esriDUDecimalDegrees
If the unit is not specified, the default is esriDUDecimalDegrees.
areaUnit - The area unit in which areas of polygons will be calculated.
It can be any esriAreaUnits constant. If the unit is not specified, the
default is esriSquareMeters. The list of valid esriAreaUnits constants
include:
esriSquareInches | esriSquareFeet | esriSquareYards | esriAcres |
esriSquareMiles | esriSquareMillimeters | esriSquareCentimeters |
esriSquareDecimeters | esriSquareMeters | esriAres | esriHectares |
esriSquareKilometers
"""
url = self._url + "/measure"
params = {
"f" : "json",
"fromGeometry" : fromGeometry,
"toGeometry": toGeometry,
"geometryType": geometryType,
"measureOperation": measureOperation
}
if not pixelSize is None:
params["pixelSize"] = pixelSize
if not mosaicRule is None:
params["mosaicRule"] = mosaicRule
if not linearUnit is None:
params["linearUnit"] = linearUnit
if not angularUnit is None:
params["angularUnit"] = angularUnit
if not areaUnit is None:
params["areaUnit"] = areaUnit
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def measure(self,fromGeometry,toGeometry,measureOperation,
geometryType="esriGeometryPoint",pixelSize=None,mosaicRule=None,
linearUnit=None,angularUnit=None,areaUnit=None):
"""
The measure operation is performed on an image service resource. It
lets a user measure distance, direction, area, perimeter, and height
from an image service. The result of this operation includes the name
of the raster dataset being used, sensor name, and measured values.
The measure operation can be supported by image services from raster
datasets and mosaic datasets. Spatial reference is required to perform
basic measurement (distance, area, and so on). Sensor metadata (geodata
transformation) needs to be present in the data source used by an image
service to enable height measurement (for example, imagery with RPCs).
The mosaic dataset or service needs to include DEM to perform 3D measure.
Users can provide arguments to the measure operation as query parameters.
Inputs:
fromGeometry - A geometry that defines the "from" location of the
measurement. The structure of the geometry is the same as the structure
of the JSON geometry objects returned by the ArcGIS REST API. In addition
to the JSON structures, for points, you can specify the geometry with a
simple comma-separated syntax.
By default, the geometry is assumed to be in the spatial reference of
the image service. You can specify a different spatial reference by
using the JSON structure syntax for geometries.
toGeometry - A geometry that defines the "to" location of the measurement.
The type of geometry must be the same as fromGeometry. The structure of
the geometry is the same as the structure of the JSON geometry objects
returned by the ArcGIS REST API. In addition to the JSON structures, for
points, you can specify the geometry with a simple comma-separated syntax.
By default, the geometry is assumed to be in the spatial reference of
the image service. You can specify a different spatial reference by
using the JSON structure syntax for geometries.
geometryType - The type of geometry specified by the fromGeometry and
toGeometry parameters. The geometry type can be a point, polygon, or
envelope. The default geometry type is point.
Values: esriGeometryPoint | esriGeometryPolygon | esriGeometryEnvelope
measureOperation - Specifies the type of measure being performed.
Values: esriMensurationPoint | esriMensurationDistanceAndAngle |
esriMensurationAreaAndPerimeter | esriMensurationHeightFromBaseAndTop |
esriMensurationHeightFromBaseAndTopShadow |
esriMensurationHeightFromTopAndTopShadow | esriMensurationCentroid |
esriMensurationPoint3D | esriMensurationDistanceAndAngle3D |
esriMensurationAreaAndPerimeter3D | esriMensurationCentroid3D
pixelSize - The pixel level (resolution) being measured. If pixel size
is not specified, pixelSize will default to the base resolution of the
image service. The raster at the specified pixel size in the mosaic
dataset will be used for measurement.
The structure of the pixelSize parameter is the same as the structure
of the point object returned by the ArcGIS REST API. In addition to the
JSON structure, you can specify the pixel size with a simple
comma-separated syntax.
mosaicRule - Specifies the mosaic rule when defining how individual
images should be mosaicked. When a mosaic rule is not specified, the
default mosaic rule of the image service will be used (as advertised
in the root resource: defaultMosaicMethod, mosaicOperator, sortField,
sortValue). The first visible image is used by measure.
linearUnit - The linear unit in which height, length, or perimeters
will be calculated. It can be any of the following esriUnits constant.
If the unit is not specified, the default is esriMeters. The list of
valid esriUnits constants include:
esriInches | esriFeet | esriYards | esriMiles | esriNauticalMiles |
esriMillimeters | esriCentimeters | esriDecimeters | esriMeters |
esriKilometers
angularUnit - The angular unit in which directions of line segments
will be calculated. It can be one of the following esriDirectionUnits
constants: esriDURadians | esriDUDecimalDegrees
If the unit is not specified, the default is esriDUDecimalDegrees.
areaUnit - The area unit in which areas of polygons will be calculated.
It can be any esriAreaUnits constant. If the unit is not specified, the
default is esriSquareMeters. The list of valid esriAreaUnits constants
include:
esriSquareInches | esriSquareFeet | esriSquareYards | esriAcres |
esriSquareMiles | esriSquareMillimeters | esriSquareCentimeters |
esriSquareDecimeters | esriSquareMeters | esriAres | esriHectares |
esriSquareKilometers
"""
url = self._url + "/measure"
params = {
"f" : "json",
"fromGeometry" : fromGeometry,
"toGeometry": toGeometry,
"geometryType": geometryType,
"measureOperation": measureOperation
}
if not pixelSize is None:
params["pixelSize"] = pixelSize
if not mosaicRule is None:
params["mosaicRule"] = mosaicRule
if not linearUnit is None:
params["linearUnit"] = linearUnit
if not angularUnit is None:
params["angularUnit"] = angularUnit
if not areaUnit is None:
params["areaUnit"] = areaUnit
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"measure",
"(",
"self",
",",
"fromGeometry",
",",
"toGeometry",
",",
"measureOperation",
",",
"geometryType",
"=",
"\"esriGeometryPoint\"",
",",
"pixelSize",
"=",
"None",
",",
"mosaicRule",
"=",
"None",
",",
"linearUnit",
"=",
"None",
",",
"angularUnit",
"=",
"None",
",",
"areaUnit",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/measure\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"fromGeometry\"",
":",
"fromGeometry",
",",
"\"toGeometry\"",
":",
"toGeometry",
",",
"\"geometryType\"",
":",
"geometryType",
",",
"\"measureOperation\"",
":",
"measureOperation",
"}",
"if",
"not",
"pixelSize",
"is",
"None",
":",
"params",
"[",
"\"pixelSize\"",
"]",
"=",
"pixelSize",
"if",
"not",
"mosaicRule",
"is",
"None",
":",
"params",
"[",
"\"mosaicRule\"",
"]",
"=",
"mosaicRule",
"if",
"not",
"linearUnit",
"is",
"None",
":",
"params",
"[",
"\"linearUnit\"",
"]",
"=",
"linearUnit",
"if",
"not",
"angularUnit",
"is",
"None",
":",
"params",
"[",
"\"angularUnit\"",
"]",
"=",
"angularUnit",
"if",
"not",
"areaUnit",
"is",
"None",
":",
"params",
"[",
"\"areaUnit\"",
"]",
"=",
"areaUnit",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
The measure operation is performed on an image service resource. It
lets a user measure distance, direction, area, perimeter, and height
from an image service. The result of this operation includes the name
of the raster dataset being used, sensor name, and measured values.
The measure operation can be supported by image services from raster
datasets and mosaic datasets. Spatial reference is required to perform
basic measurement (distance, area, and so on). Sensor metadata (geodata
transformation) needs to be present in the data source used by an image
service to enable height measurement (for example, imagery with RPCs).
The mosaic dataset or service needs to include DEM to perform 3D measure.
Users can provide arguments to the measure operation as query parameters.
Inputs:
fromGeometry - A geometry that defines the "from" location of the
measurement. The structure of the geometry is the same as the structure
of the JSON geometry objects returned by the ArcGIS REST API. In addition
to the JSON structures, for points, you can specify the geometry with a
simple comma-separated syntax.
By default, the geometry is assumed to be in the spatial reference of
the image service. You can specify a different spatial reference by
using the JSON structure syntax for geometries.
toGeometry - A geometry that defines the "to" location of the measurement.
The type of geometry must be the same as fromGeometry. The structure of
the geometry is the same as the structure of the JSON geometry objects
returned by the ArcGIS REST API. In addition to the JSON structures, for
points, you can specify the geometry with a simple comma-separated syntax.
By default, the geometry is assumed to be in the spatial reference of
the image service. You can specify a different spatial reference by
using the JSON structure syntax for geometries.
geometryType - The type of geometry specified by the fromGeometry and
toGeometry parameters. The geometry type can be a point, polygon, or
envelope. The default geometry type is point.
Values: esriGeometryPoint | esriGeometryPolygon | esriGeometryEnvelope
measureOperation - Specifies the type of measure being performed.
Values: esriMensurationPoint | esriMensurationDistanceAndAngle |
esriMensurationAreaAndPerimeter | esriMensurationHeightFromBaseAndTop |
esriMensurationHeightFromBaseAndTopShadow |
esriMensurationHeightFromTopAndTopShadow | esriMensurationCentroid |
esriMensurationPoint3D | esriMensurationDistanceAndAngle3D |
esriMensurationAreaAndPerimeter3D | esriMensurationCentroid3D
pixelSize - The pixel level (resolution) being measured. If pixel size
is not specified, pixelSize will default to the base resolution of the
image service. The raster at the specified pixel size in the mosaic
dataset will be used for measurement.
The structure of the pixelSize parameter is the same as the structure
of the point object returned by the ArcGIS REST API. In addition to the
JSON structure, you can specify the pixel size with a simple
comma-separated syntax.
mosaicRule - Specifies the mosaic rule when defining how individual
images should be mosaicked. When a mosaic rule is not specified, the
default mosaic rule of the image service will be used (as advertised
in the root resource: defaultMosaicMethod, mosaicOperator, sortField,
sortValue). The first visible image is used by measure.
linearUnit - The linear unit in which height, length, or perimeters
will be calculated. It can be any of the following esriUnits constant.
If the unit is not specified, the default is esriMeters. The list of
valid esriUnits constants include:
esriInches | esriFeet | esriYards | esriMiles | esriNauticalMiles |
esriMillimeters | esriCentimeters | esriDecimeters | esriMeters |
esriKilometers
angularUnit - The angular unit in which directions of line segments
will be calculated. It can be one of the following esriDirectionUnits
constants: esriDURadians | esriDUDecimalDegrees
If the unit is not specified, the default is esriDUDecimalDegrees.
areaUnit - The area unit in which areas of polygons will be calculated.
It can be any esriAreaUnits constant. If the unit is not specified, the
default is esriSquareMeters. The list of valid esriAreaUnits constants
include:
esriSquareInches | esriSquareFeet | esriSquareYards | esriAcres |
esriSquareMiles | esriSquareMillimeters | esriSquareCentimeters |
esriSquareDecimeters | esriSquareMeters | esriAres | esriHectares |
esriSquareKilometers
|
[
"The",
"measure",
"operation",
"is",
"performed",
"on",
"an",
"image",
"service",
"resource",
".",
"It",
"lets",
"a",
"user",
"measure",
"distance",
"direction",
"area",
"perimeter",
"and",
"height",
"from",
"an",
"image",
"service",
".",
"The",
"result",
"of",
"this",
"operation",
"includes",
"the",
"name",
"of",
"the",
"raster",
"dataset",
"being",
"used",
"sensor",
"name",
"and",
"measured",
"values",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_imageservice.py#L916-L1030
|
12,992
|
Esri/ArcREST
|
src/arcrest/ags/_imageservice.py
|
ImageService.computeStatisticsHistograms
|
def computeStatisticsHistograms(self,geometry,geometryType,mosaicRule=None,
renderingRule=None,pixelSize=None):
"""
The computeStatisticsHistograms operation is performed on an image service
resource. This operation is supported by any image service published with
mosaic datasets or a raster dataset. The result of this operation contains
both statistics and histograms computed from the given extent.
Inputs:
geometry - A geometry that defines the geometry within which the histogram
is computed. The geometry can be an envelope or a polygon. The structure of
the geometry is the same as the structure of the JSON geometry objects
returned by the ArcGIS REST API.
geometryType - The type of geometry specified by the geometry parameter.
The geometry type can be an envelope or polygon.
Values: esriGeometryEnvelope | esriGeometryPolygon
mosaicRule - Specifies the mosaic rule when defining how individual
images should be mosaicked. When a mosaic rule is not specified, the
default mosaic rule of the image service will be used (as advertised
in the root resource: defaultMosaicMethod, mosaicOperator, sortField,
sortValue).
renderingRule - Specifies the rendering rule for how the requested
image should be rendered.
pixelSize - The pixel level being used (or the resolution being looked at).
If pixel size is not specified, then pixelSize will default to the base
resolution of the dataset. The raster at the specified pixel size in the
mosaic dataset will be used for histogram calculation.
The structure of the pixelSize parameter is the same as the structure of
the point object returned by the ArcGIS REST API. In addition to the JSON
structure, you can specify the pixel size with a simple comma-separated syntax.
"""
url = self._url + "/computeStatisticsHistograms"
params = {
"f" : "json",
"geometry" : geometry,
"geometryType": geometryType
}
if not mosaicRule is None:
params["mosaicRule"] = mosaicRule
if not renderingRule is None:
params["renderingRule"] = renderingRule
if not pixelSize is None:
params["pixelSize"] = pixelSize
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def computeStatisticsHistograms(self,geometry,geometryType,mosaicRule=None,
renderingRule=None,pixelSize=None):
"""
The computeStatisticsHistograms operation is performed on an image service
resource. This operation is supported by any image service published with
mosaic datasets or a raster dataset. The result of this operation contains
both statistics and histograms computed from the given extent.
Inputs:
geometry - A geometry that defines the geometry within which the histogram
is computed. The geometry can be an envelope or a polygon. The structure of
the geometry is the same as the structure of the JSON geometry objects
returned by the ArcGIS REST API.
geometryType - The type of geometry specified by the geometry parameter.
The geometry type can be an envelope or polygon.
Values: esriGeometryEnvelope | esriGeometryPolygon
mosaicRule - Specifies the mosaic rule when defining how individual
images should be mosaicked. When a mosaic rule is not specified, the
default mosaic rule of the image service will be used (as advertised
in the root resource: defaultMosaicMethod, mosaicOperator, sortField,
sortValue).
renderingRule - Specifies the rendering rule for how the requested
image should be rendered.
pixelSize - The pixel level being used (or the resolution being looked at).
If pixel size is not specified, then pixelSize will default to the base
resolution of the dataset. The raster at the specified pixel size in the
mosaic dataset will be used for histogram calculation.
The structure of the pixelSize parameter is the same as the structure of
the point object returned by the ArcGIS REST API. In addition to the JSON
structure, you can specify the pixel size with a simple comma-separated syntax.
"""
url = self._url + "/computeStatisticsHistograms"
params = {
"f" : "json",
"geometry" : geometry,
"geometryType": geometryType
}
if not mosaicRule is None:
params["mosaicRule"] = mosaicRule
if not renderingRule is None:
params["renderingRule"] = renderingRule
if not pixelSize is None:
params["pixelSize"] = pixelSize
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"computeStatisticsHistograms",
"(",
"self",
",",
"geometry",
",",
"geometryType",
",",
"mosaicRule",
"=",
"None",
",",
"renderingRule",
"=",
"None",
",",
"pixelSize",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/computeStatisticsHistograms\"",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"geometry\"",
":",
"geometry",
",",
"\"geometryType\"",
":",
"geometryType",
"}",
"if",
"not",
"mosaicRule",
"is",
"None",
":",
"params",
"[",
"\"mosaicRule\"",
"]",
"=",
"mosaicRule",
"if",
"not",
"renderingRule",
"is",
"None",
":",
"params",
"[",
"\"renderingRule\"",
"]",
"=",
"renderingRule",
"if",
"not",
"pixelSize",
"is",
"None",
":",
"params",
"[",
"\"pixelSize\"",
"]",
"=",
"pixelSize",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
The computeStatisticsHistograms operation is performed on an image service
resource. This operation is supported by any image service published with
mosaic datasets or a raster dataset. The result of this operation contains
both statistics and histograms computed from the given extent.
Inputs:
geometry - A geometry that defines the geometry within which the histogram
is computed. The geometry can be an envelope or a polygon. The structure of
the geometry is the same as the structure of the JSON geometry objects
returned by the ArcGIS REST API.
geometryType - The type of geometry specified by the geometry parameter.
The geometry type can be an envelope or polygon.
Values: esriGeometryEnvelope | esriGeometryPolygon
mosaicRule - Specifies the mosaic rule when defining how individual
images should be mosaicked. When a mosaic rule is not specified, the
default mosaic rule of the image service will be used (as advertised
in the root resource: defaultMosaicMethod, mosaicOperator, sortField,
sortValue).
renderingRule - Specifies the rendering rule for how the requested
image should be rendered.
pixelSize - The pixel level being used (or the resolution being looked at).
If pixel size is not specified, then pixelSize will default to the base
resolution of the dataset. The raster at the specified pixel size in the
mosaic dataset will be used for histogram calculation.
The structure of the pixelSize parameter is the same as the structure of
the point object returned by the ArcGIS REST API. In addition to the JSON
structure, you can specify the pixel size with a simple comma-separated syntax.
|
[
"The",
"computeStatisticsHistograms",
"operation",
"is",
"performed",
"on",
"an",
"image",
"service",
"resource",
".",
"This",
"operation",
"is",
"supported",
"by",
"any",
"image",
"service",
"published",
"with",
"mosaic",
"datasets",
"or",
"a",
"raster",
"dataset",
".",
"The",
"result",
"of",
"this",
"operation",
"contains",
"both",
"statistics",
"and",
"histograms",
"computed",
"from",
"the",
"given",
"extent",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/ags/_imageservice.py#L1089-L1144
|
12,993
|
Esri/ArcREST
|
src/arcrest/agol/_uploads.py
|
Uploads.uploadByParts
|
def uploadByParts(self, registerID, filePath, commit=True):
"""
loads the data by small parts. If commit is set to true,
then parts will be merged together. If commit is false, the
function will return the registerID so a manual commit can occur.
If the user's file is over 10mbs, the uploadByParts should be used.
Inputs:
registerID - ID of the registered item
filePath - path of the file to upload
commit - default True, lets the function know if server will piece
the file back together on the server side.
Output:
dictionary or string
"""
url = self._url + "/%s/uploadPart" % registerID
params = {
"f" : "json"
}
with open(filePath, 'rb') as f:
mm = mmap.mmap(f.fileno(), 0, access=mmap.ACCESS_READ)
size = 1000000
steps = int(os.fstat(f.fileno()).st_size / size)
if os.fstat(f.fileno()).st_size % size > 0:
steps += 1
for i in range(steps):
files = {}
tempFile = os.path.join(os.environ['TEMP'], "split.part%s" % i)
if os.path.isfile(tempFile):
os.remove(tempFile)
with open(tempFile, 'wb') as writer:
writer.write(mm.read(size))
writer.flush()
writer.close()
del writer
files['file'] = tempFile
params['partNum'] = i + 1
res = self._post(url=url,
param_dict=params,
files=files,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
os.remove(tempFile)
del files
del mm
return self.commit(registerID)
|
python
|
def uploadByParts(self, registerID, filePath, commit=True):
"""
loads the data by small parts. If commit is set to true,
then parts will be merged together. If commit is false, the
function will return the registerID so a manual commit can occur.
If the user's file is over 10mbs, the uploadByParts should be used.
Inputs:
registerID - ID of the registered item
filePath - path of the file to upload
commit - default True, lets the function know if server will piece
the file back together on the server side.
Output:
dictionary or string
"""
url = self._url + "/%s/uploadPart" % registerID
params = {
"f" : "json"
}
with open(filePath, 'rb') as f:
mm = mmap.mmap(f.fileno(), 0, access=mmap.ACCESS_READ)
size = 1000000
steps = int(os.fstat(f.fileno()).st_size / size)
if os.fstat(f.fileno()).st_size % size > 0:
steps += 1
for i in range(steps):
files = {}
tempFile = os.path.join(os.environ['TEMP'], "split.part%s" % i)
if os.path.isfile(tempFile):
os.remove(tempFile)
with open(tempFile, 'wb') as writer:
writer.write(mm.read(size))
writer.flush()
writer.close()
del writer
files['file'] = tempFile
params['partNum'] = i + 1
res = self._post(url=url,
param_dict=params,
files=files,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
os.remove(tempFile)
del files
del mm
return self.commit(registerID)
|
[
"def",
"uploadByParts",
"(",
"self",
",",
"registerID",
",",
"filePath",
",",
"commit",
"=",
"True",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/%s/uploadPart\"",
"%",
"registerID",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"with",
"open",
"(",
"filePath",
",",
"'rb'",
")",
"as",
"f",
":",
"mm",
"=",
"mmap",
".",
"mmap",
"(",
"f",
".",
"fileno",
"(",
")",
",",
"0",
",",
"access",
"=",
"mmap",
".",
"ACCESS_READ",
")",
"size",
"=",
"1000000",
"steps",
"=",
"int",
"(",
"os",
".",
"fstat",
"(",
"f",
".",
"fileno",
"(",
")",
")",
".",
"st_size",
"/",
"size",
")",
"if",
"os",
".",
"fstat",
"(",
"f",
".",
"fileno",
"(",
")",
")",
".",
"st_size",
"%",
"size",
">",
"0",
":",
"steps",
"+=",
"1",
"for",
"i",
"in",
"range",
"(",
"steps",
")",
":",
"files",
"=",
"{",
"}",
"tempFile",
"=",
"os",
".",
"path",
".",
"join",
"(",
"os",
".",
"environ",
"[",
"'TEMP'",
"]",
",",
"\"split.part%s\"",
"%",
"i",
")",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
"tempFile",
")",
":",
"os",
".",
"remove",
"(",
"tempFile",
")",
"with",
"open",
"(",
"tempFile",
",",
"'wb'",
")",
"as",
"writer",
":",
"writer",
".",
"write",
"(",
"mm",
".",
"read",
"(",
"size",
")",
")",
"writer",
".",
"flush",
"(",
")",
"writer",
".",
"close",
"(",
")",
"del",
"writer",
"files",
"[",
"'file'",
"]",
"=",
"tempFile",
"params",
"[",
"'partNum'",
"]",
"=",
"i",
"+",
"1",
"res",
"=",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"files",
"=",
"files",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"os",
".",
"remove",
"(",
"tempFile",
")",
"del",
"files",
"del",
"mm",
"return",
"self",
".",
"commit",
"(",
"registerID",
")"
] |
loads the data by small parts. If commit is set to true,
then parts will be merged together. If commit is false, the
function will return the registerID so a manual commit can occur.
If the user's file is over 10mbs, the uploadByParts should be used.
Inputs:
registerID - ID of the registered item
filePath - path of the file to upload
commit - default True, lets the function know if server will piece
the file back together on the server side.
Output:
dictionary or string
|
[
"loads",
"the",
"data",
"by",
"small",
"parts",
".",
"If",
"commit",
"is",
"set",
"to",
"true",
"then",
"parts",
"will",
"be",
"merged",
"together",
".",
"If",
"commit",
"is",
"false",
"the",
"function",
"will",
"return",
"the",
"registerID",
"so",
"a",
"manual",
"commit",
"can",
"occur",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/agol/_uploads.py#L89-L136
|
12,994
|
Esri/ArcREST
|
src/arcrest/agol/services.py
|
FeatureService.uploads
|
def uploads(self):
"""returns the class to perform the upload function. it will
only return the uploads class if syncEnabled is True.
"""
if self.syncEnabled == True:
return Uploads(url=self._url + "/uploads",
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
return None
|
python
|
def uploads(self):
"""returns the class to perform the upload function. it will
only return the uploads class if syncEnabled is True.
"""
if self.syncEnabled == True:
return Uploads(url=self._url + "/uploads",
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
return None
|
[
"def",
"uploads",
"(",
"self",
")",
":",
"if",
"self",
".",
"syncEnabled",
"==",
"True",
":",
"return",
"Uploads",
"(",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/uploads\"",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"return",
"None"
] |
returns the class to perform the upload function. it will
only return the uploads class if syncEnabled is True.
|
[
"returns",
"the",
"class",
"to",
"perform",
"the",
"upload",
"function",
".",
"it",
"will",
"only",
"return",
"the",
"uploads",
"class",
"if",
"syncEnabled",
"is",
"True",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/agol/services.py#L287-L296
|
12,995
|
Esri/ArcREST
|
src/arcrest/agol/services.py
|
FeatureService.administration
|
def administration(self):
"""returns the hostservice object to manage the back-end functions"""
url = self._url
res = search("/rest/", url).span()
addText = "admin/"
part1 = url[:res[1]]
part2 = url[res[1]:]
adminURL = "%s%s%s" % (part1, addText, part2)
res = AdminFeatureService(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=False)
return res
|
python
|
def administration(self):
"""returns the hostservice object to manage the back-end functions"""
url = self._url
res = search("/rest/", url).span()
addText = "admin/"
part1 = url[:res[1]]
part2 = url[res[1]:]
adminURL = "%s%s%s" % (part1, addText, part2)
res = AdminFeatureService(url=url,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
initialize=False)
return res
|
[
"def",
"administration",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"_url",
"res",
"=",
"search",
"(",
"\"/rest/\"",
",",
"url",
")",
".",
"span",
"(",
")",
"addText",
"=",
"\"admin/\"",
"part1",
"=",
"url",
"[",
":",
"res",
"[",
"1",
"]",
"]",
"part2",
"=",
"url",
"[",
"res",
"[",
"1",
"]",
":",
"]",
"adminURL",
"=",
"\"%s%s%s\"",
"%",
"(",
"part1",
",",
"addText",
",",
"part2",
")",
"res",
"=",
"AdminFeatureService",
"(",
"url",
"=",
"url",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"initialize",
"=",
"False",
")",
"return",
"res"
] |
returns the hostservice object to manage the back-end functions
|
[
"returns",
"the",
"hostservice",
"object",
"to",
"manage",
"the",
"back",
"-",
"end",
"functions"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/agol/services.py#L405-L419
|
12,996
|
Esri/ArcREST
|
src/arcrest/agol/services.py
|
FeatureService.replicas
|
def replicas(self):
""" returns all the replicas for a feature service """
params = {
"f" : "json",
}
url = self._url + "/replicas"
return self._get(url, params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
python
|
def replicas(self):
""" returns all the replicas for a feature service """
params = {
"f" : "json",
}
url = self._url + "/replicas"
return self._get(url, params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
|
[
"def",
"replicas",
"(",
"self",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"}",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/replicas\"",
"return",
"self",
".",
"_get",
"(",
"url",
",",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")"
] |
returns all the replicas for a feature service
|
[
"returns",
"all",
"the",
"replicas",
"for",
"a",
"feature",
"service"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/agol/services.py#L585-L595
|
12,997
|
Esri/ArcREST
|
src/arcrest/agol/services.py
|
FeatureService.createReplica
|
def createReplica(self,
replicaName,
layers,
layerQueries=None,
geometryFilter=None,
replicaSR=None,
transportType="esriTransportTypeUrl",
returnAttachments=False,
returnAttachmentsDatabyURL=False,
async=False,
attachmentsSyncDirection="none",
syncModel="none",
dataFormat="json",
replicaOptions=None,
wait=False,
out_path=None):
"""
The createReplica operation is performed on a feature service
resource. This operation creates the replica between the feature
service and a client based on a client-supplied replica definition.
It requires the Sync capability. See Sync overview for more
information on sync. The response for createReplica includes
replicaID, server generation number, and data similar to the
response from the feature service query operation.
The createReplica operation returns a response of type
esriReplicaResponseTypeData, as the response has data for the
layers in the replica. If the operation is called to register
existing data by using replicaOptions, the response type will be
esriReplicaResponseTypeInfo, and the response will not contain data
for the layers in the replica.
Inputs:
replicaName - name of the replica
layers - layers to export
layerQueries - In addition to the layers and geometry parameters, the layerQueries
parameter can be used to further define what is replicated. This
parameter allows you to set properties on a per layer or per table
basis. Only the properties for the layers and tables that you want
changed from the default are required.
Example:
layerQueries = {"0":{"queryOption": "useFilter", "useGeometry": true,
"where": "requires_inspection = Yes"}}
geometryFilter - Geospatial filter applied to the replica to
parse down data output.
returnAttachments - If true, attachments are added to the replica and returned in the
response. Otherwise, attachments are not included.
returnAttachmentDatabyURL - If true, a reference to a URL will be provided for each
attachment returned from createReplica. Otherwise,
attachments are embedded in the response.
replicaSR - the spatial reference of the replica geometry.
transportType - The transportType represents the response format. If the
transportType is esriTransportTypeUrl, the JSON response is contained in a file,
and the URL link to the file is returned. Otherwise, the JSON object is returned
directly. The default is esriTransportTypeUrl.
If async is true, the results will always be returned as if transportType is
esriTransportTypeUrl. If dataFormat is sqlite, the transportFormat will always be
esriTransportTypeUrl regardless of how the parameter is set.
Values: esriTransportTypeUrl | esriTransportTypeEmbedded
returnAttachments - If true, attachments are added to the replica and returned in
the response. Otherwise, attachments are not included. The default is false. This
parameter is only applicable if the feature service has attachments.
returnAttachmentsDatabyURL - If true, a reference to a URL will be provided for
each attachment returned from createReplica. Otherwise, attachments are embedded
in the response. The default is true. This parameter is only applicable if the
feature service has attachments and if returnAttachments is true.
attachmentsSyncDirection - Client can specify the attachmentsSyncDirection when
creating a replica. AttachmentsSyncDirection is currently a createReplica property
and cannot be overridden during sync.
Values: none, upload, bidirectional
async - If true, the request is processed as an asynchronous job, and a URL is
returned that a client can visit to check the status of the job. See the topic on
asynchronous usage for more information. The default is false.
syncModel - Client can specify the attachmentsSyncDirection when creating a replica.
AttachmentsSyncDirection is currently a createReplica property and cannot be
overridden during sync.
dataFormat - The format of the replica geodatabase returned in the response. The
default is json.
Values: filegdb, json, sqlite, shapefile
replicaOptions - This parameter instructs the createReplica operation to create a
new replica based on an existing replica definition (refReplicaId). It can be used
to specify parameters for registration of existing data for sync. The operation
will create a replica but will not return data. The responseType returned in the
createReplica response will be esriReplicaResponseTypeInfo.
wait - if async, wait to pause the process until the async operation is completed.
out_path - folder path to save the file
"""
if self.syncEnabled == False and "Extract" not in self.capabilities:
return None
url = self._url + "/createReplica"
dataformat = ["filegdb", "json", "sqlite", "shapefile"]
params = {"f" : "json",
"replicaName": replicaName,
"returnAttachments": returnAttachments,
"returnAttachmentsDatabyURL": returnAttachmentsDatabyURL,
"attachmentsSyncDirection" : attachmentsSyncDirection,
"async" : async,
"syncModel" : syncModel,
"layers" : layers
}
if dataFormat.lower() in dataformat:
params['dataFormat'] = dataFormat.lower()
else:
raise Exception("Invalid dataFormat")
if layerQueries is not None:
params['layerQueries'] = layerQueries
if geometryFilter is not None and \
isinstance(geometryFilter, GeometryFilter):
params.update(geometryFilter.filter)
if replicaSR is not None:
params['replicaSR'] = replicaSR
if replicaOptions is not None:
params['replicaOptions'] = replicaOptions
if transportType is not None:
params['transportType'] = transportType
if async:
if wait:
exportJob = self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
status = self.replicaStatus(url=exportJob['statusUrl'])
while status['status'].lower() != "completed":
status = self.replicaStatus(url=exportJob['statusUrl'])
if status['status'].lower() == "failed":
return status
res = status
else:
res = self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
else:
res = self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
if out_path is not None and \
os.path.isdir(out_path):
dlURL = None
if 'resultUrl' in res:
dlURL = res["resultUrl"]
elif 'responseUrl' in res:
dlURL = res["responseUrl"]
elif 'URL' in res:
dlURL = res["URL"]
if dlURL is not None:
return self._get(url=dlURL,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
out_folder=out_path)
else:
return res
elif res is not None:
return res
return None
|
python
|
def createReplica(self,
replicaName,
layers,
layerQueries=None,
geometryFilter=None,
replicaSR=None,
transportType="esriTransportTypeUrl",
returnAttachments=False,
returnAttachmentsDatabyURL=False,
async=False,
attachmentsSyncDirection="none",
syncModel="none",
dataFormat="json",
replicaOptions=None,
wait=False,
out_path=None):
"""
The createReplica operation is performed on a feature service
resource. This operation creates the replica between the feature
service and a client based on a client-supplied replica definition.
It requires the Sync capability. See Sync overview for more
information on sync. The response for createReplica includes
replicaID, server generation number, and data similar to the
response from the feature service query operation.
The createReplica operation returns a response of type
esriReplicaResponseTypeData, as the response has data for the
layers in the replica. If the operation is called to register
existing data by using replicaOptions, the response type will be
esriReplicaResponseTypeInfo, and the response will not contain data
for the layers in the replica.
Inputs:
replicaName - name of the replica
layers - layers to export
layerQueries - In addition to the layers and geometry parameters, the layerQueries
parameter can be used to further define what is replicated. This
parameter allows you to set properties on a per layer or per table
basis. Only the properties for the layers and tables that you want
changed from the default are required.
Example:
layerQueries = {"0":{"queryOption": "useFilter", "useGeometry": true,
"where": "requires_inspection = Yes"}}
geometryFilter - Geospatial filter applied to the replica to
parse down data output.
returnAttachments - If true, attachments are added to the replica and returned in the
response. Otherwise, attachments are not included.
returnAttachmentDatabyURL - If true, a reference to a URL will be provided for each
attachment returned from createReplica. Otherwise,
attachments are embedded in the response.
replicaSR - the spatial reference of the replica geometry.
transportType - The transportType represents the response format. If the
transportType is esriTransportTypeUrl, the JSON response is contained in a file,
and the URL link to the file is returned. Otherwise, the JSON object is returned
directly. The default is esriTransportTypeUrl.
If async is true, the results will always be returned as if transportType is
esriTransportTypeUrl. If dataFormat is sqlite, the transportFormat will always be
esriTransportTypeUrl regardless of how the parameter is set.
Values: esriTransportTypeUrl | esriTransportTypeEmbedded
returnAttachments - If true, attachments are added to the replica and returned in
the response. Otherwise, attachments are not included. The default is false. This
parameter is only applicable if the feature service has attachments.
returnAttachmentsDatabyURL - If true, a reference to a URL will be provided for
each attachment returned from createReplica. Otherwise, attachments are embedded
in the response. The default is true. This parameter is only applicable if the
feature service has attachments and if returnAttachments is true.
attachmentsSyncDirection - Client can specify the attachmentsSyncDirection when
creating a replica. AttachmentsSyncDirection is currently a createReplica property
and cannot be overridden during sync.
Values: none, upload, bidirectional
async - If true, the request is processed as an asynchronous job, and a URL is
returned that a client can visit to check the status of the job. See the topic on
asynchronous usage for more information. The default is false.
syncModel - Client can specify the attachmentsSyncDirection when creating a replica.
AttachmentsSyncDirection is currently a createReplica property and cannot be
overridden during sync.
dataFormat - The format of the replica geodatabase returned in the response. The
default is json.
Values: filegdb, json, sqlite, shapefile
replicaOptions - This parameter instructs the createReplica operation to create a
new replica based on an existing replica definition (refReplicaId). It can be used
to specify parameters for registration of existing data for sync. The operation
will create a replica but will not return data. The responseType returned in the
createReplica response will be esriReplicaResponseTypeInfo.
wait - if async, wait to pause the process until the async operation is completed.
out_path - folder path to save the file
"""
if self.syncEnabled == False and "Extract" not in self.capabilities:
return None
url = self._url + "/createReplica"
dataformat = ["filegdb", "json", "sqlite", "shapefile"]
params = {"f" : "json",
"replicaName": replicaName,
"returnAttachments": returnAttachments,
"returnAttachmentsDatabyURL": returnAttachmentsDatabyURL,
"attachmentsSyncDirection" : attachmentsSyncDirection,
"async" : async,
"syncModel" : syncModel,
"layers" : layers
}
if dataFormat.lower() in dataformat:
params['dataFormat'] = dataFormat.lower()
else:
raise Exception("Invalid dataFormat")
if layerQueries is not None:
params['layerQueries'] = layerQueries
if geometryFilter is not None and \
isinstance(geometryFilter, GeometryFilter):
params.update(geometryFilter.filter)
if replicaSR is not None:
params['replicaSR'] = replicaSR
if replicaOptions is not None:
params['replicaOptions'] = replicaOptions
if transportType is not None:
params['transportType'] = transportType
if async:
if wait:
exportJob = self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
status = self.replicaStatus(url=exportJob['statusUrl'])
while status['status'].lower() != "completed":
status = self.replicaStatus(url=exportJob['statusUrl'])
if status['status'].lower() == "failed":
return status
res = status
else:
res = self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
else:
res = self._post(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port)
if out_path is not None and \
os.path.isdir(out_path):
dlURL = None
if 'resultUrl' in res:
dlURL = res["resultUrl"]
elif 'responseUrl' in res:
dlURL = res["responseUrl"]
elif 'URL' in res:
dlURL = res["URL"]
if dlURL is not None:
return self._get(url=dlURL,
securityHandler=self._securityHandler,
proxy_url=self._proxy_url,
proxy_port=self._proxy_port,
out_folder=out_path)
else:
return res
elif res is not None:
return res
return None
|
[
"def",
"createReplica",
"(",
"self",
",",
"replicaName",
",",
"layers",
",",
"layerQueries",
"=",
"None",
",",
"geometryFilter",
"=",
"None",
",",
"replicaSR",
"=",
"None",
",",
"transportType",
"=",
"\"esriTransportTypeUrl\"",
",",
"returnAttachments",
"=",
"False",
",",
"returnAttachmentsDatabyURL",
"=",
"False",
",",
"async",
"=",
"False",
",",
"attachmentsSyncDirection",
"=",
"\"none\"",
",",
"syncModel",
"=",
"\"none\"",
",",
"dataFormat",
"=",
"\"json\"",
",",
"replicaOptions",
"=",
"None",
",",
"wait",
"=",
"False",
",",
"out_path",
"=",
"None",
")",
":",
"if",
"self",
".",
"syncEnabled",
"==",
"False",
"and",
"\"Extract\"",
"not",
"in",
"self",
".",
"capabilities",
":",
"return",
"None",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/createReplica\"",
"dataformat",
"=",
"[",
"\"filegdb\"",
",",
"\"json\"",
",",
"\"sqlite\"",
",",
"\"shapefile\"",
"]",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
",",
"\"replicaName\"",
":",
"replicaName",
",",
"\"returnAttachments\"",
":",
"returnAttachments",
",",
"\"returnAttachmentsDatabyURL\"",
":",
"returnAttachmentsDatabyURL",
",",
"\"attachmentsSyncDirection\"",
":",
"attachmentsSyncDirection",
",",
"\"async\"",
":",
"async",
",",
"\"syncModel\"",
":",
"syncModel",
",",
"\"layers\"",
":",
"layers",
"}",
"if",
"dataFormat",
".",
"lower",
"(",
")",
"in",
"dataformat",
":",
"params",
"[",
"'dataFormat'",
"]",
"=",
"dataFormat",
".",
"lower",
"(",
")",
"else",
":",
"raise",
"Exception",
"(",
"\"Invalid dataFormat\"",
")",
"if",
"layerQueries",
"is",
"not",
"None",
":",
"params",
"[",
"'layerQueries'",
"]",
"=",
"layerQueries",
"if",
"geometryFilter",
"is",
"not",
"None",
"and",
"isinstance",
"(",
"geometryFilter",
",",
"GeometryFilter",
")",
":",
"params",
".",
"update",
"(",
"geometryFilter",
".",
"filter",
")",
"if",
"replicaSR",
"is",
"not",
"None",
":",
"params",
"[",
"'replicaSR'",
"]",
"=",
"replicaSR",
"if",
"replicaOptions",
"is",
"not",
"None",
":",
"params",
"[",
"'replicaOptions'",
"]",
"=",
"replicaOptions",
"if",
"transportType",
"is",
"not",
"None",
":",
"params",
"[",
"'transportType'",
"]",
"=",
"transportType",
"if",
"async",
":",
"if",
"wait",
":",
"exportJob",
"=",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"status",
"=",
"self",
".",
"replicaStatus",
"(",
"url",
"=",
"exportJob",
"[",
"'statusUrl'",
"]",
")",
"while",
"status",
"[",
"'status'",
"]",
".",
"lower",
"(",
")",
"!=",
"\"completed\"",
":",
"status",
"=",
"self",
".",
"replicaStatus",
"(",
"url",
"=",
"exportJob",
"[",
"'statusUrl'",
"]",
")",
"if",
"status",
"[",
"'status'",
"]",
".",
"lower",
"(",
")",
"==",
"\"failed\"",
":",
"return",
"status",
"res",
"=",
"status",
"else",
":",
"res",
"=",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"else",
":",
"res",
"=",
"self",
".",
"_post",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
")",
"if",
"out_path",
"is",
"not",
"None",
"and",
"os",
".",
"path",
".",
"isdir",
"(",
"out_path",
")",
":",
"dlURL",
"=",
"None",
"if",
"'resultUrl'",
"in",
"res",
":",
"dlURL",
"=",
"res",
"[",
"\"resultUrl\"",
"]",
"elif",
"'responseUrl'",
"in",
"res",
":",
"dlURL",
"=",
"res",
"[",
"\"responseUrl\"",
"]",
"elif",
"'URL'",
"in",
"res",
":",
"dlURL",
"=",
"res",
"[",
"\"URL\"",
"]",
"if",
"dlURL",
"is",
"not",
"None",
":",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"dlURL",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"out_folder",
"=",
"out_path",
")",
"else",
":",
"return",
"res",
"elif",
"res",
"is",
"not",
"None",
":",
"return",
"res",
"return",
"None"
] |
The createReplica operation is performed on a feature service
resource. This operation creates the replica between the feature
service and a client based on a client-supplied replica definition.
It requires the Sync capability. See Sync overview for more
information on sync. The response for createReplica includes
replicaID, server generation number, and data similar to the
response from the feature service query operation.
The createReplica operation returns a response of type
esriReplicaResponseTypeData, as the response has data for the
layers in the replica. If the operation is called to register
existing data by using replicaOptions, the response type will be
esriReplicaResponseTypeInfo, and the response will not contain data
for the layers in the replica.
Inputs:
replicaName - name of the replica
layers - layers to export
layerQueries - In addition to the layers and geometry parameters, the layerQueries
parameter can be used to further define what is replicated. This
parameter allows you to set properties on a per layer or per table
basis. Only the properties for the layers and tables that you want
changed from the default are required.
Example:
layerQueries = {"0":{"queryOption": "useFilter", "useGeometry": true,
"where": "requires_inspection = Yes"}}
geometryFilter - Geospatial filter applied to the replica to
parse down data output.
returnAttachments - If true, attachments are added to the replica and returned in the
response. Otherwise, attachments are not included.
returnAttachmentDatabyURL - If true, a reference to a URL will be provided for each
attachment returned from createReplica. Otherwise,
attachments are embedded in the response.
replicaSR - the spatial reference of the replica geometry.
transportType - The transportType represents the response format. If the
transportType is esriTransportTypeUrl, the JSON response is contained in a file,
and the URL link to the file is returned. Otherwise, the JSON object is returned
directly. The default is esriTransportTypeUrl.
If async is true, the results will always be returned as if transportType is
esriTransportTypeUrl. If dataFormat is sqlite, the transportFormat will always be
esriTransportTypeUrl regardless of how the parameter is set.
Values: esriTransportTypeUrl | esriTransportTypeEmbedded
returnAttachments - If true, attachments are added to the replica and returned in
the response. Otherwise, attachments are not included. The default is false. This
parameter is only applicable if the feature service has attachments.
returnAttachmentsDatabyURL - If true, a reference to a URL will be provided for
each attachment returned from createReplica. Otherwise, attachments are embedded
in the response. The default is true. This parameter is only applicable if the
feature service has attachments and if returnAttachments is true.
attachmentsSyncDirection - Client can specify the attachmentsSyncDirection when
creating a replica. AttachmentsSyncDirection is currently a createReplica property
and cannot be overridden during sync.
Values: none, upload, bidirectional
async - If true, the request is processed as an asynchronous job, and a URL is
returned that a client can visit to check the status of the job. See the topic on
asynchronous usage for more information. The default is false.
syncModel - Client can specify the attachmentsSyncDirection when creating a replica.
AttachmentsSyncDirection is currently a createReplica property and cannot be
overridden during sync.
dataFormat - The format of the replica geodatabase returned in the response. The
default is json.
Values: filegdb, json, sqlite, shapefile
replicaOptions - This parameter instructs the createReplica operation to create a
new replica based on an existing replica definition (refReplicaId). It can be used
to specify parameters for registration of existing data for sync. The operation
will create a replica but will not return data. The responseType returned in the
createReplica response will be esriReplicaResponseTypeInfo.
wait - if async, wait to pause the process until the async operation is completed.
out_path - folder path to save the file
|
[
"The",
"createReplica",
"operation",
"is",
"performed",
"on",
"a",
"feature",
"service",
"resource",
".",
"This",
"operation",
"creates",
"the",
"replica",
"between",
"the",
"feature",
"service",
"and",
"a",
"client",
"based",
"on",
"a",
"client",
"-",
"supplied",
"replica",
"definition",
".",
"It",
"requires",
"the",
"Sync",
"capability",
".",
"See",
"Sync",
"overview",
"for",
"more",
"information",
"on",
"sync",
".",
"The",
"response",
"for",
"createReplica",
"includes",
"replicaID",
"server",
"generation",
"number",
"and",
"data",
"similar",
"to",
"the",
"response",
"from",
"the",
"feature",
"service",
"query",
"operation",
".",
"The",
"createReplica",
"operation",
"returns",
"a",
"response",
"of",
"type",
"esriReplicaResponseTypeData",
"as",
"the",
"response",
"has",
"data",
"for",
"the",
"layers",
"in",
"the",
"replica",
".",
"If",
"the",
"operation",
"is",
"called",
"to",
"register",
"existing",
"data",
"by",
"using",
"replicaOptions",
"the",
"response",
"type",
"will",
"be",
"esriReplicaResponseTypeInfo",
"and",
"the",
"response",
"will",
"not",
"contain",
"data",
"for",
"the",
"layers",
"in",
"the",
"replica",
"."
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/agol/services.py#L631-L794
|
12,998
|
Esri/ArcREST
|
src/arcrest/agol/services.py
|
FeatureService.replicaStatus
|
def replicaStatus(self, url):
"""gets the replica status when exported async set to True"""
params = {"f" : "json"}
url = url + "/status"
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def replicaStatus(self, url):
"""gets the replica status when exported async set to True"""
params = {"f" : "json"}
url = url + "/status"
return self._get(url=url,
param_dict=params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"replicaStatus",
"(",
"self",
",",
"url",
")",
":",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"url",
"=",
"url",
"+",
"\"/status\"",
"return",
"self",
".",
"_get",
"(",
"url",
"=",
"url",
",",
"param_dict",
"=",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
gets the replica status when exported async set to True
|
[
"gets",
"the",
"replica",
"status",
"when",
"exported",
"async",
"set",
"to",
"True"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/agol/services.py#L827-L835
|
12,999
|
Esri/ArcREST
|
src/arcrest/agol/services.py
|
FeatureLayer.listAttachments
|
def listAttachments(self, oid):
""" list attachements for a given OBJECT ID """
url = self._url + "/%s/attachments" % oid
params = {
"f":"json"
}
return self._get(url, params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
python
|
def listAttachments(self, oid):
""" list attachements for a given OBJECT ID """
url = self._url + "/%s/attachments" % oid
params = {
"f":"json"
}
return self._get(url, params,
securityHandler=self._securityHandler,
proxy_port=self._proxy_port,
proxy_url=self._proxy_url)
|
[
"def",
"listAttachments",
"(",
"self",
",",
"oid",
")",
":",
"url",
"=",
"self",
".",
"_url",
"+",
"\"/%s/attachments\"",
"%",
"oid",
"params",
"=",
"{",
"\"f\"",
":",
"\"json\"",
"}",
"return",
"self",
".",
"_get",
"(",
"url",
",",
"params",
",",
"securityHandler",
"=",
"self",
".",
"_securityHandler",
",",
"proxy_port",
"=",
"self",
".",
"_proxy_port",
",",
"proxy_url",
"=",
"self",
".",
"_proxy_url",
")"
] |
list attachements for a given OBJECT ID
|
[
"list",
"attachements",
"for",
"a",
"given",
"OBJECT",
"ID"
] |
ab240fde2b0200f61d4a5f6df033516e53f2f416
|
https://github.com/Esri/ArcREST/blob/ab240fde2b0200f61d4a5f6df033516e53f2f416/src/arcrest/agol/services.py#L1539-L1548
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.