Interface CdnSecurityPolicyOrBuilder (0.54.0)

0.54.0 (latest) 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface CdnSecurityPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getKeyset()

public abstract String getKeyset()

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

optional string keyset = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The keyset.

getKeysetBytes()

public abstract ByteString getKeysetBytes()

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

optional string keyset = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for keyset.

getMediaPlaylistOriginForwardingType()

public abstract CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding getMediaPlaylistOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding media_playlist_origin_forwarding_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding	The mediaPlaylistOriginForwardingType.

getMediaPlaylistOriginForwardingTypeValue()

public abstract int getMediaPlaylistOriginForwardingTypeValue()

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding media_playlist_origin_forwarding_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for mediaPlaylistOriginForwardingType.

getMediaPlaylistOriginPathPrefix()

public abstract String getMediaPlaylistOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string media_playlist_origin_path_prefix = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The mediaPlaylistOriginPathPrefix.

getMediaPlaylistOriginPathPrefixBytes()

public abstract ByteString getMediaPlaylistOriginPathPrefixBytes()

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string media_playlist_origin_path_prefix = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for mediaPlaylistOriginPathPrefix.

getOriginForwardingType()

public abstract CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding getOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding origin_forwarding_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding	The originForwardingType.

getOriginForwardingTypeValue()

public abstract int getOriginForwardingTypeValue()

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding origin_forwarding_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for originForwardingType.

getOriginPathPrefix()

public abstract String getOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string origin_path_prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The originPathPrefix.

getOriginPathPrefixBytes()

public abstract ByteString getOriginPathPrefixBytes()

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string origin_path_prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for originPathPrefix.

getSecurityPolicyType()

public abstract CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType getSecurityPolicyType()

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

optional .google.ads.admanager.v1.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType security_policy_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType	The securityPolicyType.

getSecurityPolicyTypeValue()

public abstract int getSecurityPolicyTypeValue()

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

optional .google.ads.admanager.v1.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType security_policy_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for securityPolicyType.

getServerSideUrlSigningDisabled()

public abstract boolean getServerSideUrlSigningDisabled()

Optional. Whether the segment URLs should be signed using the

tokenAuthenticationKey on the server. This is only applicable for delivery

media locations that have token authentication enabled.

optional bool server_side_url_signing_disabled = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The serverSideUrlSigningDisabled.

getSignedRequestExpirationTtl()

public abstract Duration getSignedRequestExpirationTtl()

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The signedRequestExpirationTtl.

getSignedRequestExpirationTtlOrBuilder()

public abstract DurationOrBuilder getSignedRequestExpirationTtlOrBuilder()

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

getTokenAuthenticationKey()

public abstract String getTokenAuthenticationKey()

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

optional string token_authentication_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The tokenAuthenticationKey.

getTokenAuthenticationKeyBytes()

public abstract ByteString getTokenAuthenticationKeyBytes()

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

optional string token_authentication_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for tokenAuthenticationKey.

hasKeyset()

public abstract boolean hasKeyset()

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

optional string keyset = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the keyset field is set.

hasMediaPlaylistOriginForwardingType()

public abstract boolean hasMediaPlaylistOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding media_playlist_origin_forwarding_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the mediaPlaylistOriginForwardingType field is set.

hasMediaPlaylistOriginPathPrefix()

public abstract boolean hasMediaPlaylistOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string media_playlist_origin_path_prefix = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the mediaPlaylistOriginPathPrefix field is set.

hasOriginForwardingType()

public abstract boolean hasOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding origin_forwarding_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the originForwardingType field is set.

hasOriginPathPrefix()

public abstract boolean hasOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string origin_path_prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the originPathPrefix field is set.

hasSecurityPolicyType()

public abstract boolean hasSecurityPolicyType()

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

optional .google.ads.admanager.v1.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType security_policy_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the securityPolicyType field is set.

hasServerSideUrlSigningDisabled()

public abstract boolean hasServerSideUrlSigningDisabled()

Optional. Whether the segment URLs should be signed using the

tokenAuthenticationKey on the server. This is only applicable for delivery

media locations that have token authentication enabled.

optional bool server_side_url_signing_disabled = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the serverSideUrlSigningDisabled field is set.

hasSignedRequestExpirationTtl()

public abstract boolean hasSignedRequestExpirationTtl()

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the signedRequestExpirationTtl field is set.

hasTokenAuthenticationKey()

public abstract boolean hasTokenAuthenticationKey()

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

optional string token_authentication_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the tokenAuthenticationKey field is set.