StreamLink (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.DataValue
- - com.sap.cloud.server.odata.StreamLink

```
public class StreamLink
extends DataValue
```
Represents a link to the value of a media entity resource or a stream-typed property.

See Also:

EntityType.isMedia, Property.isStream.

Field Summary
- Fields inherited from class com.sap.cloud.server.odata.DataValue
  undefined

Constructor Summary

Constructors
Constructor and Description

StreamLink()

Constructors
Constructor and Description
`StreamLink()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamLink`	`copyLink()` Return a copy of this stream link.
`static boolean`	`equal(StreamLink a, StreamLink b)` Return `true` if two stream links have equal read/edit links.
`DataType`	`getDataType()` Return the type BasicType.STREAM_LINK.
`java.lang.String`	`getEditLink()` Return (nullable) The edit link for this value, preferably relative to the service root URL.
`EntitySet`	`getEntitySet()` Return (nullable) Which entity set does this stream link belong to?
`java.lang.String`	`getEntityTag()` Return (nullable) Server-generated entity tag for this entity.
`byte[]`	`getInlineData()` Return (nullable) Inline binary content if known, otherwise `null`.
`java.lang.String`	`getInlineText()` Return (nullable) Inline string content if known, otherwise `null`.
`java.lang.String`	`getMediaType()` Return (nullable) Media type if known, otherwise `null`.
`StructureType`	`getOwningType()` Return which structure type does this stream link belong to?
`java.lang.String`	`getReadLink()` Return (nullable) The read link for this value, preferably relative to the service root URL.
`StreamProperty`	`getStreamProperty()` Return which stream property does this stream link belong to?
`int`	`getTypeCode()` Return data type code of the wrapped value, equivalent to `dataType.code`.
`java.lang.String`	`getValuePath()` Return (nullable) The canonical path of this value relative to the parent entity URL.
`boolean`	`isDeleted()` Return if the stream content has been (or is being) deleted, then `true`, otherwise `false`.
`boolean`	`isOffline()` Return if the stream content is available offline, then `true`, otherwise `false`.
`void`	`setDeleted(boolean value)` Set if the stream content has been (or is being) deleted, then `true`, otherwise `false`.
`void`	`setEditLink(java.lang.String value)` Set the edit link for this value, preferably relative to the service root URL.
`void`	`setEntitySet(EntitySet value)` Set which entity set does this stream link belong to?
`void`	`setEntityTag(java.lang.String value)` Set server-generated entity tag for this entity.
`void`	`setInlineData(byte[] value)` Set inline binary content if known, otherwise `null`.
`void`	`setInlineText(java.lang.String value)` Set inline string content if known, otherwise `null`.
`void`	`setMediaType(java.lang.String value)` Set media type if known, otherwise `null`.
`void`	`setOffline(boolean value)` Set if the stream content is available offline, then `true`, otherwise `false`.
`void`	`setOwningType(StructureType value)` Set which structure type does this stream link belong to?
`void`	`setReadLink(java.lang.String value)` Set the read link for this value, preferably relative to the service root URL.
`void`	`setStreamProperty(StreamProperty value)` Set which stream property does this stream link belong to?
`void`	`setValuePath(java.lang.String value)` Set the canonical path of this value relative to the parent entity URL.
`java.lang.String`	`toString()` Convert this data value to a string.

Methods inherited from class com.sap.cloud.server.odata.DataValue
cloneMutable, equals, hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StreamLink
```
public StreamLink()
```
- Method Detail
  - copyLink
```
public StreamLink copyLink()
```
    Return a copy of this stream link.
    
    Returns:
    
    A copy of this stream link.
  - equal
```
public static boolean equal(StreamLink a,
                            StreamLink b)
```
    Return true if two stream links have equal read/edit links.
    
    Parameters:
    
    a - (nullable) First stream link.
    
    b - (nullable) Second stream link.
    
    Returns:
    
    true if two stream links have equal read/edit links.
  - getDataType
```
public DataType getDataType()
```
    Return the type BasicType.STREAM_LINK.
    
    Specified by:
    
    getDataType in class DataValue
    
    Returns:
    
    The type BasicType.STREAM_LINK.
  - getEditLink
```
public java.lang.String getEditLink()
```
    Return (nullable) The edit link for this value, preferably relative to the service root URL. If a stream does not have an explicit edit link, then writers should use the StreamLink.valuePath, or if that is not set, then a canonical URL (refer to the OData specification).
    
    Returns:
    
    (nullable) The edit link for this value, preferably relative to the service root URL.
  - getEntitySet
```
public EntitySet getEntitySet()
```
    Return (nullable) Which entity set does this stream link belong to?
    
    Returns:
    
    (nullable) Which entity set does this stream link belong to?
  - getEntityTag
```
public java.lang.String getEntityTag()
```
    Return (nullable) Server-generated entity tag for this entity. If non-null, it is used for conflict detection during DataService.uploadMedia and DataService.uploadStream calls.
    
    Returns:
    
    (nullable) Server-generated entity tag for this entity.
  - getInlineData
```
public byte[] getInlineData()
```
    Return (nullable) Inline binary content if known, otherwise null.
    
    Returns:
    
    (nullable) Inline binary content if known, otherwise null.
  - getInlineText
```
public java.lang.String getInlineText()
```
    Return (nullable) Inline string content if known, otherwise null.
    
    Returns:
    
    (nullable) Inline string content if known, otherwise null.
  - getMediaType
```
public java.lang.String getMediaType()
```
    Return (nullable) Media type if known, otherwise null.
    
    See Also:
    
    Internet media type.
    
    Returns:
    
    (nullable) Media type if known, otherwise `null`.
  - getOwningType
```
public StructureType getOwningType()
```
    Return which structure type does this stream link belong to?
    
    Returns:
    
    Which structure type does this stream link belong to?
  - getReadLink
```
public java.lang.String getReadLink()
```
    Return (nullable) The read link for this value, preferably relative to the service root URL. If a stream does not have an explicit read link, then readers should use the StreamLink.valuePath, or if that is not set, then a canonical URL (refer to the OData specification).
    
    Returns:
    
    (nullable) The read link for this value, preferably relative to the service root URL.
  - getStreamProperty
```
public StreamProperty getStreamProperty()
```
    Return which stream property does this stream link belong to?
    
    Returns:
    
    Which stream property does this stream link belong to?
  - getTypeCode
```
public int getTypeCode()
```
    Return data type code of the wrapped value, equivalent to dataType.code.
    
    Overrides:
    
    getTypeCode in class DataValue
    
    Returns:
    
    Data type code of the wrapped value, equivalent to dataType.code.
  - getValuePath
```
public java.lang.String getValuePath()
```
    Return (nullable) The canonical path of this value relative to the parent entity URL.
    
    Returns:
    
    (nullable) The canonical path of this value relative to the parent entity URL.
  - isDeleted
```
public boolean isDeleted()
```
    Return if the stream content has been (or is being) deleted, then true, otherwise false.
    
    Returns:
    
    If the stream content has been (or is being) deleted, then true, otherwise false.
  - isOffline
```
public boolean isOffline()
```
    Return if the stream content is available offline, then true, otherwise false.
    
    Returns:
    
    If the stream content is available offline, then true, otherwise false.
  - setDeleted
```
public void setDeleted(boolean value)
```
    Set if the stream content has been (or is being) deleted, then true, otherwise false.
    
    Parameters:
    
    value - If the stream content has been (or is being) deleted, then true, otherwise false.
  - setEditLink
```
public void setEditLink(java.lang.String value)
```
    Set the edit link for this value, preferably relative to the service root URL. If a stream does not have an explicit edit link, then writers should use the StreamLink.valuePath, or if that is not set, then a canonical URL (refer to the OData specification).
    
    Parameters:
    
    value - The edit link for this value, preferably relative to the service root URL.
  - setEntitySet
```
public void setEntitySet(EntitySet value)
```
    Set which entity set does this stream link belong to?
    
    Parameters:
    
    value - Which entity set does this stream link belong to?
  - setEntityTag
```
public void setEntityTag(java.lang.String value)
```
    Set server-generated entity tag for this entity. If non-null, it is used for conflict detection during DataService.uploadMedia and DataService.uploadStream calls.
    
    Parameters:
    
    value - Server-generated entity tag for this entity.
  - setInlineData
```
public void setInlineData(byte[] value)
```
    Set inline binary content if known, otherwise null.
    
    Parameters:
    
    value - Inline binary content if known, otherwise null.
  - setInlineText
```
public void setInlineText(java.lang.String value)
```
    Set inline string content if known, otherwise null.
    
    Parameters:
    
    value - Inline string content if known, otherwise null.
  - setMediaType
```
public void setMediaType(java.lang.String value)
```
    Set media type if known, otherwise null.
    
    See Also:
    
    Internet media type.
    
    Parameters:
    
    value - Media type if known, otherwise `null`.
  - setOffline
```
public void setOffline(boolean value)
```
    Set if the stream content is available offline, then true, otherwise false.
    
    Parameters:
    
    value - If the stream content is available offline, then true, otherwise false.
  - setOwningType
```
public void setOwningType(StructureType value)
```
    Set which structure type does this stream link belong to?
    
    Parameters:
    
    value - Which structure type does this stream link belong to?
  - setReadLink
```
public void setReadLink(java.lang.String value)
```
    Set the read link for this value, preferably relative to the service root URL. If a stream does not have an explicit read link, then readers should use the StreamLink.valuePath, or if that is not set, then a canonical URL (refer to the OData specification).
    
    Parameters:
    
    value - The read link for this value, preferably relative to the service root URL.
  - setStreamProperty
```
public void setStreamProperty(StreamProperty value)
```
    Set which stream property does this stream link belong to?
    
    Parameters:
    
    value - Which stream property does this stream link belong to?
  - setValuePath
```
public void setValuePath(java.lang.String value)
```
    Set the canonical path of this value relative to the parent entity URL.
    
    Parameters:
    
    value - The canonical path of this value relative to the parent entity URL.
  - toString
```
public java.lang.String toString()
```
    Convert this data value to a string. If the StreamLink.dataType is defined by XML Schema Part 2: Datatypes, then the corresponding lexical format is used. JSON format is used for structured values (arrays and objects).
    
    Specified by:
    
    toString in class DataValue
    
    Returns:
    
    Lexical representation of this data value.

Class StreamLink

Field Summary

Fields inherited from class com.sap.cloud.server.odata.DataValue

Constructor Summary

Method Summary

Methods inherited from class com.sap.cloud.server.odata.DataValue

Methods inherited from class java.lang.Object

Constructor Detail

StreamLink

Method Detail

copyLink

equal

getDataType

getEditLink

getEntitySet

getEntityTag

getInlineData

getInlineText

getMediaType

getOwningType

getReadLink

getStreamProperty

getTypeCode

getValuePath

isDeleted

isOffline

setDeleted

setEditLink

setEntitySet

setEntityTag

setInlineData

setInlineText

setMediaType

setOffline

setOwningType

setReadLink

setStreamProperty

setValuePath

toString