Interface

class pyvo.io.vosi.voresource.Interface(*args, **kwargs)[source]

Bases: ElementWithXSIType

Interface element as described in http://www.ivoa.net/xml/VOResource/v1.0

A description of a service interface.

Since this type is abstract, one must use an Interface subclassto describe an actual interface.

Additional interface subtypes (beyond WebService and WebBrowser) are defined in the VODataService schema.

Attributes Summary

accessurls

A list of access urls in the interface.

mirrorurls

mirror(s) for this access URL.

resulttype

The MIME type of a document returned in the HTTP response.

role

A tag name the identifies the role the interface plays in the particular capability.

securitymethods

the mechanism the client must employ to gain secure access to the service.

testquerystring

a string to be used in an interface-specific way to obtain a non-empty result from the service.

version

The version of a standard interface specification that this interface complies with.

Methods Summary

describe()

Prints out a human readable description

Attributes Documentation

accessurls

A list of access urls in the interface. Must contain only AccessURL objects.

mirrorurls

mirror(s) for this access URL.

resulttype

The MIME type of a document returned in the HTTP response.

role

A tag name the identifies the role the interface plays in the particular capability. If the value is equal to “std” or begins with “std:”, then the interface refers to a standard interface defined by the standard referred to by the capability’s standardID attribute.

For an interface complying with some registered standard (i.e. has a legal standardID), the role can be match against interface roles enumerated in standard resource record. The interface descriptions in the standard record can provide default descriptions so that such details need not be repeated here.

securitymethods

the mechanism the client must employ to gain secure access to the service.

when more than one method is listed, each one must be employed to gain access.

testquerystring

a string to be used in an interface-specific way to obtain a non-empty result from the service.

version

The version of a standard interface specification that this interface complies with. When the interface is provided in the context of a Capability element, then the standard being refered to is the one identified by the Capability’s standardID element. If the standardID is not provided, the meaning of this attribute is undefined.

Methods Documentation

describe()[source]

Prints out a human readable description